TTheme

type
Theme & Tokens

Runtime brand name applied to the <html data-theme="…"> attribute or to a sub-tree via OrigamThemeProvider. Orthogonal to the light/dark mode axis.

TypeScript

Definition

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

typescript

Accepted

Values

Accepted string literal values for this type. Click a value to copy it.

auto
No data-theme attribute is set. Children resolve against the closest ancestor theme, or the default brand at the document root.
TAnyString
dark
Legacy alias kept for backwards compatibility. As of the two-axis model, prefer setting mode="dark" on OrigamThemeProvider.
light
Legacy alias kept for backwards compatibility — was the default brand before the two-axis theming model.
(custom string)
Any other string is treated as a custom brand theme (e.g. "sobre", "brand-a"). The matching CSS token file must be loaded by the consumer.

Ecosystem

Used by

Components and props that accept this type as a value.

Usage

Examples

Ready-to-paste code snippets using this type.

Sub-tree with a custom brand theme

html