@samatech/postcss-colors
v0.5.4
Published
PostCSS plugin that provides various color related transforms
Downloads
6,331
Maintainers
Readme
PostCSS Colors
PostCSS plugin that provides various color related transforms.
Features
- Converts 4 and 8 character hex colors to rgba according to the CSS Color Module Spec
- With 4 characters, the first three expand as a 3 character hex color would. The 4th expands similarly, and is used to calculate alpha with
0
as the lowest andf
as the highest. - 8 character colors use the first six for the color, and the last two for alpha. For example, if the last two characeters are
cc
the alpha value is204 / 255 = 0.8
.
- With 4 characters, the first three expand as a 3 character hex color would. The 4th expands similarly, and is used to calculate alpha with
color: #00ff00cc;
color: #0f0c;
/* Converts to */
color: rgba(0, 255, 0, 0.8);
color: rgba(0, 255, 0, 0.8);
- Converts 3 and 6 character hex colors within
rgb
andrgba
functions to valid syntax
color: rgba(#0f0, 0.8);
color: rgba(#00ff00, 0.8);
/* Converts to */
color: rgba(0, 255, 0, 0.8);
color: rgba(0, 255, 0, 0.8);
Usage
Step 1: Install plugin:
npm install --save-dev @samatech/postcss-colors
Step 2: Check your project for existing PostCSS config: postcss.config.js
in the project root, "postcss"
section in package.json
or postcss
in bundle config.
If you do not use PostCSS, first add it according to PostCSS docs.
Step 3: Add the plugin to plugins list:
import postcssColors from '@samatech/postcss-colors'
export default {
plugins: postcssColors({
// Options
}),
};
Options
TODO
Inspiration
This original purpose behind this plugin was to update postcss-hexrgba
to support PostCSS 8. postcss-hexrgba
has since been updated.
The abstractions for converting hex to rgba are similar to those in postcss-color-hex-alpha
, so that functionality is included in this library as well.
Adding a custom alpha syntax for hex colors may be considered, similar to postcss-color-alpha