Gathering detailed insights and metrics for @endiliey/responsive-loader
Gathering detailed insights and metrics for @endiliey/responsive-loader
Installations
npm install @endiliey/responsive-loaderDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Min. Node Version
>=8
Node Version
8.11.3
NPM Version
6.9.0
Releases
Unable to fetch releases
Languages
2
JavaScript
Shell
JavaScript (95.13%)
Shell (4.87%)
Developer
endiliey
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
BSD-3-Clause License
2 Stars
117 Commits
1 Forks
1 Branches
1 Contributors
Updated on Apr 06, 2023
Maintainers
1
Package Meta Information
Latest Version
1.3.2
Package Id
@endiliey/responsive-loader@1.3.2
Size
8.05 kB
NPM Version
6.9.0
Node Version
8.11.3
Published on
Nov 18, 2019
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
responsive-loader
A webpack loader for responsive images. Creates multiple images from one source image, and returns a srcset. For more information on how to use srcset, read Responsive Images: If you’re just changing resolutions, use srcset.. Browser support is pretty good.
Install
Note: starting with v1.0.0, responsive-loader is only compatible with webpack 2+. For webpack 1 support, use responsive-loader@0.7.0
With jimp
npm install responsive-loader jimp --save-dev
Per default, responsive-loader uses jimp to transform images. which needs to be installed alongside responsive-loader. Because jimp is written entirely in JavaScript and doesn't have any native dependencies it will work anywhere. The main drawback is that it's pretty slow.
With sharp
npm install responsive-loader sharp --save-dev
For super-charged performance, responsive-loader also works with sharp. It's recommended to use sharp if you have lots of images to transform.
If you want to use sharp, you need to configure responsive-loader to use its adapter:
1module.exports = { 2 // ... 3 module: { 4 rules: [ 5 { 6 test: /\.(jpe?g|png)$/i, 7 loader: 'responsive-loader', 8 options: { 9+ adapter: require('responsive-loader/sharp') 10 } 11 } 12 ] 13 }, 14}
Usage
Add a rule for loading responsive images to your webpack config:
1module.exports = { 2 // ... 3 module: { 4 rules: [ 5 { 6 test: /\.(jpe?g|png)$/i, 7 loader: 'responsive-loader', 8 options: { 9 // If you want to enable sharp support: 10 // adapter: require('responsive-loader/sharp') 11 } 12 } 13 ] 14 }, 15}
Then import images in your JavaScript files:
1// Outputs three images with 100, 200, and 300px widths 2const responsiveImage = require('myImage.jpg?sizes[]=100,sizes[]=200,sizes[]=300'); 3 4// responsiveImage.srcSet => '2fefae46cb857bc750fa5e5eed4a0cde-100.jpg 100w,2fefae46cb857bc750fa5e5eed4a0cde-200.jpg 200w,2fefae46cb857bc750fa5e5eed4a0cde-300.jpg 300w' 5// responsiveImage.images => [{height: 50, path: '2fefae46cb857bc750fa5e5eed4a0cde-100.jpg', width: 100}, {height: 100, path: '2fefae46cb857bc750fa5e5eed4a0cde-200.jpg', width: 200}, {height: 150, path: '2fefae46cb857bc750fa5e5eed4a0cde-300.jpg', width: 300}] 6// responsiveImage.src => '2fefae46cb857bc750fa5e5eed4a0cde-100.jpg' 7// responsiveImage.toString() => '2fefae46cb857bc750fa5e5eed4a0cde-100.jpg' 8ReactDOM.render(<img srcSet={responsiveImage.srcSet} src={responsiveImage.src} />, el); 9 10// Or you can just use it as props, `srcSet` and `src` will be set properly 11ReactDOM.render(<img {...responsiveImage} />, el);
Or use it in CSS (only the first resized image will be used, if you use multiple sizes):
1.myImage { background: url('myImage.jpg?size=1140'); } 2 3@media (max-width: 480px) { 4 .myImage { background: url('myImage.jpg?size=480'); } 5}
1// Outputs placeholder image as a data URI, and three images with 100, 200, and 300px widths 2const responsiveImage = require('myImage.jpg?placeholder=true&sizes[]=100,sizes[]=200,sizes[]=300'); 3 4// responsiveImage.placeholder => 'data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAIBAQE…' 5ReactDOM.render( 6 <div style={{ 7 height: responsiveImage.height, 8 width: responsiveImage.width, 9 backgroundSize: 'cover', 10 backgroundImage: 'url("' + responsiveImage.placeholder + '")' 11 }}> 12 <img src={responsiveImage.src} srcSet={responsiveImage.srcSet} /> 13 </div>, el);
Options
| Option | Type | Default | Description |
|---|---|---|---|
name | string | [hash]-[width].[ext] | Filename template for output files. |
outputPath | `string | Function` | undefined |
publicPath | `string | Function` | undefined |
context | string | this.options.context | Custom file context, defaults to webpack.config.js context |
sizes | array | original size | Specify all widths you want to use; if a specified size exceeds the original image's width, the latter will be used (i.e. images won't be scaled up). You may also declare a default sizes array in the loader options in your webpack.config.js. |
size | integer | original size | Specify one width you want to use; if the specified size exceeds the original image's width, the latter will be used (i.e. images won't be scaled up) |
min | integer | As an alternative to manually specifying sizes, you can specify min, max and steps, and the sizes will be generated for you. | |
max | integer | See min above | |
steps | integer | 4 | Configure the number of images generated between min and max (inclusive) |
quality | integer | 85 | JPEG compression quality |
format | string | original format | Either png or jpg; use to convert to another format |
placeholder | boolean | false | A true or false value to specify wether to output a placeholder image as a data URI |
placeholderSize | integer | 40 | A number value specifying the width of the placeholder image, if enabled with the option above |
adapter | Adapter | JIMP | Specify which adapter to use. Can only be specified in the loader options. |
disable | boolean | false | Disable processing of images by this loader (useful in development). srcSet and other attributes will still be generated but only for the original size. Note that the width and height attributes will both be set to 100 but the image will retain its original dimensions. |
emitFile | boolean | true | If true, emits a file (writes a file to the filesystem). If false, the loader will still return a object with the public URI but will not emit the file. It is often useful to disable this option for server-side packages. |
Adapter-specific options
jimp
background: number— Background fill when converting transparent to opaque images. Make sure this is a valid hex number, e.g.0xFFFFFFFF)
sharp
background: string— Background fill when converting transparent to opaque images. E.g.#FFFFFF
Examples
Set a default sizes array, so you don't have to declare them with each require.
1module.exports = { 2 entry: {...}, 3 output: {...}, 4 module: { 5 rules: [ 6 { 7 test: /\.(jpe?g|png)$/i, 8 loader: 'responsive-loader', 9 options: { 10 sizes: [300, 600, 1200, 2000], 11 placeholder: true, 12 placeholderSize: 50 13 } 14 } 15 ] 16 }, 17}
Writing Your Own Adapter
Maybe you want to use another image processing library or you want to change an existing one's behavior. You can write your own adapter with the following signature:
1type Adapter = (imagePath: string) => { 2 metadata: () => Promise<{width: number, height: number}> 3 resize: (config: {width: number, mime: string, options: Object}) => Promise<{data: Buffer, width: number, height: number}> 4}
The resize method takes a single argument which has a width, mime and options property (which receives all loader options)
In your webpack config, require your adapter
1{ 2 test: /\.(jpe?g|png)$/i, 3 loader: 'responsive-loader', 4 options: { 5 adapter: require('./my-adapter') 6 foo: 'bar' // will get passed to adapter.resize({width, mime, options: {foo: 'bar}}) 7 } 8}
Notes
- Doesn't support
1x,2xsizes.
See also
- Inspired by resize-image-loader, but simpler and without dependency on ImageMagick
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: BSD 3-Clause "New" or "Revised" License: LICENSE:0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
96 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-pp7h-53gx-mx7r
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
- Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
- Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2
- Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
- Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
- Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
- Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
- Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
- Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
- Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh
- Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
- Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
- Warn: Project is vulnerable to: MAL-2023-462
- Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
- Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
- Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
- Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
- Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
- Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
- Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
- Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
- Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-4hpf-3wq7-5rpr
- Warn: Project is vulnerable to: GHSA-f522-ffg8-j8r6
- Warn: Project is vulnerable to: GHSA-w7q9-p3jq-fmhm
- Warn: Project is vulnerable to: GHSA-xvf7-4v9q-58w6
- Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
- Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-282f-qqgm-c34q
- Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
- Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
- Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
- Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm
- Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
- Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
- Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-wrvr-8mpx-r7pp
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6
- Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59
- Warn: Project is vulnerable to: GHSA-x565-32qp-m3vf
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
- Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
- Warn: Project is vulnerable to: GHSA-gp95-ppv5-3jc5
- Warn: Project is vulnerable to: GHSA-54xq-cgqr-rpm3
- Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
- Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
- Warn: Project is vulnerable to: GHSA-wpg7-2c88-r8xv
- Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3
- Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
- Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-pq67-2wwv-3xjx
- Warn: Project is vulnerable to: GHSA-8cj5-5rvv-wf4v
- Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
- Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-w5p7-h5w8-2hfq
- Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-776f-qx25-q3cc
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Score
1.7
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More