IOrigamOptions
interface
Plugin & Configuration
Root configuration bag passed to `createOrigam()`. Covers component aliases, icon adapter, display breakpoints, SSR, navigation, date adapter, locale/RTL, a11y contrast guard and runtime theme injection.
TypeScript
Définition
La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.
API
Propriétés
Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.
- aliasesany
- Map of component name aliases. Allows registering a component under a different name globally.
- blueprintIBlueprint
- Preset of options that acts as a base layer — useful to ship a brand configuration that consumers can then override.
- componentsany
- Component overrides or additional components to register globally at plugin install time.
- directivesany
- Custom directives to register globally alongside the built-in Origam directives.
- iconsTIconOptions
- Icon adapter configuration — selects the icon set (MDI, FA, custom SVG) and registers aliases.
- displayIDisplayOptions
- Responsive breakpoint thresholds used by the `useDisplay()` composable and `v-display` directive.
- ssrTSSROptions
- Server-side rendering hints passed to components that need to know the initial client dimensions before hydration.
- goToIGoToOptions
- Default easing and duration for the `useGoTo()` scroll-to utility.
- dateIDateOptions
- Date adapter registration used by date-picker and calendar components.
- localeILocaleOptions & IRtlOptions
- Global locale configuration — active locale, fallback locale, message dictionary and optional RTL per-locale map.
- contrastboolean | IContrastOptions
- Runtime WCAG text-contrast guard. `true` (default) enables the check; `false` disables it; an object tunes the minimum contrast threshold.
- themeIOrigamTheme
- Single runtime theme injected into <head> at install time as a scoped block of --origam-* CSS variables. SSR-safe.
- themesIOrigamTheme[]
- Additional named runtime themes installed together. Each is injected as its own scoped CSS variable block and exposed via useInstalledThemes().
- codeICodeOptions
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
Configuring the plugin with createOrigam