diff options
Diffstat (limited to 'node_modules/postcss-double-position-gradients/README.md')
| -rw-r--r-- | node_modules/postcss-double-position-gradients/README.md | 125 |
1 files changed, 125 insertions, 0 deletions
diff --git a/node_modules/postcss-double-position-gradients/README.md b/node_modules/postcss-double-position-gradients/README.md new file mode 100644 index 00000000..6604ff5d --- /dev/null +++ b/node_modules/postcss-double-position-gradients/README.md @@ -0,0 +1,125 @@ +# PostCSS Double Position Gradients [<img src="https://postcss.github.io/postcss/logo.svg" alt="PostCSS" width="90" height="90" align="right">][postcss] + +[<img alt="NPM Version" src="https://img.shields.io/npm/v/postcss-double-position-gradients.svg" height="20">][npm-url] +[<img alt="CSS Standard Status" src="https://cssdb.org/images/badges/double-position-gradients.svg" height="20">][css-url] +[<img alt="Discord" src="https://shields.io/badge/Discord-5865F2?logo=discord&logoColor=white">][discord] + +[PostCSS Double Position Gradients] lets you use double-position gradients in +CSS, following the [CSS Image Values and Replaced Content] specification. + +```pcss +.linear-gradient { + background-image: linear-gradient(90deg, black 25% 50%, blue 50% 75%); +} + +.conic-gradient { + background-image: conic-gradient(yellowgreen 40%, gold 0deg 75%, #f06 0deg); +} + +/* becomes */ + +.linear-gradient { + background-image: linear-gradient(90deg, black 25%, black 50%, blue 50%, blue 75%); + background-image: linear-gradient(90deg, black 25% 50%, blue 50% 75%); +} + +.conic-gradient { + background-image: conic-gradient(yellowgreen 40%, gold 0deg, gold 75%, #f06 0deg); + background-image: conic-gradient(yellowgreen 40%, gold 0deg 75%, #f06 0deg); +} +``` + +## Usage + +Add [PostCSS Double Position Gradients] to your project: + +```bash +npm install postcss-double-position-gradients --save-dev +``` + +Use [PostCSS Double Position Gradients] to process your CSS: + +```js +const postcssDoublePositionGradients = require('postcss-double-position-gradients'); + +postcssDoublePositionGradients.process(YOUR_CSS /*, processOptions, pluginOptions */); +``` + +Or use it as a [PostCSS] plugin: + +```js +const postcss = require('postcss'); +const postcssDoublePositionGradients = require('postcss-double-position-gradients'); + +postcss([ + postcssDoublePositionGradients(/* pluginOptions */) +]).process(YOUR_CSS /*, processOptions */); +``` + +[PostCSS Double Position Gradients] runs in all Node environments, with special instructions for: + +| [Node](INSTALL.md#node) | [PostCSS CLI](INSTALL.md#postcss-cli) | [Webpack](INSTALL.md#webpack) | [Gulp](INSTALL.md#gulp) | [Grunt](INSTALL.md#grunt) | +| --- | --- | --- | --- | --- | + +## Options + +### preserve + +The `preserve` option determines whether the original double-position gradients +should be preserved. By default, double-position gradients are preserved. + +```js +postcssDoublePositionGradients({ preserve: false }) +``` + +```css +.linear-gradient { + background-image: linear-gradient(90deg, black 25% 50%, blue 50% 75%); +} + +.conic-gradient { + background-image: conic-gradient(yellowgreen 40%, gold 0deg 75%, #f06 0deg); +} + +/* becomes */ + +.linear-gradient { + background-image: linear-gradient(90deg, black 25%, black 50%, blue 50%, blue 75%); +} + +.conic-gradient { + background-image: conic-gradient(yellowgreen 40%, gold 0deg, gold 75%, #f06 0deg); +} +``` + +### enableProgressiveCustomProperties + +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](https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-progressive-custom-properties#readme). + +```js +postcssDoublePositionGradients({ enableProgressiveCustomProperties: false }) +``` + +```pcss +:root { + --a-gradient: linear-gradient(90deg, black 25% 50%, blue 50% 75%); +} + +/* becomes */ + +:root { + --a-gradient: linear-gradient(90deg, black 25%, black 50%, blue 50%, blue 75%); /* will never be used, not even in older browser */ + --a-gradient: linear-gradient(90deg, black 25% 50%, blue 50% 75%); +} +``` + +[css-url]: https://cssdb.org/#double-position-gradients +[discord]: https://discord.gg/bUadyRwkJS +[npm-url]: https://www.npmjs.com/package/postcss-double-position-gradients + +[CSS Image Values and Replaced Content]: https://www.w3.org/TR/css-images-4/#color-stop-syntax +[PostCSS]: https://github.com/postcss/postcss +[PostCSS Double Position Gradients]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-double-position-gradients |
