blob: 0f7f2d2a84c5827cad2c48d606ee85df7aec33de (
plain)
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
|
# PostCSS Gap Properties [<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/postcss-gap-properties.svg" height="20">][npm-url] [<img alt="CSS Standard Status" src="https://cssdb.org/images/badges/gap-properties.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]
```bash
npm install postcss-gap-properties --save-dev
```
[PostCSS Gap Properties] lets you use the `gap`, `column-gap`, and `row-gap`
shorthand properties in CSS, following the [CSS Grid Layout] specification.
```pcss
.standard-grid {
display: grid;
gap: 20px;
}
.spaced-grid {
display: grid;
column-gap: 40px;
row-gap: 20px;
}
/* becomes */
.standard-grid {
display: grid;
grid-gap: 20px;
gap: 20px;
}
.spaced-grid {
display: grid;
grid-column-gap: 40px;
column-gap: 40px;
grid-row-gap: 20px;
row-gap: 20px;
}
```
## Usage
Add [PostCSS Gap Properties] to your project:
```bash
npm install postcss postcss-gap-properties --save-dev
```
Use it as a [PostCSS] plugin:
```js
const postcss = require('postcss');
const postcssGapProperties = require('postcss-gap-properties');
postcss([
postcssGapProperties(/* pluginOptions */)
]).process(YOUR_CSS /*, processOptions */);
```
[PostCSS Gap Properties] runs in all Node environments, with special
instructions for:
- [Node](INSTALL.md#node)
- [PostCSS CLI](INSTALL.md#postcss-cli)
- [PostCSS Load Config](INSTALL.md#postcss-load-config)
- [Webpack](INSTALL.md#webpack)
- [Next.js](INSTALL.md#nextjs)
- [Gulp](INSTALL.md#gulp)
- [Grunt](INSTALL.md#grunt)
## Options
### preserve
The `preserve` option determines whether the original notation
is preserved. By default, it is preserved.
```js
postcssGapProperties({ preserve: false })
```
```pcss
.standard-grid {
display: grid;
gap: 20px;
}
.spaced-grid {
display: grid;
column-gap: 40px;
row-gap: 20px;
}
/* becomes */
.standard-grid {
display: grid;
grid-gap: 20px;
}
.spaced-grid {
display: grid;
grid-column-gap: 40px;
grid-row-gap: 20px;
}
```
[cli-url]: https://github.com/csstools/postcss-plugins/actions/workflows/test.yml?query=workflow/test
[css-url]: https://cssdb.org/#gap-properties
[discord]: https://discord.gg/bUadyRwkJS
[npm-url]: https://www.npmjs.com/package/postcss-gap-properties
[PostCSS]: https://github.com/postcss/postcss
[PostCSS Gap Properties]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-gap-properties
[CSS Grid Layout]: https://www.w3.org/TR/css-grid-1/#gutters
|
