PostCSS Color Function lets you use the color function in
CSS, following the CSS Color specification.
```pcss .color { color: color(display-p3 0.64331 0.19245 0.16771); }
:root { --a-color: color(srgb 0.64331 0.19245 0.16771); }
/ becomes /
.color { color: rgb(179,35,35); }
:root { --a-color: rgb(164,49,43); } ```
Add PostCSS Color Function to your project:
bash
npm install postcss @csstools/postcss-color-function --save-dev
Use it as a PostCSS plugin:
```js const postcss = require('postcss'); const postcssColorFunction = require('@csstools/postcss-color-function');
postcss([ postcssColorFunction(/ pluginOptions /) ]).process(YOUR_CSS /, processOptions /); ```
PostCSS Color Function runs in all Node environments, with special instructions for:
| Node | PostCSS CLI | Webpack | Create React App | Gulp | Grunt | | --- | --- | --- | --- | --- | --- |
The preserve option determines whether the original notation
is preserved. By default, it is not preserved.
js
postcssColorFunction({ preserve: true })
```pcss .color { color: color(display-p3 0.64331 0.19245 0.16771); }
:root { --a-color: color(srgb 0.64331 0.19245 0.16771); }
/ becomes /
.color { color: rgb(179,35,35); color: color(display-p3 0.64331 0.19245 0.16771); }
:root { --a-color: rgb(164,49,43); }
@supports (color: color(srgb 0 0 0)) { :root { --a-color: color(srgb 0.64331 0.19245 0.16771); } } ```
The enableProgressiveCustomProperties option determines whether the original notation
is wrapped with @supports when used in Custom Properties. By default, it is enabled.
⚠️ We only recommend disabling this when you set preserve to false or if you bring your own fix for Custom Properties. See what the plugin does in its README.
js
postcssColorFunction({ enableProgressiveCustomProperties: false })
```pcss .color { color: color(display-p3 0.64331 0.19245 0.16771); }
:root { --a-color: color(srgb 0.64331 0.19245 0.16771); }
/ becomes /
.color { color: rgb(179,35,35); color: color(display-p3 0.64331 0.19245 0.16771); }
:root { --a-color: rgb(164,49,43); --a-color: color(srgb 0.64331 0.19245 0.16771); } ```
Custom properties do not fallback to the previous declaration
css
.color-spaces {
color: color(a98-rgb 0.803 0.484 0.944);
color: color(display-p3 0.8434 0.509 0.934);
color: color(prophoto-rgb 0.759 0.493 0.898);
color: color(rec2020 0.772 0.491 0.920);
color: color(srgb 0.897 0.488 0.959);
color: color(srgb-linear 0.783 0.203 0.910);
color: color(xyz 0.560 0.377 0.904);
color: color(xyz-d50 0.550 0.375 0.680);
color: color(xyz-d65 0.560 0.377 0.904);
}
Depending on the browser implementation out of gamut colors may be clipped, resulting in a different color.
Fallback values generated by PostCSS Color Function are always mapped to a close alternative in sRGB.
When setting preserve to true the original values will be used by some browsers and these may be clipped.
Certain browsers will have an incorrect color if this occurs.
If the plugin detects out of gamut colors it will emit a warning :
"color(srgb-linear -0.01656 0.23079 0.25298)" is out of gamut for "srgb-linear". When "preserve: true" is set this will lead to unexpected results in some browsers.
To resolve this warning pick a larger color space when declaring the original value.
This software or document includes material copied from or derived from https://github.com/w3c/csswg-drafts/tree/main/css-color-4. Copyright © 2022 W3C® (MIT, ERCIM, Keio, Beihang).