diff options
Diffstat (limited to 'node_modules/@csstools/postcss-media-queries-aspect-ratio-number-values/README.md')
| -rw-r--r-- | node_modules/@csstools/postcss-media-queries-aspect-ratio-number-values/README.md | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/node_modules/@csstools/postcss-media-queries-aspect-ratio-number-values/README.md b/node_modules/@csstools/postcss-media-queries-aspect-ratio-number-values/README.md new file mode 100644 index 00000000..8ed8ca89 --- /dev/null +++ b/node_modules/@csstools/postcss-media-queries-aspect-ratio-number-values/README.md @@ -0,0 +1,75 @@ +# PostCSS Media Queries Aspect-Ratio Number Values [<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/@csstools/postcss-media-queries-aspect-ratio-number-values.svg" height="20">][npm-url] [<img alt="CSS Standard Status" src="https://cssdb.org/images/badges/media-queries-aspect-ratio-number-values.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] + +```bash +npm install @csstools/postcss-media-queries-aspect-ratio-number-values --save-dev +``` + +[PostCSS Media Queries Aspect-Ratio Number Values] lets you use non-integer numbers and `calc()` in `aspect-ratio` feature queries following the [Media Queries 4 Specification]. + +```pcss +@media (min-aspect-ratio: 1.77) {} + +/* becomes */ + +@media (min-aspect-ratio: 177/100) {} +``` + +## Usage + +Add [PostCSS Media Queries Aspect-Ratio Number Values] to your project: + +```bash +npm install postcss @csstools/postcss-media-queries-aspect-ratio-number-values --save-dev +``` + +Use it as a [PostCSS] plugin: + +```js +const postcss = require('postcss'); +const postcssMediaQueriesAspectRatioNumberValues = require('@csstools/postcss-media-queries-aspect-ratio-number-values'); + +postcss([ + postcssMediaQueriesAspectRatioNumberValues(/* pluginOptions */) +]).process(YOUR_CSS /*, processOptions */); +``` + +[PostCSS Media Queries Aspect-Ratio Number Values] 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 not preserved. + +```js +postcssMediaQueriesAspectRatioNumberValues({ preserve: true }) +``` + +```pcss +@media (min-aspect-ratio: 1.77) {} + +/* becomes */ + +@media (min-aspect-ratio: 1.77),(min-aspect-ratio: 177/100) {} +``` + +[cli-url]: https://github.com/csstools/postcss-plugins/actions/workflows/test.yml?query=workflow/test +[css-url]: https://cssdb.org/#media-queries-aspect-ratio-number-values +[discord]: https://discord.gg/bUadyRwkJS +[npm-url]: https://www.npmjs.com/package/@csstools/postcss-media-queries-aspect-ratio-number-values + +[PostCSS]: https://github.com/postcss/postcss +[PostCSS Media Queries Aspect-Ratio Number Values]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-media-queries-aspect-ratio-number-values +[Media Queries 4 Specification]: https://www.w3.org/TR/mediaqueries-4/#aspect-ratio |
