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

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

aliases
any
Map of component name aliases. Allows registering a component under a different name globally.
blueprint
IBlueprint
Preset of options that acts as a base layer — useful to ship a brand configuration that consumers can then override.
components
any
Component overrides or additional components to register globally at plugin install time.
directives
any
Custom directives to register globally alongside the built-in Origam directives.
icons
TIconOptions
Icon adapter configuration — selects the icon set (MDI, FA, custom SVG) and registers aliases.
display
IDisplayOptions
Responsive breakpoint thresholds used by the `useDisplay()` composable and `v-display` directive.
ssr
TSSROptions
Server-side rendering hints passed to components that need to know the initial client dimensions before hydration.
goTo
IGoToOptions
Default easing and duration for the `useGoTo()` scroll-to utility.
date
IDateOptions
Date adapter registration used by date-picker and calendar components.
locale
ILocaleOptions & IRtlOptions
Global locale configuration — active locale, fallback locale, message dictionary and optional RTL per-locale map.
contrast
boolean | IContrastOptions
Runtime WCAG text-contrast guard. `true` (default) enables the check; `false` disables it; an object tunes the minimum contrast threshold.
theme
IOrigamTheme
Single runtime theme injected into <head> at install time as a scoped block of --origam-* CSS variables. SSR-safe.
themes
IOrigamTheme[]
Additional named runtime themes installed together. Each is injected as its own scoped CSS variable block and exposed via useInstalledThemes().
code
ICodeOptions

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Configuring the plugin with createOrigam

typescript