IDefaultProviderProps
interface
Theme & Defaults
Props for OrigamDefaultsProvider — a structurally transparent wrapper that injects per-component prop defaults into a subtree. Supports disabled pass-through, reset/root scoping and fully scoped isolation.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- defaultsIDefault
- Map of default props, keyed by "global" or component name (e.g. "origam-btn").
- disabledboolean
- When true, parent defaults pass through unchanged — useful to temporarily disable an outer provider.
- resetstring | number
- When set, parent defaults are NOT inherited; the subtree starts only from this provider. The value is opaque but visible in DevTools.
- rootstring | number
- Marks this provider as the root of a defaults tree — equivalent to reset in behaviour but communicates a different intent.
- scopedboolean
- When true, parent defaults are not merged in — the subtree only sees this provider's defaults.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Scoped defaults for a form section