postcss-split-colors v0.3.0

postcss-split-colors

PostCSS plugin to destructure colors in custom properties.

Use !split in the custom property color declaration you want to split.

:root {
  --primary: rgb(14, 14, 14) !split;
  --accent: hsl(0 80% 50% / 25%) !split;
}

:root {
  --primary-rgb: 14 14 14;
  --primary: rgb(var(--primary-rgb));
  --accent-rgb: 230 26 26;
  --accent-hsl: 0deg 80% 50%;
  --accent: hsl(var(--accent-hsl / 25%));
}

Currently the color functions rgb(), hsl(), lch(), lab(), hwb() and hex color (with 3, 4, 6 or 8 digits) are supported via colord. Alpha values are preserved by default (see options). Note that currently all values are converted to RGB internally, meaning there will be rounding errors in conversions involving non-sRGB color functions. This will be fixed in a future release.

Usage

Step 1: Install plugin:

npm install --save-dev postcss postcss-split-colors

Step 2: Check your project for an existing PostCSS config: postcss.config.js in the project root.

If you do not use PostCSS, add it according to official docs and set this plugin in settings.

Step 3: Add the plugin to plugins list:

+ const splitColors = require("postcss-split-colors");

  module.exports = {
    plugins: [
+     splitColors(/* pluginOptions */),
      require("autoprefixer")
    ]
  }

Options

prompt

Modify the prompt text from "split" to any string. The preceeding ! is added by the plugin:

// postcss.config.js
const splitColors = require("postcss-split-colors");

module.exports = {
  plugins: [splitColors({ prompt: "foobar" })]
};

/* your-file.css */
.selector {
  --color: #ff8800 !foobar;
}

convert

Add additional color format conversions to every transformation:

// postcss.config.js
const splitColors = require("postcss-split-colors");

module.exports = {
  plugins: [splitColors({ convert: { rgb: true } })]
};

Available keys: rgb, hsl, lab, lch, hwb. Hex colors are treated as RGB.

preserve

Preserves the initial declaration, only removing the prompt. This is currently recommended if you find that you are getting rounding errors.

// postcss.config.js
const splitColors = require("postcss-split-colors");

module.exports = {
  plugins: [splitColors({ preserve: true })]
};

preserveAlpha

Preserves the alpha value of the initial declaration, injecting only the split-off color property. This is enabled by default, and can be disabled with false (which omits the value in the transformed declaration):

// postcss.config.js
const splitColors = require("postcss-split-colors");

module.exports = {
  plugins: [splitColors({ preserveAlpha: false })]
};