Interface ThemeOptions

interface ThemeOptions {
    cssBaseline?: boolean;
    dark?: Theme;
    defaultMode?: ThemeMode;
    forceLightGrid?: boolean;
    forceLightImages?: boolean;
    forceMode?: string;
    light?: Theme;
    onForceLightGridChange?: ((force) => void);
    onForceLightImagesChange?: ((force) => void);
    onForceModeChange?: ((mode) => void);
}

Properties

cssBaseline? dark? defaultMode? forceLightGrid? forceLightImages? forceMode? light? onForceLightGridChange? onForceLightImagesChange? onForceModeChange?

Properties

Optional cssBaseline

cssBaseline?: boolean

When theming also apply the MUI CssBaseline.

Default Value

false

Optional dark

dark?: Theme

Default Value

Exhibit Dark Theme

Optional defaultMode

defaultMode?: ThemeMode

Default Value

light

Optional forceLightGrid

forceLightGrid?: boolean

By default the the standalone workbook grid will be the same theme as the workbook. If forceGridLight is true then the grid will always use the light mode. This will cause the grid to have current Excel behavior (2023).

Remarks

When the grid has a dark theme it will attempt to use DocTheme dark colors but will 'force' non dark-themed colors to be light via an inversion algo.

Default Value

true

Optional forceLightImages

forceLightImages?: boolean

By default the the standalone workbook images will invert images if the grid is in dark mode.

Remarks

Default Value

false.

Optional forceMode

forceMode?: string

The user doesn't want to use the default

Default Value

null

Optional light

light?: Theme

Default Value

Exhibit Light Theme

Optional onForceLightGridChange

onForceLightGridChange?: ((force) => void)

Type declaration

    • (force): void

    • Parameters

      • force: boolean

      Returns void

Optional onForceLightImagesChange

onForceLightImagesChange?: ((force) => void)

Type declaration

    • (force): void

    • Parameters

      • force: boolean

      Returns void

Optional onForceModeChange

onForceModeChange?: ((mode) => void)

Called if the current mode changes for the AppTheme

Type declaration

    • (mode): void

    • Parameters

      Returns void

Remarks

This is only used if the themeOptions are not provided If null is sent then the theme should inherited

Settings

Member Visibility

Theme

On This Page

cssBaselinedarkdefaultModeforceLightGridforceLightImagesforceModelightonForceLightGridChangeonForceLightImagesChangeonForceModeChange