WIP - add extractor, generate snippet_data
This commit is contained in:
62
node_modules/srcset/readme.md
generated
vendored
Normal file
62
node_modules/srcset/readme.md
generated
vendored
Normal file
@ -0,0 +1,62 @@
|
||||
# srcset [](https://travis-ci.org/sindresorhus/srcset)
|
||||
|
||||
> Parse and stringify the HTML `<img>` [srcset](http://mobile.smashingmagazine.com/2013/08/21/webkit-implements-srcset-and-why-its-a-good-thing/) attribute.
|
||||
|
||||
Useful if you're creating a polyfill, build-tool, etc.
|
||||
|
||||
|
||||
## Install
|
||||
|
||||
```
|
||||
$ npm install --save srcset
|
||||
```
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
How an image with `srcset` might look like:
|
||||
|
||||
```html
|
||||
<img alt="The Breakfast Combo"
|
||||
src="banner.jpg"
|
||||
srcset="banner-HD.jpg 2x, banner-phone.jpg 100w, banner-phone-HD.jpg 100w 2x">
|
||||
```
|
||||
|
||||
Then have some fun with it:
|
||||
|
||||
```js
|
||||
var srcset = require('srcset');
|
||||
|
||||
var parsed = srcset.parse('banner-HD.jpg 2x, banner-phone.jpg 100w');
|
||||
console.log(parsed);
|
||||
/*
|
||||
[
|
||||
{ url: 'banner-HD.jpg', density: 2 },
|
||||
{ url: 'banner-phone.jpg', width: 100 }
|
||||
]
|
||||
*/
|
||||
|
||||
parsed.push({ url: 'banner-phone-HD.jpg', width: 100, density: 2 });
|
||||
|
||||
var stringified = srcset.stringify(parsed);
|
||||
console.log(stringified);
|
||||
/*
|
||||
banner-HD.jpg 2x, banner-phone.jpg 100w, banner-phone-HD.jpg 100w 2x
|
||||
*/
|
||||
```
|
||||
|
||||
|
||||
## API
|
||||
|
||||
### .parse()
|
||||
|
||||
Accepts a srcset string and returns an array of objects with the possible properties: `url` (always), `width`, `height`, `density`.
|
||||
|
||||
### .stringify()
|
||||
|
||||
Accepts an array of objects with the possible properties: `url` (required), `width`, `height`, `density` and returns a srcset string.
|
||||
|
||||
|
||||
## License
|
||||
|
||||
MIT © [Sindre Sorhus](http://sindresorhus.com)
|
||||
Reference in New Issue
Block a user