IRtlInstance
interface
Locale & RTL
Runtime RTL context returned by the locale composable. Exposes whether the current locale renders right-to-left and the per-locale RTL override map.
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.
- isRtlrequiredRef<boolean>
- Reactive flag — true when the active locale is right-to-left.
- rtlrequiredRef<Record<string, boolean>>
- Map of locale codes to their RTL status, merged from IRtlOptions at install time.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Reading the RTL flag from the locale composable