Skip to content

docs(contributing): note when items.color is required #37

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

Merged
IgorShevchik merged 1 commit into from
May 13, 2026
+12 −0
Merged

docs(contributing): note when items.color is required #37

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
12 changes: 12 additions & 0 deletions .github/contributing/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,18 @@ slots:
::
```

::note
**Required when the prop type is referenced from another component**
(e.g. `color?: AvatarProps['color']`). The docs generator resolves the
palette from the host theme's own `variants.color`, so a prop typed via
another component cannot auto-fill the dropdown. Spell the items out
under `items.color` to render the selector.

See [`docs/content/docs/2.components/user.md`](../../docs/content/docs/2.components/user.md) and
[`docs/content/docs/2.components/error.md`](../../docs/content/docs/2.components/error.md) for
canonical usage in their `### Color` sections.
::

## Component Examples

For complex examples with setup code:
Expand Down