Introducing npm Teams! Private packages + team management tools.Learn more »

srcset

2.0.1 • Public • Published

srcset Build Status

Parse and stringify the HTML <img> srcset attribute.

Useful if you're creating a polyfill, build-tool, etc.

Install

$ npm install srcset

Usage

How an image with srcset might look like:

<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:

const srcset = require('srcset');
 
const 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
});
 
const 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.


Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.

Install

npm i srcset

DownloadsWeekly Downloads

562,476

Version

2.0.1

License

MIT

Unpacked Size

6.26 kB

Total Files

5

Last publish

Collaborators

  • avatar