Type Alias AppThemeApi

The AppThemeApi gives access to the current app theme, and allows switching to other options that have been registered as a part of the App.

type AppThemeApi = {
    activeThemeId$(): Observable<string | undefined>;
    getActiveThemeId(): string | undefined;
    getInstalledThemes(): AppTheme[];
    setActiveThemeId(themeId?: string): void;
}

Implemented by

AppThemeSelector

Index

Methods

activeThemeId$ getActiveThemeId getInstalledThemes setActiveThemeId

Methods

activeThemeId$

activeThemeId$(): Observable<string | undefined>
Observe the currently selected theme. A value of undefined means no specific theme has been selected.

Returns Observable<string | undefined>
- Defined in packages/frontend-plugin-api/src/apis/definitions/AppThemeApi.ts:65

getActiveThemeId

getActiveThemeId(): string | undefined
Get the current theme ID. Returns undefined if no specific theme is selected.

Returns string | undefined
- Defined in packages/frontend-plugin-api/src/apis/definitions/AppThemeApi.ts:70

getInstalledThemes

getInstalledThemes(): AppTheme[]
Get a list of available themes.

Returns AppTheme[]
- Defined in packages/frontend-plugin-api/src/apis/definitions/AppThemeApi.ts:60

setActiveThemeId

setActiveThemeId(themeId?: string): void
Set a specific theme to use in the app, overriding the default theme selection.

Clear the selection by passing in undefined.
Parameters
- OptionalthemeId: string
Returns void
- Defined in packages/frontend-plugin-api/src/apis/definitions/AppThemeApi.ts:77