Blame view

node_modules/postcss-calc/README.md 3.13 KB
aaac7fed   liuqimichale   add
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
160
161
162
163
164
165
166
167
168
169
170
171
  # postcss-calc [![Build Status](https://travis-ci.org/postcss/postcss-calc.png)](https://travis-ci.org/postcss/postcss-calc)
  
  > [PostCSS](https://github.com/postcss/postcss) plugin to reduce `calc()`.
  
  This plugin reduce `calc()` references whenever it's possible.
  This can be particularly useful with the [postcss-custom-properties](https://github.com/postcss/postcss-custom-properties) plugin.
  
  **Note:** When multiple units are mixed together in the same expression, the `calc()` statement is left as is, to fallback to the [w3c calc() feature](http://www.w3.org/TR/css3-values/#calc).
  
  ## Installation
  
  ```console
  $ npm install postcss-calc
  ```
  
  ## Usage
  
  ```js
  // dependencies
  var fs = require("fs")
  var postcss = require("postcss")
  var calc = require("postcss-calc")
  
  // css to be processed
  var css = fs.readFileSync("input.css", "utf8")
  
  // process css
  var output = postcss()
    .use(calc())
    .process(css)
    .css
  ```
  
  **Example** (with [postcss-custom-properties](https://github.com/postcss/postcss-custom-properties) enabled as well):
  
  ```js
  // dependencies
  var fs = require("fs")
  var postcss = require("postcss")
  var customProperties = require("postcss-custom-properties")
  var calc = require("postcss-calc")
  
  // css to be processed
  var css = fs.readFileSync("input.css", "utf8")
  
  // process css
  var output = postcss()
    .use(customProperties())
    .use(calc())
    .process(css)
    .css
  ```
  
  Using this `input.css`:
  
  ```css
  :root {
    --main-font-size: 16px;
  }
  
  body {
    font-size: var(--main-font-size);
  }
  
  h1 {
    font-size: calc(var(--main-font-size) * 2);
    height: calc(100px - 2em);
    margin-bottom: calc(
        var(--main-font-size)
        * 1.5
      )
  }
  ```
  
  you will get:
  
  ```css
  body {
    font-size: 16px
  }
  
  h1 {
    font-size: 32px;
    height: calc(100px - 2em);
    margin-bottom: 24px
  }
  ```
  
  Checkout [tests](test) for more examples.
  
  ### Options
  
  #### `precision` (default: `5`)
  
  Allow you to definine the precision for decimal numbers.
  
  ```js
  var out = postcss()
    .use(calc({precision: 10}))
    .process(css)
    .css
  ```
  
  #### `preserve` (default: `false`)
  
  Allow you to preserve calc() usage in output so browsers will handle decimal precision themselves.
  
  ```js
  var out = postcss()
    .use(calc({preserve: true}))
    .process(css)
    .css
  ```
  
  #### `warnWhenCannotResolve` (default: `false`)
  
  Adds warnings when calc() are not reduced to a single value.
  
  ```js
  var out = postcss()
    .use(calc({warnWhenCannotResolve: true}))
    .process(css)
    .css
  ```
  
  #### `mediaQueries` (default: `false`)
  
  Allows calc() usage as part of media query declarations.
  
  ```js
  var out = postcss()
    .use(calc({mediaQueries: true}))
    .process(css)
    .css
  ```
  
  #### `selectors` (default: `false`)
  
  Allows calc() usage as part of selectors.
  
  ```js
  var out = postcss()
    .use(calc({selectors: true}))
    .process(css)
    .css
  ```
  
  Example:
  
  ```css
  div[data-size="calc(3*3)"] {
    width: 100px;
  }
  ```
  
  ---
  
  ## Contributing
  
  Work on a branch, install dev-dependencies, respect coding style & run tests before submitting a bug fix or a feature.
  
  ```console
  $ git clone https://github.com/postcss/postcss-calc.git
  $ git checkout -b patch-1
  $ npm install
  $ npm test
  ```
  
  ## [Changelog](CHANGELOG.md)
  
  ## [License](LICENSE)