Skip to content

Commit e797999

Browse files
LeaVeroulindsaym-fa
andcommitted
Update docs to lean into the "tokens" terminology in lieu of "properties"
Co-Authored-By: Lindsay M <[email protected]>
1 parent 07f7009 commit e797999

File tree

8 files changed

+11
-11
lines changed

8 files changed

+11
-11
lines changed

docs/docs/themes/index.njk

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ categories:
1414

1515
## What's a Theme?
1616

17-
Themes are a collection of standardized [CSS custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/--*) that cover a range of styles from colors to transitions. We use these custom properties throughout Web Awesome components for a cohesive look and feel. Our [Theming pages](/docs/tokens/) document these styles so that you can use them freely throughout your project and customize them as needed.
17+
A theme is a collection of standardized [CSS custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/--*), also called "design tokens," that cover a range of styles from colors to transitions. We use these tokens throughout Web Awesome components for a cohesive look and feel. Our [Design Tokens pages](/docs/tokens/) document these styles so that you can use them freely throughout your project and customize them as needed.
1818

1919
Themes are scoped to unique classes, such as `wa-theme-default` or `wa-theme-classic`.
2020
Scoping to unique classes allows you to import multiple themes and use them interchangeably without collisions.

docs/docs/tokens/color.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@ Overlays provide a backdrop to isolate content, often allowing background contex
487487
### Shadow
488488

489489
Web Awesome uses a single color for all shadows.
490-
This is used alongside other [shadow properties](/docs/tokens/shadows) to construct your theme's shadows.
490+
This is used alongside other [shadow tokens](/docs/tokens/shadows) to construct your theme's shadows.
491491

492492
| Custom Property | Preview |
493493
| ------------------- | --------------------------------------------------------------------------- |
@@ -497,7 +497,7 @@ This is used alongside other [shadow properties](/docs/tokens/shadows) to constr
497497

498498
#### Focus
499499

500-
Web Awesome uses a single focus color for predictable keyboard navigation. This is used alongside other [focus properties](/docs/tokens/focus) to construct `--wa-focus-ring`. We recommend a minimum 3:1 contrast ratio against surface colors and background colors wherever possible.
500+
Web Awesome uses a single focus color for predictable keyboard navigation. This is used alongside other [focus tokens](/docs/tokens/focus) to construct `--wa-focus-ring`. We recommend a minimum 3:1 contrast ratio against surface colors and background colors wherever possible.
501501

502502
| Custom Property | Preview |
503503
| ------------------ | ----------------------------------------------------------------------------------------------------------------------- |

docs/docs/tokens/focus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Focus
33
description: Configure recognizable focus states with Web Awesome's focus properties.
44
---
55

