ThemeState
Theme section of Adaptable State, including Initial State.
CurrentTheme is 'light' (the default), 'dark', or 'os'. SystemThemes limits which shipped themes are offered. Omit it to offer all of them.
TypeScript
export interface ThemeState extendsExtends
Properties
| Property | Type | Description |
|---|---|---|
| CurrentTheme | SystemThemeName | Shipped theme that is active: 'light', 'dark', or 'os' (follows the operating system). When omitted, the theme is 'light'. |
| SystemThemes | (SystemThemeEntry|AdaptableTheme)[] | Which shipped themes are available; pass theme name string, or { Name, AgThemeMode? } to pair a custom AG Grid theme mode; leave unset for all shipped themes |
Property Details
CurrentTheme
Shipped theme that is active: 'light', 'dark', or 'os' (follows the operating system). When omitted, the theme is 'light'.
TypeScript
CurrentTheme?: SystemThemeName;Property Value
SystemThemes
Which shipped themes are available; pass theme name string, or { Name, AgThemeMode? } to pair a custom AG Grid theme mode; leave unset for all shipped themes
TypeScript
SystemThemes?: (SystemThemeEntry | AdaptableTheme)[];Property Value
(SystemThemeEntry|AdaptableTheme)[]
UserThemes
Custom themes provided by developers (deprecated)
TypeScript
UserThemes?: AdaptableTheme[];Deprecated
Will be removed in next major version. Customise shipped light / dark themes via CSS variable overrides instead.