# Octans UI

> An opinionated Vue 3 component library: accessible, themeable UI primitives and the application shell pieces (nav, frame, sheets, toasts) that usually get rebuilt from scratch in every project.

Everything below is plain markdown. The component browser at https://octans.dev/storybook/ is a single-page app, so fetching one of its `?path=` URLs returns the shell rather than the page — read these files instead, and use Storybook for live examples.

## Documentation

- [Quick start](https://octans.dev/llms/quick-start.md): Install, UiProvider setup, theming, icons and i18n
- [Design tokens](https://octans.dev/llms/design-tokens.md): The three-tier token system and every semantic token
- [Colour system](https://octans.dev/llms/color-system.md): How the ramps, roles and dark theme are derived
- [Global UI ($ui)](https://octans.dev/llms/global-ui.md): Toasts, modals, the loader overlay and the save bar
- [Translations](https://octans.dev/llms/translations.md): Registering dictionaries and switching locale
- [Overview](https://octans.dev/llms/overview.md): What the library is, and the project layout
- [Agent skill](https://octans.dev/llms/agent-skill.md): The same guidance packaged as an Agent Skill, including the inheritance traps that break dark mode

## Reference

- [Component list](https://octans.dev/llms/components.md): Every exported component, generated from the package barrel

## Optional

- [Storybook](https://octans.dev/storybook/): live component browser, prop tables and the interactive theme builder (renders with JavaScript)
- [Source](https://github.com/tarwin/octans-ui): issues and pull requests welcome