Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify usage of outline utilities in documentation #2071

Merged
merged 4 commits into from
Feb 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/docs/background-size.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,13 @@ Use the `bg-auto` utility to display the background image at its default size:

### Using a custom value

<UsingACustomValue utility="bg" value="auto_100px" name="background image size" variable="image-size" dataType="length" />
<UsingACustomValue
utility="bg"
value="auto_100px"
name="background image size"
variable="image-size"
dataType="length"
/>

### Responsive design

Expand Down
2 changes: 1 addition & 1 deletion src/docs/border-width.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ export const description = "Utilities for controlling the width of an element's

### Basic example

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

<Figure>

Expand Down
4 changes: 2 additions & 2 deletions src/docs/box-shadow.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ By default colored shadows have an opacity of 100% but you can adjust this using

### Adding a ring

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

<Figure>

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

### Adding an inset ring

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:
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:

<Figure>

Expand Down
2 changes: 1 addition & 1 deletion src/docs/gap.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Use `gap-<number>` utilities like `gap-2` and `gap-4` to change the gap between

### Changing row and column gaps independently

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:
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:

<Figure>

Expand Down
2 changes: 1 addition & 1 deletion src/docs/grid-column.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Use `col-span-<number>` utilities like `col-span-2` and `col-span-4` to make an

### Starting and ending lines

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:
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:

<Figure>

Expand Down
2 changes: 1 addition & 1 deletion src/docs/grid-row.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Use `row-span-<number>` utilities like `row-span-2` and `row-span-4` to make an

### Starting and ending lines

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:
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:

<Figure>

Expand Down
2 changes: 1 addition & 1 deletion src/docs/height.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Use `h-<number>` utilities like `h-24` and `h-64` to set an element to a fixed h

### Using a percentage

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

<Figure>

Expand Down
4 changes: 2 additions & 2 deletions src/docs/margin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ To use a negative margin value, prefix the class name with a dash to convert it

### Using logical properties

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:
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:

<Figure>

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

### Adding space between children

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

<Figure>

Expand Down
2 changes: 1 addition & 1 deletion src/docs/max-height.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Use `max-h-<number>` utilities like `max-h-24` and `max-h-64` to set an element

### Using a percentage

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:
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:

<Figure>

Expand Down
2 changes: 1 addition & 1 deletion src/docs/max-width.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Use `max-w-<number>` utilities like `max-w-24` and `max-w-64` to set an element

### Using a percentage

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:
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:

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

Expand Down
2 changes: 1 addition & 1 deletion src/docs/min-height.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Use `min-h-<number>` utilities like `min-h-24` and `min-h-64` to set an element

### Using a percentage

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:
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:

<Figure>

Expand Down
2 changes: 1 addition & 1 deletion src/docs/min-width.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Use `min-w-<number>` utilities like `min-w-24` and `min-w-64` to set an element

### Using a percentage

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:
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:

<Figure>

Expand Down
2 changes: 1 addition & 1 deletion src/docs/outline-width.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export const description = "Utilities for controlling the width of an element's

### Basic example

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

<Figure>

Expand Down
2 changes: 1 addition & 1 deletion src/docs/padding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ Use `py-<number>` utilities like `py-4` and `py-8` to control the vertical paddi

### Using logical properties

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:
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:

<Figure>

Expand Down
2 changes: 1 addition & 1 deletion src/docs/scale.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ Use the `scale-y-<number>` utilities like `scale-y-75` and `-scale-y-150` to sca

### Using negative values

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:
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:

<Figure>

Expand Down
2 changes: 1 addition & 1 deletion src/docs/top-right-bottom-left.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ To use a negative top/right/bottom/left value, prefix the class name with a dash

### Using logical properties

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:
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:

<Figure>

Expand Down
4 changes: 2 additions & 2 deletions src/docs/translate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ Use `translate-<fraction>` utilities like `translate-1/4` and `-translate-full`

### Translating on the x-axis

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:
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:

<Figure>

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

### Translating on the y-axis

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:
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:

<Figure>

Expand Down
2 changes: 1 addition & 1 deletion src/docs/width.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Use `w-<number>` utilities like `w-24` and `w-64` to set an element to a fixed w

### Using a percentage

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

<Figure>

Expand Down