Namespace: Themes
January 18, 2022 · View on GitHub
Kui API Documentation - v11.0.0 / @kui-shell/core / Themes
Namespace: Themes
@kui-shell/core.Themes
Table of contents
Interfaces
Type aliases
Functions
Type aliases
Theme
Ƭ Theme: ThemeProperties & { apiVersion?: ThemeApiVersion ; attrs?: string[] ; css: string | string[] ; description?: string ; lightweight?: boolean ; name: string ; style: "light" | "dark" }
Defined in
packages/core/src/webapp/themes/Theme.ts:29
Functions
findThemeByName
▸ findThemeByName(name): Promise<{ plugin: string ; theme: Theme }>
Parameters
| Name | Type |
|---|---|
name | string |
Returns
Promise<{ plugin: string ; theme: Theme }>
the Theme model associated with the given theme name
Defined in
packages/core/src/webapp/themes/find.ts:25
getDefaultTheme
▸ getDefaultTheme(): Promise<string>
Returns
Promise<string>
the name of the default theme
Defined in
packages/core/src/webapp/themes/default.ts:27
getPersistedThemeChoice
▸ Const getPersistedThemeChoice(): Promise<string>
Return the previously selected (and persisted) choice of theme
Returns
Promise<string>
Defined in
packages/core/src/webapp/themes/persistence.ts:41
resetToDefaultTheme
▸ Const resetToDefaultTheme(): Promise<boolean>
Reset to the default theme
Returns
Promise<boolean>
Defined in
packages/core/src/webapp/themes/persistence.ts:188
switchToTheme
▸ Const switchToTheme(theme, saveNotNeeded?): Promise<void>
Internal logic to switch themes
Parameters
| Name | Type | Default value |
|---|---|---|
theme | string | undefined |
saveNotNeeded | boolean | false |
Returns
Promise<void>