Skip to content

Commit 7dfb482

Browse files
Clarify usage of outline utilities in documentation (#2071)
This pull request includes a small change to the `src/docs/outline-width.mdx` file. The change modifies the description to clarify the usage of `outline` utilities. * [`src/docs/outline-width.mdx`](diffhunk://#diff-a7a0467902b75954570708cc09d471f346011c3bce60b92e96aaa0c8b21f56daL22-R22): Changed "and" to "or" in the description to clarify that either `outline` or `outline-<number>` utilities can be used to set the width of an element's outline. --------- Co-authored-by: Philipp Spiess <hello@philippspiess.com>
1 parent e3319e2 commit 7dfb482

18 files changed

+27
-21
lines changed

src/docs/background-size.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,13 @@ Use the `bg-auto` utility to display the background image at its default size:
9393

9494
### Using a custom value
9595

96-
<UsingACustomValue utility="bg" value="auto_100px" name="background image size" variable="image-size" dataType="length" />
96+
<UsingACustomValue
97+
utility="bg"
98+
value="auto_100px"
99+
name="background image size"
100+
variable="image-size"
101+
dataType="length"
102+
/>
97103

98104
### Responsive design
99105

src/docs/border-width.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ export const description = "Utilities for controlling the width of an element's
126126

127127
### Basic example
128128

129-
Use `border` and `border-<number>` utilities like `border-2` and `border-4` to set the border width for all sides of an element:
129+
Use `border` or `border-<number>` utilities like `border-2` and `border-4` to set the border width for all sides of an element:
130130

131131
<Figure>
132132

src/docs/box-shadow.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ By default colored shadows have an opacity of 100% but you can adjust this using
240240

241241
### Adding a ring
242242

243-
Use `ring` and `ring-<number>` utilities like `ring-2` and `ring-4` to apply a solid box-shadow to an element:
243+
Use `ring` or `ring-<number>` utilities like `ring-2` and `ring-4` to apply a solid box-shadow to an element:
244244

245245
<Figure>
246246

@@ -319,7 +319,7 @@ By default rings have an opacity of 100% but you can adjust this using the opaci
319319

320320
### Adding an inset ring
321321

322-
Use `inset-ring` and `inset-ring-<number>` utilities like `inset-ring-2` and `inset-ring-4` to apply a solid inset box-shadow to an element:
322+
Use `inset-ring` or `inset-ring-<number>` utilities like `inset-ring-2` and `inset-ring-4` to apply a solid inset box-shadow to an element:
323323

324324
<Figure>
325325

src/docs/gap.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Use `gap-<number>` utilities like `gap-2` and `gap-4` to change the gap between
5757

5858
### Changing row and column gaps independently
5959

60-
Use `gap-x-<number>` and `gap-y-<number>` utilities like `gap-x-8` and `gap-y-4` to change the gap between columns and rows independently:
60+
Use `gap-x-<number>` or `gap-y-<number>` utilities like `gap-x-8` and `gap-y-4` to change the gap between columns and rows independently:
6161

6262
<Figure>
6363

src/docs/grid-column.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Use `col-span-<number>` utilities like `col-span-2` and `col-span-4` to make an
7171

7272
### Starting and ending lines
7373

74-
Use `col-start-<number>` and `col-end-<number>` utilities like `col-start-2` and `col-end-3` to make an element start or end at the _nth_ grid line:
74+
Use `col-start-<number>` or `col-end-<number>` utilities like `col-start-2` and `col-end-3` to make an element start or end at the _nth_ grid line:
7575

7676
<Figure>
7777

src/docs/grid-row.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Use `row-span-<number>` utilities like `row-span-2` and `row-span-4` to make an
6565

6666
### Starting and ending lines
6767

68-
Use `row-start-<number>` and `row-end-<number>` utilities like `row-start-2` and `row-end-3` to make an element start or end at the _nth_ grid line:
68+
Use `row-start-<number>` or `row-end-<number>` utilities like `row-start-2` and `row-end-3` to make an element start or end at the _nth_ grid line:
6969

7070
<Figure>
7171

src/docs/height.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Use `h-<number>` utilities like `h-24` and `h-64` to set an element to a fixed h
9797

9898
### Using a percentage
9999

100-
Use `h-full` and `h-<fraction>` utilities like `h-1/2` and `h-2/5` to give an element a percentage-based height:
100+
Use `h-full` or `h-<fraction>` utilities like `h-1/2` and `h-2/5` to give an element a percentage-based height:
101101

102102
<Figure>
103103

src/docs/margin.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ To use a negative margin value, prefix the class name with a dash to convert it
252252

253253
### Using logical properties
254254

255-
Use `ms-<number>` and `me-<number>` utilities like `ms-4` and `me-8` to set the `margin-inline-start` and `margin-inline-end` logical properties:
255+
Use `ms-<number>` or `me-<number>` utilities like `ms-4` and `me-8` to set the `margin-inline-start` and `margin-inline-end` logical properties:
256256

257257
<Figure>
258258

@@ -305,7 +305,7 @@ Use `ms-<number>` and `me-<number>` utilities like `ms-4` and `me-8` to set the
305305

306306
### Adding space between children
307307

308-
Use `space-x-<number>` and `space-y-<number>` utilities like `space-x-4` and `space-y-8` to control the space between elements:
308+
Use `space-x-<number>` or `space-y-<number>` utilities like `space-x-4` and `space-y-8` to control the space between elements:
309309

310310
<Figure>
311311

src/docs/max-height.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Use `max-h-<number>` utilities like `max-h-24` and `max-h-64` to set an element
9797

9898
### Using a percentage
9999

100-
Use `max-h-full` and `max-h-<fraction>` utilities like `max-h-1/2` and `max-h-2/5` to give an element a percentage-based maximum height:
100+
Use `max-h-full` or `max-h-<fraction>` utilities like `max-h-1/2` and `max-h-2/5` to give an element a percentage-based maximum height:
101101

102102
<Figure>
103103

src/docs/max-width.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Use `max-w-<number>` utilities like `max-w-24` and `max-w-64` to set an element
113113

114114
### Using a percentage
115115

116-
Use `max-w-full` and `max-w-<fraction>` utilities like `max-w-1/2` and `max-w-2/5` to give an element a percentage-based maximum width:
116+
Use `max-w-full` or `max-w-<fraction>` utilities like `max-w-1/2` and `max-w-2/5` to give an element a percentage-based maximum width:
117117

118118
<Figure hint="Resize the example to see the expected behavior">
119119

src/docs/min-height.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Use `min-h-<number>` utilities like `min-h-24` and `min-h-64` to set an element
8484

8585
### Using a percentage
8686

87-
Use `min-h-full` and `min-h-<fraction>` utilities like `min-h-1/2`, and `min-h-2/5` to give an element a percentage-based minimum height:
87+
Use `min-h-full` or `min-h-<fraction>` utilities like `min-h-1/2`, and `min-h-2/5` to give an element a percentage-based minimum height:
8888

8989
<Figure>
9090

src/docs/min-width.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Use `min-w-<number>` utilities like `min-w-24` and `min-w-64` to set an element
8080

8181
### Using a percentage
8282

83-
Use `min-w-full` and `min-w-<fraction>` utilities like `min-w-1/2` and `min-w-2/5` to give an element a percentage-based minimum width:
83+
Use `min-w-full` or `min-w-<fraction>` utilities like `min-w-1/2` and `min-w-2/5` to give an element a percentage-based minimum width:
8484

8585
<Figure>
8686

src/docs/outline-width.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export const description = "Utilities for controlling the width of an element's
1919

2020
### Basic example
2121

22-
Use `outline` and `outline-<number>` utilities like `outline-2` and `outline-4` to set the width of an element's outline:
22+
Use `outline` or `outline-<number>` utilities like `outline-2` and `outline-4` to set the width of an element's outline:
2323

2424
<Figure>
2525

src/docs/padding.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ Use `py-<number>` utilities like `py-4` and `py-8` to control the vertical paddi
157157

158158
### Using logical properties
159159

160-
Use `ps-<number>` and `pe-<number>` utilities like `ps-4` and `pe-8` to set the `padding-inline-start` and `padding-inline-end` logical properties, which map to either the left or right side based on the text direction:
160+
Use `ps-<number>` or `pe-<number>` utilities like `ps-4` and `pe-8` to set the `padding-inline-start` and `padding-inline-end` logical properties, which map to either the left or right side based on the text direction:
161161

162162
<Figure>
163163

src/docs/scale.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ Use the `scale-y-<number>` utilities like `scale-y-75` and `-scale-y-150` to sca
267267

268268
### Using negative values
269269

270-
Use `-scale-<number>`, `-scale-x-<number>` and `-scale-y-<number>` utilities like `-scale-x-75` and `-scale-125` to mirror and scale down an element by a percentage of its original size:
270+
Use `-scale-<number>`, `-scale-x-<number>` or `-scale-y-<number>` utilities like `-scale-x-75` and `-scale-125` to mirror and scale down an element by a percentage of its original size:
271271

272272
<Figure>
273273

src/docs/top-right-bottom-left.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ To use a negative top/right/bottom/left value, prefix the class name with a dash
201201

202202
### Using logical properties
203203

204-
Use `start-<number>` and `end-<number>` utilities like `start-0` and `end-4` to set the `inset-inline-start` and `inset-inline-end` [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Logical_Properties/Basic_concepts), which map to either the left or right side based on the text direction:
204+
Use `start-<number>` or `end-<number>` utilities like `start-0` and `end-4` to set the `inset-inline-start` and `inset-inline-end` [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Logical_Properties/Basic_concepts), which map to either the left or right side based on the text direction:
205205

206206
<Figure>
207207

src/docs/translate.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ Use `translate-<fraction>` utilities like `translate-1/4` and `-translate-full`
212212

213213
### Translating on the x-axis
214214

215-
Use `translate-x-<number>` and `translate-x-<fraction>` utilities like `translate-x-4` and `translate-x-1/4` to translate an element on the x-axis:
215+
Use `translate-x-<number>` or `translate-x-<fraction>` utilities like `translate-x-4` and `translate-x-1/4` to translate an element on the x-axis:
216216

217217
<Figure>
218218

@@ -296,7 +296,7 @@ Use `translate-x-<number>` and `translate-x-<fraction>` utilities like `translat
296296

297297
### Translating on the y-axis
298298

299-
Use `translate-y-<number>` and `translate-y-<fraction>` utilities like `translate-y-6` and `translate-y-1/3` to translate an element on the y-axis:
299+
Use `translate-y-<number>` or `translate-y-<fraction>` utilities like `translate-y-6` and `translate-y-1/3` to translate an element on the y-axis:
300300

301301
<Figure>
302302

src/docs/width.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Use `w-<number>` utilities like `w-24` and `w-64` to set an element to a fixed w
9696

9797
### Using a percentage
9898

99-
Use `w-full` and `w-<fraction>` utilities like `w-1/2` and `w-2/5` to give an element a percentage-based width:
99+
Use `w-full` or `w-<fraction>` utilities like `w-1/2` and `w-2/5` to give an element a percentage-based width:
100100

101101
<Figure>
102102

0 commit comments

Comments
 (0)