diff options
Diffstat (limited to 'node_modules/postcss-convert-values/README.md')
| -rw-r--r-- | node_modules/postcss-convert-values/README.md | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/node_modules/postcss-convert-values/README.md b/node_modules/postcss-convert-values/README.md new file mode 100644 index 00000000..5378fc36 --- /dev/null +++ b/node_modules/postcss-convert-values/README.md @@ -0,0 +1,98 @@ +# [postcss][postcss]-convert-values + +> Convert values with PostCSS (e.g. ms -> s) + +## Install + +With [npm](https://npmjs.org/package/postcss-convert-values) do: + +``` +npm install postcss-convert-values --save +``` + +## Example + +This plugin reduces CSS size by converting values to use different units +where possible; for example, `500ms` can be represented as `.5s`. You can +read more about these units in [this article][csstricks]. + +### Input + +```css +h1 { + font-size: 16px; + width: 0em +} +``` + +### Output + +```css +h1 { + font-size: 1pc; + width: 0 +} +``` + +Note that this plugin only covers conversions for duration and absolute length +values. For color conversions, use [postcss-colormin][colormin]. + +## API + +### convertValues([options]) + +#### options + +##### length + +Type: `boolean` +Default: `true` + +Pass `false` to disable conversion from `px` to other absolute length units, +such as `pc` & `pt` & vice versa. + +##### time + +Type: `boolean` +Default: `true` + +Pass `false` to disable conversion from `ms` to `s` & vice versa. + +##### angle + +Type: `boolean` +Default: `true` + +Pass `false` to disable conversion from `deg` to `turn` & vice versa. + +##### precision + +Type: `boolean|number` +Default: `false` + +Specify any numeric value here to round `px` values to that many decimal places; +for example, using `{precision: 2}` will round `6.66667px` to `6.67px`, and +`{precision: 0}` will round it to `7px`. Passing `false` (the default) will +leave these values as is. + +It is recommended for most use cases to set this option to `2`. + + +## Usage + +See the [PostCSS documentation](https://github.com/postcss/postcss#usage) for +examples for your environment. + + +## Contributors + +See [CONTRIBUTORS.md](https://github.com/cssnano/cssnano/blob/master/CONTRIBUTORS.md). + + +## License + +MIT © [Ben Briggs](http://beneb.info) + + +[postcss]: https://github.com/postcss/postcss +[csstricks]: https://css-tricks.com/the-lengths-of-css/ |
