Spaces:
Sleeping
Sleeping
File size: 5,882 Bytes
cc651f6 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
# PostCSS Trigonometric Functions [<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-trigonometric-functions.svg" height="20">][npm-url] [<img alt="CSS Standard Status" src="https://cssdb.org/images/badges/trigonometric-functions.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]
[PostCSS Trigonometric Functions] lets you use `sin`, `cos`, `tan`, `asin`, `acos`, `atan` and `atan2` to be able to compute trigonometric relationships following the [CSS Values 4] specification.
```pcss
.trigonometry {
line-height: sin(pi / 4);
line-height: cos(.125turn);
line-height: tan(50grad);
transform: rotate(asin(-1));
transform: rotate(asin(sin(30deg + 1.0471967rad)));
transform: rotate(acos(-1));
transform: rotate(acos(cos(0 / 2 + 1 - 1)));
transform: rotate(atan(infinity));
transform: rotate(atan(e - 2.7182818284590452354));
transform: rotate(atan2(-infinity,-infinity));
transform: rotate(atan2(-infinity,infinity));
transform: rotate(atan2(-infinity,infinity));
transform: rotate(atan2(90, 15));
}
/* becomes */
.trigonometry {
line-height: 0.70711;
line-height: 0.70711;
line-height: 1;
transform: rotate(-90deg);
transform: rotate(90deg);
transform: rotate(180deg);
transform: rotate(0deg);
transform: rotate(90deg);
transform: rotate(0deg);
transform: rotate(-135deg);
transform: rotate(-45deg);
transform: rotate(-45deg);
transform: rotate(80.54deg);
}
```
## Usage
Add [PostCSS Trigonometric Functions] to your project:
```bash
npm install postcss @csstools/postcss-trigonometric-functions --save-dev
```
Use it as a [PostCSS] plugin:
```js
const postcss = require('postcss');
const postcssTrigonometricFunctions = require('@csstools/postcss-trigonometric-functions');
postcss([
postcssTrigonometricFunctions(/* pluginOptions */)
]).process(YOUR_CSS /*, processOptions */);
```
[PostCSS Trigonometric Functions] runs in all Node environments, with special
instructions for:
| [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) |
| --- | --- | --- | --- | --- | --- |
## ⚠️ About custom properties
Given the dynamic nature of custom properties it's impossible to know what the variable value is, which means the plugin can't compute a final value for the stylesheet.
Because of that, any usage that contains a `var` is skipped.
## Units
[PostCSS Trigonometric Functions] lets you use different special units that are within the spec and computed at run time to be able to calculate the result of the trigonometric function.
The following units are supported:
* `pi`: Computes to `Math.PI` which is `3.141592653589793`
* `e`: Computes to `Math.E` which is `2.718281828459045`
* `infinity`, `-infinity`: Compute to `Infinity` and `-Infinity` respectively. Note that the usage is case insensitive so `InFiNiTy` is a valid value.
Some calculations (such as `sin(-infinity)`) might return `NaN` as per the spec. Given that `NaN` can't be replaced with a value that's useful to CSS it is left as is, as the result will be effectively ignored by the browser.
## Options
### preserve
The `preserve` option determines whether the original notation
is preserved. By default, it is not preserved.
```js
postcssTrigonometricFunctions({ preserve: true })
```
```pcss
.trigonometry {
line-height: sin(pi / 4);
line-height: cos(.125turn);
line-height: tan(50grad);
transform: rotate(asin(-1));
transform: rotate(asin(sin(30deg + 1.0471967rad)));
transform: rotate(acos(-1));
transform: rotate(acos(cos(0 / 2 + 1 - 1)));
transform: rotate(atan(infinity));
transform: rotate(atan(e - 2.7182818284590452354));
transform: rotate(atan2(-infinity,-infinity));
transform: rotate(atan2(-infinity,infinity));
transform: rotate(atan2(-infinity,infinity));
transform: rotate(atan2(90, 15));
}
/* becomes */
.trigonometry {
line-height: 0.70711;
line-height: sin(pi / 4);
line-height: 0.70711;
line-height: cos(.125turn);
line-height: 1;
line-height: tan(50grad);
transform: rotate(-90deg);
transform: rotate(asin(-1));
transform: rotate(90deg);
transform: rotate(asin(1));
transform: rotate(asin(sin(30deg + 1.0471967rad)));
transform: rotate(180deg);
transform: rotate(acos(-1));
transform: rotate(0deg);
transform: rotate(acos(1));
transform: rotate(acos(cos(0 / 2 + 1 - 1)));
transform: rotate(90deg);
transform: rotate(atan(infinity));
transform: rotate(0deg);
transform: rotate(atan(e - 2.7182818284590452354));
transform: rotate(-135deg);
transform: rotate(atan2(-infinity,-infinity));
transform: rotate(-45deg);
transform: rotate(atan2(-infinity,infinity));
transform: rotate(-45deg);
transform: rotate(atan2(-infinity,infinity));
transform: rotate(80.54deg);
transform: rotate(atan2(90, 15));
}
```
[cli-url]: https://github.com/csstools/postcss-plugins/actions/workflows/test.yml?query=workflow/test
[css-url]: https://cssdb.org/#trigonometric-functions
[discord]: https://discord.gg/bUadyRwkJS
[npm-url]: https://www.npmjs.com/package/@csstools/postcss-trigonometric-functions
[Gulp PostCSS]: https://github.com/postcss/gulp-postcss
[Grunt PostCSS]: https://github.com/nDmitry/grunt-postcss
[PostCSS]: https://github.com/postcss/postcss
[PostCSS Loader]: https://github.com/postcss/postcss-loader
[PostCSS Trigonometric Functions]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-trigonometric-functions
[CSS Values 4]: https://www.w3.org/TR/css-values-4/#trig-funcs
|