Up and runningin minutes.
Install origam, register the plugin, and start building with 218 accessible, token-driven Vue 3 components right away.
STEP BY STEP
Five steps.You're set.
From zero to a fully themed Vue 3 app with origam — no boilerplate needed.
1. Install
Add origam to your project with your preferred package manager.
2. Register the plugin
Import the token sheets and register origam as a Vue plugin in your entry file.
main.ts createOrigam() accepts an optional options bag to configure icons, locale, display, SSR, aliases and more. By default, all components and directives are registered globally — but no theme is installed until you pass one explicitly, as shown above.
3. Use a component
All components are globally registered. Drop any Origam component into your templates — no per-file import needed.
App.vue 4. Theming
origam ships with light and dark themes. Switch statically via an HTML attribute, or at runtime with the useTheme composable.
Static switch — HTML attribute (omit to follow system preference):
index.html Runtime switch — useTheme composable:
ts Scoped sub-tree override:
vue Import origam/tokens/css/dark once at boot to enable the dark token sheet.
5. Nuxt integration
Using Nuxt 3 or Nuxt 4? The official origam Nuxt module is included in the same package — no extra install required.
nuxt.config.ts The Nuxt module is delivered as a sub-export (origam/nuxt) — no separate package to install. It auto-imports all components and composables, and resolves themes SSR-safely.
REQUIREMENTS
Peer dependencies.
origam has a minimal footprint. Vue 3 is the only mandatory peer — everything else is optional and tree-shaken when unused.
| Package | Required | Used by |
|---|---|---|
| | Always — core runtime |
| | Optional — locale composable |
| | Optional — link components |
Node >= 22 is required to build origam from source. Consumers need only Vue 3.5+ at runtime.
Ready to build?
Explore the full component catalogue, browse interactive stories, or dive into the source on GitHub.