IRtlOptions

interface
Locale & RTL

Install-time RTL configuration merged into the locale options of createOrigam(). Maps locale codes to a boolean indicating whether that locale is right-to-left.

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.

rtl
Record<string, boolean>
Map of locale code → is-RTL, e.g. { ar: true, he: true }. Merged with built-in defaults at plugin install time.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Passing RTL options to createOrigam

typescript