Documentation
A map of the sections and three routes through them: ship today, understand the design, look up an answer.
Machine-translated, not yet reviewed. Read the original
The documentation falls into three parts, and the one to start with is the one that matches your question.
Ship today
The path from an empty directory to a working component:
- Getting started — install, configure, first component. The shortest useful page on this site.
- Installation — what goes where and why, icons, optional integrations.
- Configuration — defaults for a subtree, auto-import, the runtime adapter.
If something went wrong, start with troubleshooting: nearly everything at the entrance is a forgotten CSS import, a preset config that disagrees with itself, or a missing peer dependency.
Understand the design
- Introduction — what this is and the one decision that shapes everything else.
- Theming — roles instead of hex codes, your own theme, switching at runtime.
- Performance — what granularity is measured in and how to verify it yourself.
- Architecture — why the exports are arranged the way they are.
Look up an answer
| Question | Page |
|---|---|
| Which keys a component takes, what happens to focus and to a screen reader | Accessibility |
| Whether this works on the server and what arrives from it | SSR |
| How to wire translations up and how many languages the library speaks | Localization |
| Where the types come from and why the compiler cannot see them | TypeScript |
| What to test with and what jsdom cannot check | Testing |
| How long this version will live and what happens at 1.0 | Versioning |
| How to move over from another library | Migrating from… |
What lives elsewhere
- Components — in the catalogue: every one has its own page with a preview, a playground, examples and an API table.
- Tokens and the visual language — in foundations.
- Composables, directives, utilities — in the reference.
- What changed between versions — in the changelog.