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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
# Installing PostCSS HWB Function
[PostCSS HWB Function] runs in all Node environments, with special instructions for:
- [Node](#node)
- [PostCSS CLI](#postcss-cli)
- [PostCSS Load Config](#postcss-load-config)
- [Webpack](#webpack)
- [Next.js](#nextjs)
- [Gulp](#gulp)
- [Grunt](#grunt)
## Node
Add [PostCSS HWB Function] to your project:
```bash
npm install postcss @csstools/postcss-hwb-function --save-dev
```
Use it as a [PostCSS] plugin:
```js
// commonjs
const postcss = require('postcss');
const postcssHWBFunction = require('@csstools/postcss-hwb-function');
postcss([
postcssHWBFunction(/* pluginOptions */)
]).process(YOUR_CSS /*, processOptions */);
```
```js
// esm
import postcss from 'postcss';
import postcssHWBFunction from '@csstools/postcss-hwb-function';
postcss([
postcssHWBFunction(/* pluginOptions */)
]).process(YOUR_CSS /*, processOptions */);
```
## PostCSS CLI
Add [PostCSS CLI] to your project:
```bash
npm install postcss-cli @csstools/postcss-hwb-function --save-dev
```
Use [PostCSS HWB Function] in your `postcss.config.js` configuration file:
```js
const postcssHWBFunction = require('@csstools/postcss-hwb-function');
module.exports = {
plugins: [
postcssHWBFunction(/* pluginOptions */)
]
}
```
## PostCSS Load Config
If your framework/CLI supports [`postcss-load-config`](https://github.com/postcss/postcss-load-config).
```bash
npm install @csstools/postcss-hwb-function --save-dev
```
`package.json`:
```json
{
"postcss": {
"plugins": {
"@csstools/postcss-hwb-function": {}
}
}
}
```
`.postcssrc.json`:
```json
{
"plugins": {
"@csstools/postcss-hwb-function": {}
}
}
```
_See the [README of `postcss-load-config`](https://github.com/postcss/postcss-load-config#usage) for more usage options._
## Webpack
_Webpack version 5_
Add [PostCSS Loader] to your project:
```bash
npm install postcss-loader @csstools/postcss-hwb-function --save-dev
```
Use [PostCSS HWB Function] in your Webpack configuration:
```js
module.exports = {
module: {
rules: [
{
test: /\.css$/i,
use: [
"style-loader",
{
loader: "css-loader",
options: { importLoaders: 1 },
},
{
loader: "postcss-loader",
options: {
postcssOptions: {
plugins: [
// Other plugins,
[
"@csstools/postcss-hwb-function",
{
// Options
},
],
],
},
},
},
],
},
],
},
};
```
## Next.js
Read the instructions on how to [customize the PostCSS configuration in Next.js](https://nextjs.org/docs/advanced-features/customizing-postcss-config)
```bash
npm install @csstools/postcss-hwb-function --save-dev
```
Use [PostCSS HWB Function] in your `postcss.config.json` file:
```json
{
"plugins": [
"@csstools/postcss-hwb-function"
]
}
```
```json5
{
"plugins": [
[
"@csstools/postcss-hwb-function",
{
// Optionally add plugin options
}
]
]
}
```
## Gulp
Add [Gulp PostCSS] to your project:
```bash
npm install gulp-postcss @csstools/postcss-hwb-function --save-dev
```
Use [PostCSS HWB Function] in your Gulpfile:
```js
const postcss = require('gulp-postcss');
const postcssHWBFunction = require('@csstools/postcss-hwb-function');
gulp.task('css', function () {
var plugins = [
postcssHWBFunction(/* pluginOptions */)
];
return gulp.src('./src/*.css')
.pipe(postcss(plugins))
.pipe(gulp.dest('.'));
});
```
## Grunt
Add [Grunt PostCSS] to your project:
```bash
npm install grunt-postcss @csstools/postcss-hwb-function --save-dev
```
Use [PostCSS HWB Function] in your Gruntfile:
```js
const postcssHWBFunction = require('@csstools/postcss-hwb-function');
grunt.loadNpmTasks('grunt-postcss');
grunt.initConfig({
postcss: {
options: {
processors: [
postcssHWBFunction(/* pluginOptions */)
]
},
dist: {
src: '*.css'
}
}
});
```
[Gulp PostCSS]: https://github.com/postcss/gulp-postcss
[Grunt PostCSS]: https://github.com/nDmitry/grunt-postcss
[PostCSS]: https://github.com/postcss/postcss
[PostCSS CLI]: https://github.com/postcss/postcss-cli
[PostCSS Loader]: https://github.com/postcss/postcss-loader
[PostCSS HWB Function]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-hwb-function
[Next.js]: https://nextjs.org
|
