IDashboardThemingProps
export interface IDashboardThemingProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (Optional) When true, disables the loading of the workspace theme and creation of a ThemeProvider (if there is none already present in the parent scope). | ||
(Optional) Theme to use. | |||
(Optional) If provided it is called with loaded theme to allow its modification according to the app needs. |
Property details
IDashboardThemingProps.disableThemeLoadingproperty
When true, disables the loading of the workspace theme and creation of a ThemeProvider (if there is none already present in the parent scope).
disableThemeLoading?: boolean;
Remarks
Currently – for technical reasons – the ThemeProvider changes the theme globally (i.e. the theme is NOT constrained inside of a ThemeProvider).
Turn this property to true if you need to avoid the global aspect of the themes, or you do not want to use themes at all.
Defaults to false.
IDashboardThemingProps.themeproperty
Theme to use.
theme?: ITheme;
Remarks
Note: the theme can come either from this property or from ThemeContext or from the dashboard. If you do not specify theme here, it will be taken from an existing ThemeContext or if there is no ThemeContext, it will be loaded for the dashboard.
IDashboardThemingProps.themeModifierproperty
If provided it is called with loaded theme to allow its modification according to the app needs.
themeModifier?: (theme: ITheme) => ITheme;
Remarks
This is only applied to themes loaded from the backend, it is NOT applied to themes provided using the “theme” prop.