Reading the docs
Every component page follows the same layout.
Examples#
Each example renders live above its source. The source is the complete file, ready to copy. The file name links to it on GitHub.
Interactive playgrounds#
A playground renders a component next to a panel of options. Toggle the options to see each prop.
Props interfaces#
Props tables are generated from the TypeScript declarations.
| Part | Meaning |
|---|---|
name | The prop |
| type | Its TypeScript type |
= value | Its default |
| required | The prop has no default and must be set |
| Inherited from | The interface that declares it |
The import path on the right of a table shows where the component comes from.
Keyboard shortcuts#
| Keys | Action |
|---|---|
| Shift + S or Cmd + K | Search |
| Shift + D | Toggle dark mode |
| Shift + T | Switch to the next theme |
| ? | Show all shortcuts |