ThemeState

Theme section of Adaptable State

TypeScript
export interface ThemeState extends
Extends

BaseState

Properties

PropertyTypeDescription
CurrentThemeSystemThemeNameName of current Theme or theme set at startup; leave blank if using 'Light Theme', set to 'dark' for 'Dark Theme'
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

Name of current Theme or theme set at startup; leave blank if using 'Light Theme', set to 'dark' for 'Dark Theme'

TypeScript
CurrentTheme?: SystemThemeName;
Property Value

SystemThemeName

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.

Property Value

AdaptableTheme[]

PreviousThemeSelectedInfoNextToastPositions