PostCSS color-mod() Function
Last updated
Last updated
PostCSS color-mod() Function lets you modify colors using the color-mod()
function in CSS, following the CSS Color Module Level 4 specification.
color-mod()
has been removed from the Color Module Level 4 specification.
The color-mod()
function accepts rgb()
, legacy comma-separated rgb()
, rgba()
, hsl()
, legacy comma-separated hsl()
, hsla()
, hwb()
, and color-mod()
colors, as well as 3, 4, 6, and 8 digit hex colors, and named colors without the need for additional plugins.
Implemention details are available in the specification.
The color-mod()
function accepts red()
, green()
, blue()
, a()
/ alpha()
, rgb()
, h()
/ hue()
, s()
/ saturation()
, l()
/ lightness()
, w()
/ whiteness()
, b()
/ blackness()
, tint()
, shade()
, blend()
, blenda()
, and contrast()
color adjusters.
Implemention details are available in the specification.
By default, var()
variables will be used if their corresponding Custom Properties are found in a :root
rule, or if a fallback value is specified.
Add PostCSS color-mod() Function to your project:
Use PostCSS color-mod() Function to process your CSS:
Or use it as a PostCSS plugin:
PostCSS color-mod() Function runs in all Node environments, with special instructions for:
The stringifier
option defines how transformed colors will be produced in CSS. By default, legacy rbg()
and rgba()
colors are produced, but this can be easily updated to support [CSS Color Module Level 4 colors] colors.
Future major releases of PostCSS color-mod() Function may reverse this functionality so that CSS Color Module Level 4 colors are produced by default.
The unresolved
option defines how unresolved functions and arguments should be handled. The available options are throw
, warn
, and ignore
. The default option is to throw
.
If ignore
is used, the color-mod()
function will remain unchanged.
The transformVars
option defines whether var()
variables used within color-mod()
should be transformed into their corresponding Custom Properties available in :root
, or their fallback value if it is specified. By default, var()
variables will be transformed.
However, because these transformations occur at build time, they cannot be considered accurate. Accurately resolving cascading variables relies on knowledge of the living DOM tree.
The importFrom
option allows you to import variables from other sources, which might be CSS, JS, and JSON files, and directly passed objects.
Multiple files can be passed into this option, and they will be parsed in the order they were received. JavaScript files, JSON files, and objects will need to namespace custom properties under a customProperties
or custom-properties
key.
Variables may reference other variables, and this plugin will attempt to resolve them. If transformVars
is set to false
then importFrom
will not be used.