Skip to content

Document theme colors in custom utilities #2525

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.

Sign up for GitHub

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

Open
PedroLunet wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document theme colors in custom utilities #2525

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 24 additions & 0 deletions src/docs/adding-custom-styles.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,6 +484,30 @@ Use the `--value(--theme-key-*)` syntax to resolve the utility value against a s

This will match utilities like `tab-2`, `tab-4`, and `tab-github`.

Use `--value(--color-*)` to create utilities that work with your theme colors, including the default color palette and any custom colors:

```css
/* [!code filename:CSS] */
@theme {
--color-avocado-500: oklch(0.84 0.18 117.33);
}

@utility glow-* {
/* [!code highlight:2] */
/* prettier-ignore */
box-shadow: 0 0 2rem --value(--color-*);
}
```

This will match utilities like `glow-blue-500` from the default palette and `glow-avocado-500` from your custom theme:

```html
<!-- [!code filename:HTML] -->
<!-- [!code classes:glow-blue-500,glow-avocado-500] -->
<div class="glow-blue-500 ...">...</div>
<div class="glow-avocado-500 ...">...</div>
```

#### Bare values

To resolve the value as a bare value, use the `--value({type})` syntax, where `{type}` is the data type you want to validate the bare value as:
Expand Down