ILocaleProps
interface
Locale & i18n
Per-instance locale override — messages, active locale, fallback locale and an optional adapter instance. Components consuming this interface honour a sub-tree locale without requiring a global store mutation.
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.
- messagesILocaleMessages
- Flat or nested message map to merge with the global locale messages for this component sub-tree.
- localestring
- BCP-47 language tag that overrides the active global locale for this component (e.g. "fr", "en-US").
- fallbackstring
- BCP-47 language tag used when a translation key is not found in the active locale.
- adapterILocaleInstance
- Custom locale adapter instance. When provided, it replaces the global adapter for this component and all its descendants.
Usage
Examples
Ready-to-paste code snippets using this interface.
Overriding locale on a specific component