Documentation map
New to Runway UI? Follow Install → Components → Compose. Use Storybook when you want to experiment with component arguments; use the guides for markup, requirements and behavior contracts.
1. Install and understand the basics
- Installation and first component: load the bundle and add a
rw-uiroot. - Interactive Recipe book: edit a mission card, resource HUD or native dialog and copy its HTML.
- Component guide: the core markup patterns.
- Themes and tokens: theme, density, depth and material.
- Compatibility policy: the semantic-versioning contract.
2. Find a component or behavior
| Need | Read | Try |
|---|---|---|
| Classes, options and defaults | API overview | Searchable component reference |
| Inputs, selects and validation | Fields | Native controls example |
| Dialog structure and dismissal | Dialog | Storybook dialog |
| Icons and weights | Icons | Component reference |
| Charts and numeric scales | Charts | Chart lab |
| Keyboard navigation, inventories and lifecycle | Interactions | Inventory example |
- Component dependency map: exact isolated CSS imports and copyable minimal markup.
3. Compose an interface
Design and usage review: composition rules and twelve focused checks.
Desktop workspaces: command bars, folio navigation, dossier rows and control consoles.
Modern CSS and browser capabilities, with the shared-track layout example.
Simulation Observatory guide, with the complete screen.
Workshop: a management interface assembled from the library.
Project reference
- Storybook workflow: local development and argument-driven stories.
- Status and verification limits: implemented scope and recorded checks.
- Changelog: release and migration history.
- Migrating to the React API: replacements for each vanilla behavior.
- Release checklist: validation, source builds, Pages and package publication.
- Source ownership and CI and ten-pass audit.
- Contributing and source layout: where to make changes.
Source Markdown guides live alongside the interactive documentation. The site build renders them as HTML and rewrites their guide links. Existing guide filenames remain stable so external links continue working.
- Generated types and behavior ownership: source of truth, consumer contracts and module map.
For scoped keyboard/controller input, see Game input. For reproducible busy-screen measurements, see Performance.