Skip to content

Commit 50492b0

Browse files
committed
Update README to remove references to old configs, update borderRadius example, and add to Roadmap
1 parent bae139b commit 50492b0

File tree

1 file changed

+28
-26
lines changed

1 file changed

+28
-26
lines changed

README.md

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ El-Alfy.
112112
### Logical Height and Logical Width
113113

114114
Utilities are generated for the `block-size`, `inline-size`, `min-block-size`, `min-inline-size`, `max-block-size`, and
115-
`max-inline-size` properties. These match the values in your `height`, `width`, `min-height`, `min-width`,
116-
`max-height`, and `max-width` config objects, respectively.
115+
`max-inline-size` properties. These have the same range of values as `height`, `width`, `min-height`, `min-width`,
116+
`max-height`, and `max-width`, respectively.
117117

118118
```css
119119
.bs-1 {
@@ -139,8 +139,8 @@ Utilities are generated for the `block-size`, `inline-size`, `min-block-size`, `
139139
### Flow-relative Margins
140140

141141
Utilities are generated for the `margin-block-start`, `margin-block-end`, `margin-inline-start`, and
142-
`margin-inline-end` properties, as well as for the shorthand properties `margin-block` and `margin-inline`. These match
143-
the values in your `margin` config object.
142+
`margin-inline-end` properties, as well as for the shorthand properties `margin-block` and `margin-inline`. These have
143+
the same range of values as other `margin` utilities.
144144

145145
```css
146146
.mlb-1 {
@@ -166,8 +166,8 @@ the values in your `margin` config object.
166166
### Flow-relative Padding
167167

168168
Utilities are generated for the `padding-block-start`, `padding-block-end`, `padding-inline-start`, and
169-
`padding-inline-end` properties, as well as for the shorthand properties `padding-block` and `padding-end`. These match
170-
the values in your `padding` config object.
169+
`padding-inline-end` properties, as well as for the shorthand properties `padding-block` and `padding-end`. These have
170+
the same range of values as other `padding` utilities.
171171

172172
```css
173173
.plb-1 {
@@ -193,7 +193,7 @@ the values in your `padding` config object.
193193
### Flow-relative Space Between
194194

195195
Flow-relative utilities are generated for the Tailwind-specific [Space Between](https://tailwindcss.com/docs/space).
196-
These match the values in your `space` config object. All of the usual positive and negative values plus
196+
These have the same range of values as other `space` utilities. All of the usual positive and negative values plus
197197
`.space-b-reverse` and `.space-i-reverse` utilities are generated.
198198

199199
```css
@@ -217,8 +217,8 @@ These match the values in your `space` config object. All of the usual positive
217217
### Flow-relative Offsets (`top` / `right` / `bottom` / `left`)
218218

219219
Utilities are generated for the `inset-block-start`, `inset-block-end`, `inset-inline-start`, and
220-
`inset-inline-end` properties, as well as for the shorthand properties `inset-block` and `inset-inline`. These match
221-
the values in your `inset` config object.
220+
`inset-inline-end` properties, as well as for the shorthand properties `inset-block` and `inset-inline`. These have the
221+
same range of values as other `inset` utilities.
222222

223223
```css
224224
.inset-block-0 {
@@ -244,8 +244,8 @@ the values in your `inset` config object.
244244
### Flow-relative Border Widths
245245

246246
Utilities are generated for the `border-block-width`, `border-inline-width`, `border-block-start-width`,
247-
`border-block-end-width`, `border-inline-start-width`, and `border-inline-end-width` properties. These match the values
248-
in your `borderWidth` config object.
247+
`border-block-end-width`, `border-inline-start-width`, and `border-inline-end-width` properties. These have the same
248+
range of values as other `borderWidth` utilities.
249249

250250
```css
251251
.border-lb-2 {
@@ -271,8 +271,8 @@ in your `borderWidth` config object.
271271
### Flow-relative Border Colors
272272

273273
Utilities are generated for the `border-block-color`, `border-inline-color`, `border-block-start-color`,
274-
`border-block-end-color`, `border-inline-start-color`, and `border-inline-end-color` properties. These match the values
275-
in your `borderColor` config object.
274+
`border-block-end-color`, `border-inline-start-color`, and `border-inline-end-color` properties. These have the same
275+
range of values as other `borderColor` utilities
276276

277277
```css
278278
.border-lb-black {
@@ -298,9 +298,9 @@ in your `borderColor` config object.
298298
### Flow-relative Divide Width
299299

300300
Flow-relative utilities are generated for the Tailwind-specific
301-
[Divide Width](https://tailwindcss.com/docs/divide-width). These match the values in your `divideWidth` config object.
302-
All of the usual values plus `.divide-b`, `.divide-i`, `.divide-b-reverse` and `.divide-i-reverse` utilities are
303-
generated.
301+
[Divide Width](https://tailwindcss.com/docs/divide-width). These have the same range of values as other `divide`
302+
utilities. All of the usual values plus `.divide-b`, `.divide-i`, `.divide-b-reverse` and `.divide-i-reverse` utilities
303+
are generated.
304304

305305
```css
306306
.divide-b-2 > :not(:last-child) {
@@ -319,27 +319,27 @@ generated.
319319
### Flow-relative Corner Rounding (`border-radius`)
320320

321321
Shorthand utility classes are generated for rounding each side of an element. Utility classes for each individual
322-
corner are already provided by Tailwind itself. These match the values in your `borderRadius` config object.
322+
corner are already provided by Tailwind itself. These have the same range of values as other `borderRadius` utilities.
323323

324324
```css
325325
.rounded-bs-md {
326-
border-start-start-radius: 0.375rem;
327-
border-start-end-radius: 0.375rem;
326+
border-start-start-radius: var(--radius-md);
327+
border-start-end-radius: var(--radius-md);
328328
}
329329

330330
.rounded-be-md {
331-
border-end-start-radius: 0.375rem;
332-
border-end-end-radius: 0.375rem;
331+
border-end-start-radius: var(--radius-md);
332+
border-end-end-radius: var(--radius-md);
333333
}
334334

335335
.rounded-is-md {
336-
border-start-start-radius: 0.375rem;
337-
border-end-start-radius: 0.375rem;
336+
border-start-start-radius: var(--radius-md);
337+
border-end-start-radius: var(--radius-md);
338338
}
339339

340340
.rounded-ie-md {
341-
border-start-end-radius: 0.375rem;
342-
border-end-end-radius: 0.375rem;
341+
border-start-end-radius: var(--radius-md);
342+
border-end-end-radius: var(--radius-md);
343343
}
344344
```
345345

@@ -405,7 +405,9 @@ values will be converted to attribute selectors that any browser can understand.
405405
At this point I consider this plugin feature complete, but I will continue to monitor official specifications, as well
406406
as Tailwind itself, and update this plugin accordingly when anything changes.
407407

408-
One thing I do plan to do is add support for `caption-side`, now that it is part of Tailwind itself.
408+
One thing I do plan to do is add support for `caption-side`, now that it is part of Tailwind itself. I will also
409+
consider dropping the legacy plugin API and building entirely with CSS in the Tailwind v4 way eventually, if there is
410+
enough value in doing so.
409411

410412
## Contributing
411413

0 commit comments

Comments
 (0)