From efbc2ffe6a1ee5ec38a4396305561d6515d0943e Mon Sep 17 00:00:00 2001 From: littleblack111 Date: Fri, 30 Aug 2024 17:21:18 +0800 Subject: node fixes, updates --- .../postcss-light-dark-function/README.md | 184 +++++++++++++++++++++ 1 file changed, 184 insertions(+) create mode 100644 node_modules/@csstools/postcss-light-dark-function/README.md (limited to 'node_modules/@csstools/postcss-light-dark-function/README.md') diff --git a/node_modules/@csstools/postcss-light-dark-function/README.md b/node_modules/@csstools/postcss-light-dark-function/README.md new file mode 100644 index 00000000..84beb299 --- /dev/null +++ b/node_modules/@csstools/postcss-light-dark-function/README.md @@ -0,0 +1,184 @@ +# PostCSS Light Dark Function [PostCSS Logo][PostCSS] + +[npm version][npm-url] [Build Status][cli-url] [Discord][discord]

[Baseline Status][css-url] [CSS Standard Status][css-url] + +```bash +npm install @csstools/postcss-light-dark-function --save-dev +``` + +[PostCSS Light Dark Function] lets you use the `light-dark` color function in +CSS, following the [CSS Color 5 Specification]. + +Read more about this feature on mdn: +- define the colors for light and dark with [`light-dark()`](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/light-dark) +- define which elements support light and/or dark with [`color-scheme`](https://developer.mozilla.org/en-US/docs/Web/CSS/color-scheme) + +With both features combined you can mix and match color schemes in a single document, while also respecting the user's preferences. + +```pcss +.foo { + color: light-dark(pink, magenta); +} + +.bar { + --bar: light-dark(cyan, deepskyblue); +} + +/* becomes */ + +.foo { + --csstools-light-dark-toggle--0: var(--csstools-color-scheme--dark) pink; + color: var(--csstools-light-dark-toggle--0, magenta); + color: light-dark(pink, magenta); +} + +.bar { + --csstools-light-dark-toggle--1: var(--csstools-color-scheme--dark) cyan; + --bar: var(--csstools-light-dark-toggle--1, deepskyblue); + & * { + --csstools-light-dark-toggle--1: var(--csstools-color-scheme--dark) cyan; + --bar: var(--csstools-light-dark-toggle--1, deepskyblue); + } +} + +@supports (color: light-dark(red, red)) { +.bar { + --bar: light-dark(cyan, deepskyblue); +} +} +``` + +Declare that your document supports both light and dark mode: + +```pcss +:root { + color-scheme: light dark; +} + +/* becomes */ + +:root { + --csstools-color-scheme--dark: ; + color-scheme: light dark; +}@media (prefers-color-scheme: dark) {:root { + --csstools-color-scheme--dark: initial; +} +} +``` + +Dynamically alter the supported color scheme for some elements: + +```pcss +:root { + /* Root only supports light mode */ + color-scheme: light; +} + +.foo { + /* This element and its children only support dark mode */ + color-scheme: dark; +} + +/* becomes */ + +:root { + /* Root only supports light mode */ + --csstools-color-scheme--dark: ; + color-scheme: light; +} + +.foo { + /* This element and its children only support dark mode */ + --csstools-color-scheme--dark: initial; + color-scheme: dark; +} +``` + +## Usage + +Add [PostCSS Light Dark Function] to your project: + +```bash +npm install postcss @csstools/postcss-light-dark-function --save-dev +``` + +Use it as a [PostCSS] plugin: + +```js +const postcss = require('postcss'); +const postcssLightDarkFunction = require('@csstools/postcss-light-dark-function'); + +postcss([ + postcssLightDarkFunction(/* pluginOptions */) +]).process(YOUR_CSS /*, processOptions */); +``` + +[PostCSS Light Dark Function] runs in all Node environments, with special +instructions for: + +- [Node](INSTALL.md#node) +- [PostCSS CLI](INSTALL.md#postcss-cli) +- [PostCSS Load Config](INSTALL.md#postcss-load-config) +- [Webpack](INSTALL.md#webpack) +- [Next.js](INSTALL.md#nextjs) +- [Gulp](INSTALL.md#gulp) +- [Grunt](INSTALL.md#grunt) + +## Options + +### preserve + +The `preserve` option determines whether the original notation +is preserved. By default, it is preserved. + +```js +postcssLightDarkFunction({ preserve: false }) +``` + +```pcss +.foo { + color: light-dark(pink, magenta); +} + +.bar { + --bar: light-dark(cyan, deepskyblue); +} + +/* becomes */ + +.foo { + --csstools-light-dark-toggle--0: var(--csstools-color-scheme--dark) pink; + color: var(--csstools-light-dark-toggle--0, magenta); +} + +.bar { + --csstools-light-dark-toggle--1: var(--csstools-color-scheme--dark) cyan; + --bar: var(--csstools-light-dark-toggle--1, deepskyblue); + & * { + --csstools-light-dark-toggle--1: var(--csstools-color-scheme--dark) cyan; + --bar: var(--csstools-light-dark-toggle--1, deepskyblue); + } +} +``` + +### enableProgressiveCustomProperties + +The `enableProgressiveCustomProperties` option determines whether the original notation +is wrapped with `@supports` when used in Custom Properties. By default, it is enabled. + +> [!NOTE] +> 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 +postcssLightDarkFunction({ enableProgressiveCustomProperties: false }) +``` + +[cli-url]: https://github.com/csstools/postcss-plugins/actions/workflows/test.yml?query=workflow/test +[css-url]: https://cssdb.org/#light-dark-function +[discord]: https://discord.gg/bUadyRwkJS +[npm-url]: https://www.npmjs.com/package/@csstools/postcss-light-dark-function + +[PostCSS]: https://github.com/postcss/postcss +[PostCSS Light Dark Function]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-light-dark-function +[CSS Color 5 Specification]: https://drafts.csswg.org/css-color-5/#light-dark -- cgit v1.2.3