| [9af201e] | 1 | # PostCSS Nested Calc [<img src="https://postcss.github.io/postcss/logo.svg" alt="PostCSS Logo" width="90" height="90" align="right">][postcss]
|
|---|
| 2 |
|
|---|
| 3 | [<img alt="npm version" src="https://img.shields.io/npm/v/@csstools/postcss-nested-calc.svg" height="20">][npm-url] [<img alt="CSS Standard Status" src="https://cssdb.org/images/badges/nested-calc.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]
|
|---|
| 4 |
|
|---|
| 5 | [PostCSS Nested Calc] lets you use nested `calc()` expressions following the [CSS Values and Units 4 specification].
|
|---|
| 6 |
|
|---|
| 7 | ```pcss
|
|---|
| 8 | .example {
|
|---|
| 9 | order: calc(1 + calc(2 * 2));
|
|---|
| 10 | }
|
|---|
| 11 |
|
|---|
| 12 | /* becomes */
|
|---|
| 13 |
|
|---|
| 14 | .example {
|
|---|
| 15 | order: calc(1 + (2 * 2));
|
|---|
| 16 | order: calc(1 + calc(2 * 2));
|
|---|
| 17 | }
|
|---|
| 18 | ```
|
|---|
| 19 |
|
|---|
| 20 | ## Usage
|
|---|
| 21 |
|
|---|
| 22 | Add [PostCSS Nested Calc] to your project:
|
|---|
| 23 |
|
|---|
| 24 | ```bash
|
|---|
| 25 | npm install postcss @csstools/postcss-nested-calc --save-dev
|
|---|
| 26 | ```
|
|---|
| 27 |
|
|---|
| 28 | Use it as a [PostCSS] plugin:
|
|---|
| 29 |
|
|---|
| 30 | ```js
|
|---|
| 31 | const postcss = require('postcss');
|
|---|
| 32 | const postcssNestedCalc = require('@csstools/postcss-nested-calc');
|
|---|
| 33 |
|
|---|
| 34 | postcss([
|
|---|
| 35 | postcssNestedCalc(/* pluginOptions */)
|
|---|
| 36 | ]).process(YOUR_CSS /*, processOptions */);
|
|---|
| 37 | ```
|
|---|
| 38 |
|
|---|
| 39 | [PostCSS Nested Calc] runs in all Node environments, with special
|
|---|
| 40 | instructions for:
|
|---|
| 41 |
|
|---|
| 42 | | [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) |
|
|---|
| 43 | | --- | --- | --- | --- | --- | --- |
|
|---|
| 44 |
|
|---|
| 45 | ## Options
|
|---|
| 46 |
|
|---|
| 47 | ### preserve
|
|---|
| 48 |
|
|---|
| 49 | The `preserve` option determines whether the original notation
|
|---|
| 50 | is preserved. By default the original values are preserved.
|
|---|
| 51 |
|
|---|
| 52 | ```js
|
|---|
| 53 | postcssNestedCalc({ preserve: false })
|
|---|
| 54 | ```
|
|---|
| 55 |
|
|---|
| 56 | ```pcss
|
|---|
| 57 | .example {
|
|---|
| 58 | order: calc(1 + calc(2 * 2));
|
|---|
| 59 | }
|
|---|
| 60 |
|
|---|
| 61 | /* becomes */
|
|---|
| 62 |
|
|---|
| 63 | .example {
|
|---|
| 64 | order: calc(1 + (2 * 2));
|
|---|
| 65 | }
|
|---|
| 66 | ```
|
|---|
| 67 |
|
|---|
| 68 | [cli-url]: https://github.com/csstools/postcss-plugins/actions/workflows/test.yml?query=workflow/test
|
|---|
| 69 | [css-url]: https://cssdb.org/#nested-calc
|
|---|
| 70 | [discord]: https://discord.gg/bUadyRwkJS
|
|---|
| 71 | [npm-url]: https://www.npmjs.com/package/@csstools/postcss-nested-calc
|
|---|
| 72 |
|
|---|
| 73 | [Gulp PostCSS]: https://github.com/postcss/gulp-postcss
|
|---|
| 74 | [Grunt PostCSS]: https://github.com/nDmitry/grunt-postcss
|
|---|
| 75 | [PostCSS]: https://github.com/postcss/postcss
|
|---|
| 76 | [PostCSS Loader]: https://github.com/postcss/postcss-loader
|
|---|
| 77 | [PostCSS Nested Calc]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-nested-calc
|
|---|
| 78 | [CSS Values and Units 4 specification]: https://www.w3.org/TR/css-values/#calc-func
|
|---|
