blob: ee6dfc835cf61d50a7e55f9670292462b58a6346 (
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
|
# PostCSS Logical Resize [<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-logical-resize.svg" height="20">][npm-url] [<img alt="CSS Standard Status" src="https://cssdb.org/images/badges/logical-resize.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 @csstools/postcss-logical-resize --save-dev
```
[PostCSS Logical Resize] lets you use logical, rather than physical, values for `resize`, following the [CSS Logical Properties and Values] specification.
```pcss
.resize-block {
resize: block;
}
.resize-inline {
resize: inline;
}
/* becomes */
.resize-block {
resize: vertical;
}
.resize-inline {
resize: horizontal;
}
```
## Usage
Add [PostCSS Logical Resize] to your project:
```bash
npm install postcss @csstools/postcss-logical-resize --save-dev
```
Use it as a [PostCSS] plugin:
```js
const postcss = require('postcss');
const postcssLogicalResize = require('@csstools/postcss-logical-resize');
postcss([
postcssLogicalResize(/* pluginOptions */)
]).process(YOUR_CSS /*, processOptions */);
```
[PostCSS Logical Resize] 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
### blockDirection & inlineDirection
The `blockDirection` and `inlineDirection` options allow you to specify the direction of the block and inline axes. The default values are `top-to-bottom` and `left-to-right` respectively, which would match any latin language.
**You should tweak these values so that they are specific to your language and writing mode.**
```js
postcssLogicalResize({
blockDirection: 'right-to-left',
inlineDirection: 'top-to-bottom'
})
```
```pcss
.resize-block {
resize: block;
}
.resize-inline {
resize: inline;
}
/* becomes */
.resize-block {
resize: horizontal;
}
.resize-inline {
resize: vertical;
}
```
Each direction must be one of the following:
- `top-to-bottom`
- `bottom-to-top`
- `left-to-right`
- `right-to-left`
You can't mix two vertical directions or two horizontal directions so for example `top-to-bottom` and `right-to-left` are valid, but `top-to-bottom` and `bottom-to-top` are not.
[cli-url]: https://github.com/csstools/postcss-plugins/actions/workflows/test.yml?query=workflow/test
[css-url]: https://cssdb.org/#logical-resize
[discord]: https://discord.gg/bUadyRwkJS
[npm-url]: https://www.npmjs.com/package/@csstools/postcss-logical-resize
[PostCSS]: https://github.com/postcss/postcss
[PostCSS Logical Resize]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-logical-resize
[CSS Logical Properties and Values]: https://www.w3.org/TR/css-logical-1/
|