6-
A consistent focus ring helps with predictable keyboard navigation. Together with [`--wa-color-focus`](/docs/tokens/color/#interactions), these custom properties create a uniform focus state for Web Awesome components.
6+
A consistent focus ring helps with predictable keyboard navigation. Together with [`--wa-color-focus`](/docs/tokens/color/#interactions), these tokens create a uniform focus state for Web Awesome components.
77

88

99
| Custom Property | Default Value |

docs/docs/tokens/shadows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Shadows
33
description: Elevate your components with Web Awesome's shadow properties.
44
---
55

6-
Shadows indicate elevation and, often, interactivity. Web Awesome offers highly modular shadow properties to easily create custom shadow effects or transform elements based on specific shadow qualities. Together with [`--wa-color-shadow`](/docs/tokens/color/#shadow), these custom properties create realistic shadows for Web Awesome components.
6+
Shadows indicate elevation and, often, interactivity. Web Awesome offers highly modular shadow properties to easily create custom shadow effects or transform elements based on specific shadow qualities. Together with [`--wa-color-shadow`](/docs/tokens/color/#shadow), these tokens create realistic shadows for Web Awesome components.
77

88
Shadows are constructed using corresponding offset-x, offset-y, blur, and spread properties, detailed in the sections below. In Web Awesome, shadows use a size-based scale where larger shadows have greater offset and blur values to indicate greater distance from the surface below.
99

docs/docs/tokens/typography.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Line heights control the distance between lines of text and are unitless to scal
6969

7070
## Links
7171

72-
Together with [`--wa-color-link`](/docs/tokens/color/#text), these custom properties add text decoration to `<a>` elements to signal their role as hyperlinks.
72+
Together with [`--wa-color-link`](/docs/tokens/color/#text), these tokens add text decoration to `<a>` elements to signal their role as hyperlinks.
7373

7474
| Custom Property | Default Value |
7575
| ------------------------------ | ---------------------------------------------------------------------------------- |

docs/docs/utilities/gap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ tags: ["utilities", "layout"]
1616
Web Awesome includes classes to set the `gap` property of flex and grid containers. They can be used alongside other Web Awesome layout utilities, like [cluster](/docs/layout/cluster) and [stack](/docs/layout/stack), to change the space between items.
1717
Or even by themselves — all gap properties also set `display: flex` with a specificity of 0 so that it can be trivially overridden.
1818

19-
Besides `wa-gap-0`, which sets `gap` to zero, each class corresponds to one of the [`--wa-space-*`](/docs/tokens/space) properties in your theme.
19+
Besides `wa-gap-0`, which sets `gap` to zero, each class corresponds to one of the [`--wa-space-*`](/docs/tokens/space) tokens in your theme.
2020

2121
| Class Name | `gap` Value | Preview |
2222
| ------------ | ---------------- | ----------------------------------------------------------------------------------------------------------- |

docs/docs/utilities/rounding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ status: wip
1414

1515
Web Awesome includes classes to set an element's `border-radius` property. They can be used alongside Web Awesome layout utilities, like [frame](/docs/layout/frame), to round all corners of an element.
1616

17-
Each class corresponds to one of the [`--wa-border-radius-*`](/docs/tokens/borders/#radius) properties in your theme.
17+
Each class corresponds to one of the [`--wa-border-radius-*`](/docs/tokens/borders/#radius) tokens in your theme.
1818

1919
| Class Name | `border-radius` Value | Preview |
2020
| ------------------------- | --------------------------- | --------------------------------------------------------------------------------------- |

docs/docs/utilities/text.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Use body classes to style the main content of your pages. Each `wa-body-*` class
1313
- `font-weight: var(--wa-font-weight-body);`
1414
- `line-height: var(--wa-line-height-normal);`
1515

16-
Additionally, each class specifies a `font-size` that corresponds to a [`--wa-font-size-*`](/docs/tokens/typography/#font-size) property from your theme.
16+
Additionally, each class specifies a `font-size` that corresponds to a [`--wa-font-size-*`](/docs/tokens/typography/#font-size) token from your theme.
1717

1818
| Class Name | `font-size` Value | Preview |
1919
| ------------------ | -------------------- | ------------------------------------------------------------------------- |
@@ -31,7 +31,7 @@ Use heading classes to style section titles and headings in your content. Each `
3131
- `line-height: var(--wa-line-height-condensed);`
3232
- `text-wrap: balance;`
3333

34-
Additionally, each class specifies a `font-size` using a [`--wa-font-size-*`](/docs/tokens/typography/#font-size) property from your theme. Heading classes are one font size larger than the corresponding `wa-body-*` class.
34+
Additionally, each class specifies a `font-size` using a [`--wa-font-size-*`](/docs/tokens/typography/#font-size) token from your theme. Heading classes are one font size larger than the corresponding `wa-body-*` class.
3535

3636
| Class Name | `font-size` Value | Preview |
3737
| ---------------- | -------------------- | ----------------------------------------------------- |
@@ -51,7 +51,7 @@ Use caption classes to style descriptions or auxiliary text in your content. Eac
5151
- `font-weight: var(--wa-font-weight-body);`
5252
- `line-height: var(--wa-line-height-condensed);`
5353

54-
Additionally, each class specifies a `font-size` using a [`--wa-font-size-*`](/docs/tokens/typography/#font-size) property from your theme. Caption classes are one font size smaller than the corresponding `wa-body-*` class.
54+
Additionally, each class specifies a `font-size` using a [`--wa-font-size-*`](/docs/tokens/typography/#font-size) token from your theme. Caption classes are one font size smaller than the corresponding `wa-body-*` class.
5555

5656
| Class Name | `font-size` Value | Preview |
5757
| ---------------- | -------------------- | ------------------------------------------------------------------------------ |

0 commit comments

Comments
 (0)