Giter Club home page Giter Club logo

postcss-image-set-function's Introduction

⚠️ PostCSS image-set() Function was moved to @csstools/postcss-plugins. ⚠️
Read the announcement

PostCSS image-set() Function PostCSS Logo

NPM Version CSS Standard Status Build Status Support Chat

PostCSS image-set() Function lets you display resolution-dependent images using the image-set() function in CSS, following the CSS Images specification.

'Can I use' table

.example {
  background-image: image-set(
    url(img.png) 1x,
    url([email protected]) 2x,
    url([email protected]) 600dpi
  );
}

/* becomes */

.example {
  background-image: url(img.png);
}

@media (-webkit-min-device-pixel-ratio: 2), (min-resolution: 192dpi) {
  .example {
    background-image: url([email protected]);
  }
}


@media (-webkit-min-device-pixel-ratio: 6.25), (min-resolution: 600dpi) {
  .example {
    background-image: url([email protected]);
  }
}

.example {
  background-image: image-set(
    url(img.png) 1x,
    url([email protected]) 2x,
    url([email protected]) 600dpi
  );
}

Usage

Add PostCSS image-set() Function to your project:

npm install postcss-image-set-function --save-dev

Use PostCSS image-set() Function to process your CSS:

const postcssImageSetFunction = require('postcss-image-set-function');

postcssImageSetFunction.process(YOUR_CSS /*, processOptions, pluginOptions */);

Or use it as a PostCSS plugin:

const postcss = require('postcss');
const postcssImageSetFunction = require('postcss-image-set-function');

postcss([
  postcssImageSetFunction(/* pluginOptions */)
]).process(YOUR_CSS /*, processOptions */);

PostCSS image-set() Function runs in all Node environments, with special instructions for:

Node PostCSS CLI Webpack Create React App Gulp Grunt

Options

preserve

The preserve option determines whether the original declaration using image-set() is preserved. By default, it is preserved.

postcssImageSetFunction({ preserve: false })
.example {
  background-image: image-set(
    url(img.png) 1x,
    url([email protected]) 2x,
    url([email protected]) 600dpi
  );
}

/* becomes */

.example {
  background-image: url(img.png);
}

@media (-webkit-min-device-pixel-ratio: 2), (min-resolution: 192dpi) {
  .example {
    background-image: url([email protected]);
  }
}


@media (-webkit-min-device-pixel-ratio: 6.25), (min-resolution: 600dpi) {
  .example {
    background-image: url([email protected]);
  }
}

onvalid

The oninvalid option determines how invalid usage of image-set() should be handled. By default, invalid usages of image-set() are ignored. They can be configured to display a warning or throw an error.

postcssImageSetFunction({ oninvalid: 'warning' }) // warn on invalid usages
postcssImageSetFunction({ oninvalid: 'throw' }) // throw on invalid usages

Image Resolution

The image-set() function allows an author to provide multiple resolutions of an image and let the browser decide which is most appropriate in a given situation. The image-set() also never fails to choose an image; the <resolution> just helps determine which of the images is chosen.

Since this plugin is not a browser, the image options are sorted by device pixel ratio and the lowest ratio is used as the default, while the remaining images are pushed behind media queries.

Therefore, this plugin can only approximate native browser behavior. While images should typically match the resolution as the device they’re being viewed in, other factors can affect the chosen image. For example, if the user is on a slow mobile connection, the browser may prefer to select a lower-res image rather than wait for a larger, resolution-matching image to load.

postcss-image-set-function's People

Contributors

antonio-laguna avatar armano2 avatar dargmuesli avatar evilebottnawi avatar jonathantneal avatar romainmenke avatar semigradsky avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

postcss-image-set-function's Issues

image-set syntax and fallback with url()

Hi!
I'm new in the PostCSS community and i started to use postcss-preset-env today.
I faced quickly to an issue about image-set() by looking the postcss-preset-env Playground.

If you set >1% for the browserlist compatibily instead of > 3%, you will see that the fallback for background-image does not to correspond the spec. The url should be noted inside url("") like background-image: url("img/background.jpg");.

An other issue is that inside the image-set property, url should not be noted inside url("") as the spec describe it.

Thanks for the efforts you've made!

support for multiple background images

hey! having an issue with this where a gradient on top of a background image doesn't survive the transformation.

simplified test case:

/* input */
.example {
  background-image: linear-gradient(#4444, #8888),
    image-set(url(img.png) 1x, url([email protected]) 2x);
}

/* expected output */
.example {
  background-image: linear-gradient(#4444, #8888), url(img.png);
}

@media (-webkit-min-device-pixel-ratio: 2), (min-resolution: 192dpi) {
  .example {
    background-image: linear-gradient(#4444, #8888), url([email protected]);
  }
}

/* actual output */
.example {
  background-image: url(img.png);
}

@media (-webkit-min-device-pixel-ratio: 2), (min-resolution: 192dpi) {
  .example {
    background-image: url([email protected]);
  }
}

i'll be able to have a crack at fixing it in maybe a week or two when i have some free time.

Image-Set should always provide an image that displays

I asked how image-set() resolves the different resolutions, and uncovered this bug:

image-set() never fails to choose an image; the <resolution> just helps determine which of the images is chosen.
w3c/csswg-drafts#2653

That’s not how this plugin currently works. I think the solution is to sort the fallbacks by DPR, and then always make the lowest one media query-less.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.