Interface IThemeManager

An interface for a theme manager.

Hierarchy

IThemeManager

Index

Properties

theme themeChanged themes

Methods

getDisplayName isLight loadCSS register setTheme themeScrollbars

Properties

`Readonly` theme

theme: string

Get the name of the current theme.

`Readonly` themeChanged

themeChanged: ISignal<IThemeManager, IChangedArgs<string, string, string>>

A signal fired when the application theme changes.

`Readonly` themes

themes: readonly string[]

The names of the registered themes.

Methods

getDisplayName

getDisplayName(name): string
Get display name for theme.
Parameters
- name: string
Returns string
- Defined in packages/apputils/lib/tokens.d.ts:114

isLight

isLight(name): boolean
Test whether a given theme is light.
Parameters
- name: string
Returns boolean
- Defined in packages/apputils/lib/tokens.d.ts:105

loadCSS

loadCSS(path): Promise<void>
Load a theme CSS file by path.
Parameters
- path: string
  
  The path of the file to load.
Returns Promise<void>
- Defined in packages/apputils/lib/tokens.d.ts:89

register

register(theme): IDisposable
Register a theme with the theme manager.
Parameters
- theme: ITheme
  
  The theme to register.
Returns IDisposable
A disposable that can be used to unregister the theme.
- Defined in packages/apputils/lib/tokens.d.ts:97

setTheme

setTheme(name): Promise<void>
Set the current theme.
Parameters
- name: string
Returns Promise<void>
- Defined in packages/apputils/lib/tokens.d.ts:101

themeScrollbars

themeScrollbars(name): boolean
Test whether a given theme styles scrollbars, and if the user has scrollbar styling enabled.
Parameters
- name: string
Returns boolean
- Defined in packages/apputils/lib/tokens.d.ts:110

Generated using TypeDoc