AdaptableTheme

Used for creating User (i.e. Custom) Themes

export interface AdaptableTheme extends

Extends

AdaptableObject

Properties

Property Details

AgGridClassName

Ag Grid theme to apply when loading theme; relevant only when using the legacy AG Grid themes

AgGridClassName?: string;

Deprecated

no longer used with the new AG Grid Theming API

Property Value

string

AgThemeMode

AG Grid theme mode to apply when this theme is selected. Valid values are light, dark, dark-blue or any custom theme mode defined in AG Grid. When set, adds a data-ag-theme-mode attribute to the document body.

AgThemeMode?: TypeHint<string, 'light' | 'dark' | 'dark-blue'>;

Property Value

TypeHint<string, 'light' | 'dark' | 'dark-blue'>

CSSVariables

Variables to be applied at runtime

CSSVariables?: Record<string, string>;

Property Value

Record<string, string>

Description

Description of Theme - will appear in Theme Toolbar and Toolpanel

Description: string;

Property Value

string

Name

Name of the Theme as it appears in the Theme toolbar and tool panel

Name: string;

Property Value

string

Variant

Base theme variant to derive custom theme from. Use light to inherit from Adaptable Light Theme or dark for Adaptable Dark Theme. When creating custom themes, specifying a variant ensures proper inheritance of base theme styles.

Variant?: 'light' | 'dark';

Property Value

'light' | 'dark'

IsReadOnly

Inherited from AdaptableObject

Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')

IsReadOnly?: boolean;

Property Value

boolean