You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
97 lines
3.3 KiB
97 lines
3.3 KiB
2 years ago
|
# PostCSS Color Functional Notation [<img src="https://postcss.github.io/postcss/logo.svg" alt="PostCSS Logo" width="90" height="90" align="right">][postcss]
|
||
|
|
|
||
|
|
[<img alt="NPM Version" src="https://img.shields.io/npm/v/postcss-color-functional-notation.svg" height="20">][npm-url]
|
||
|
|
[<img alt="CSS Standard Status" src="https://cssdb.org/images/badges/lab-function.svg" height="20">][css-url]
|
||
|
|
[<img alt="Build Status" src="https://github.com/csstools/postcss-plugins/workflows/test/badge.svg" height="20">][cli-url]
|
||
|
|
[<img alt="Discord" src="https://shields.io/badge/Discord-5865F2?logo=discord&logoColor=white">][discord]
|
||
|
|
|
||
|
|
[PostCSS Color Functional Notation] lets you use space and slash separated
|
||
|
|
color notation in CSS, following the [CSS Color] specification.
|
||
|
|
|
||
|
|
```pcss
|
||
|
|
:root {
|
||
|
|
--firebrick: rgb(178 34 34);
|
||
|
|
--firebrick-a50: rgb(70% 13.5% 13.5% / 50%);
|
||
|
|
--firebrick-hsl: hsla(0 68% 42%);
|
||
|
|
--firebrick-hsl-a50: hsl(0 68% 42% / 50%);
|
||
|
|
}
|
||
|
|
|
||
|
|
/* becomes */
|
||
|
|
|
||
|
|
:root {
|
||
|
|
--firebrick: rgb(178, 34, 34);
|
||
|
|
--firebrick-a50: rgba(178, 34, 34, .5);
|
||
|
|
--firebrick-hsl: hsl(0, 68%, 42%);
|
||
|
|
--firebrick-hsl-a50: hsla(0, 68%, 42%, .5);
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Add [PostCSS Color Functional Notation] to your project:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm install postcss-color-functional-notation --save-dev
|
||
|
|
```
|
||
|
|
|
||
|
|
Use [PostCSS Color Functional Notation] to process your CSS:
|
||
|
|
|
||
|
|
```js
|
||
|
|
const postcss = require('postcss');
|
||
|
|
const postcssColorFunctionalNotation = require('postcss-color-functional-notation');
|
||
|
|
|
||
|
|
postcss([
|
||
|
|
postcssColorFunctionalNotation(/* pluginOptions */)
|
||
|
|
]).process(YOUR_CSS /*, processOptions */);
|
||
|
|
```
|
||
|
|
|
||
|
|
[PostCSS Color Functional Notation] runs in all Node environments, with special instructions for:
|
||
|
|
|
||
|
|
| [Node](INSTALL.md#node) | [PostCSS CLI](INSTALL.md#postcss-cli) | [Webpack](INSTALL.md#webpack) | [Create React App](INSTALL.md#create-react-app) | [Gulp](INSTALL.md#gulp) | [Grunt](INSTALL.md#grunt) |
|
||
|
|
| --- | --- | --- | --- | --- | --- |
|
||
|
|
|
||
|
|
## Options
|
||
|
|
|
||
|
|
### preserve
|
||
|
|
|
||
|
|
The `preserve` option determines whether the original functional color notation
|
||
|
|
is preserved. By default, it is not preserved.
|
||
|
|
|
||
|
|
```js
|
||
|
|
postcssImageSetFunction({ preserve: true })
|
||
|
|
```
|
||
|
|
|
||
|
|
```pcss
|
||
|
|
:root {
|
||
|
|
--firebrick: rgb(178 34 34);
|
||
|
|
--firebrick-a50: rgb(70% 13.5% 13.5% / 50%);
|
||
|
|
--firebrick-hsl: hsla(0 68% 42%);
|
||
|
|
--firebrick-hsl-a50: hsl(0 68% 42% / 50%);
|
||
|
|
}
|
||
|
|
|
||
|
|
/* becomes */
|
||
|
|
|
||
|
|
:root {
|
||
|
|
--firebrick: rgb(178, 34, 34);
|
||
|
|
--firebrick: rgb(178 34 34);
|
||
|
|
--firebrick-a50: rgba(178, 34, 34, .5);
|
||
|
|
--firebrick-a50: rgb(70% 13.5% 13.5% / 50%);
|
||
|
|
--firebrick-hsl: hsl(0, 68%, 42%);
|
||
|
|
--firebrick-hsl: hsla(0 68% 42%);
|
||
|
|
--firebrick-hsl-a50: hsla(0, 68%, 42%, .5);
|
||
|
|
--firebrick-hsl-a50: hsl(0 68% 42% / 50%);
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
[cli-url]: https://github.com/csstools/postcss-plugins/actions/workflows/test.yml?query=workflow/test
|
||
|
|
[css-url]: https://cssdb.org/#color-functional-notation
|
||
|
|
[discord]: https://discord.gg/bUadyRwkJS
|
||
|
|
[npm-url]: https://www.npmjs.com/package/postcss-color-functional-notation
|
||
|
|
|
||
|
|
[CSS Color]: https://drafts.csswg.org/css-color/#ref-for-funcdef-rgb%E2%91%A1%E2%91%A0
|
||
|
|
[Gulp PostCSS]: https://github.com/postcss/gulp-postcss
|
||
|
|
[Grunt PostCSS]: https://github.com/nDmitry/grunt-postcss
|
||
|
|
[PostCSS]: https://github.com/postcss/postcss
|
||
|
|
[PostCSS Loader]: https://github.com/postcss/postcss-loader
|
||
|
|
[PostCSS Color Functional Notation]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-color-functional-notation
|