From c06f7ee0a40255214c477e13d9b956a7e07c2900 Mon Sep 17 00:00:00 2001 From: littleblack111 Date: Sat, 14 Oct 2023 15:05:55 +0800 Subject: postcss,(plugins): nanocss, postcss-preset-env --- node_modules/postcss-overflow-shorthand/README.md | 83 +++++++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100644 node_modules/postcss-overflow-shorthand/README.md (limited to 'node_modules/postcss-overflow-shorthand/README.md') diff --git a/node_modules/postcss-overflow-shorthand/README.md b/node_modules/postcss-overflow-shorthand/README.md new file mode 100644 index 00000000..53fb07fb --- /dev/null +++ b/node_modules/postcss-overflow-shorthand/README.md @@ -0,0 +1,83 @@ +# PostCSS Overflow Shorthand [PostCSS Logo][PostCSS] + +[npm version][npm-url] [CSS Standard Status][css-url] [Build Status][cli-url] [Discord][discord] + +[PostCSS Overflow Shorthand] lets you use the `overflow` shorthand in CSS, +following the [CSS Overflow] specification. + +```pcss +html { + overflow: hidden auto; +} + +/* becomes */ + +html { + overflow-x: hidden; + overflow-y: auto; + overflow: hidden auto; +} +``` + +## Usage + +Add [PostCSS Overflow Shorthand] to your project: + +```bash +npm install postcss postcss-overflow-shorthand --save-dev +``` + +Use it as a [PostCSS] plugin: + +```js +const postcss = require('postcss'); +const postcssOverflowShorthand = require('postcss-overflow-shorthand'); + +postcss([ + postcssOverflowShorthand(/* pluginOptions */) +]).process(YOUR_CSS /*, processOptions */); +``` + +[PostCSS Overflow Shorthand] 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 +postcssOverflowShorthand({ preserve: false }) +``` + +```pcss +html { + overflow: hidden auto; +} + +/* becomes */ + +html { + overflow-x: hidden; + overflow-y: auto; +} +``` + +[cli-url]: https://github.com/csstools/postcss-plugins/actions/workflows/test.yml?query=workflow/test +[css-url]: https://cssdb.org/#overflow-property +[discord]: https://discord.gg/bUadyRwkJS +[npm-url]: https://www.npmjs.com/package/postcss-overflow-shorthand + +[PostCSS]: https://github.com/postcss/postcss +[PostCSS Overflow Shorthand]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-overflow-shorthand +[CSS Overflow]: https://drafts.csswg.org/css-overflow/#propdef-overflow -- cgit v1.2.3