Class ThemeManager

A class that provides theme management.

Implements

IThemeManager

Constructors

constructor

new ThemeManager(options: ThemeManager.IOptions): ThemeManager
Construct a new theme manager.
Parameters
- options: ThemeManager.IOptions
Returns ThemeManager
- Defined in packages/apputils/src/thememanager.ts:36

Properties

`Protected`translator

translator: ITranslator

Accessors

darkThemes

get darkThemes(): readonly string[]
Get the names of the dark themes.

Returns readonly string[]
Implementation of IThemeManager.darkThemes
- Defined in packages/apputils/src/thememanager.ts:111

lightThemes

get lightThemes(): readonly string[]
Get the names of the light themes.

Returns readonly string[]
Implementation of IThemeManager.lightThemes
- Defined in packages/apputils/src/thememanager.ts:102

preferredDarkTheme

get preferredDarkTheme(): string
Get the name of the preferred dark theme.

Returns string
Implementation of IThemeManager.preferredDarkTheme
- Defined in packages/apputils/src/thememanager.ts:73

preferredLightTheme

get preferredLightTheme(): string
Get the name of the preferred light theme.

Returns string
Implementation of IThemeManager.preferredLightTheme
- Defined in packages/apputils/src/thememanager.ts:66

preferredTheme

get preferredTheme(): null | string
Get the name of the preferred theme When adaptive-theme is disabled, get current theme; Else, depending on the system settings, get preferred light or dark theme.

Returns null | string
Implementation of IThemeManager.preferredTheme
- Defined in packages/apputils/src/thememanager.ts:82

theme

get theme(): null | string
Get the name of the current theme.

Returns null | string
Implementation of IThemeManager.theme
- Defined in packages/apputils/src/thememanager.ts:59

themeChanged

get themeChanged(): ISignal<this, IChangedArgs<string, null | string, string>>
A signal fired when the application theme changes.

Returns ISignal<this, IChangedArgs<string, null | string, string>>
Implementation of IThemeManager.themeChanged
- Defined in packages/apputils/src/thememanager.ts:120

themes

get themes(): readonly string[]
The names of the registered themes.

Returns readonly string[]
Implementation of IThemeManager.themes
- Defined in packages/apputils/src/thememanager.ts:95

Methods

decrFontSize

decrFontSize(key: string): Promise<void>
Decrease a font size w.r.t. its current setting or its value in the current theme.
Parameters
- key: string
  A Jupyterlab font size CSS variable, without the leading '--jp-'.
Returns Promise<void>
- Defined in packages/apputils/src/thememanager.ts:312

getCSS

getCSS(key: string): string
Get the value of a CSS variable from its key.
Parameters
- key: string
  A Jupyterlab CSS variable, without the leading '--jp-'.
Returns string
value - The current value of the Jupyterlab CSS variable
- Defined in packages/apputils/src/thememanager.ts:141

getDisplayName

getDisplayName(name: string): string
Get the display name of the theme.
Parameters
- name: string
Returns string
Implementation of IThemeManager.getDisplayName
- Defined in packages/apputils/src/thememanager.ts:364

incrFontSize

incrFontSize(key: string): Promise<void>
Increase a font size w.r.t. its current setting or its value in the current theme.
Parameters
- key: string
  A Jupyterlab font size CSS variable, without the leading '--jp-'.
Returns Promise<void>
- Defined in packages/apputils/src/thememanager.ts:302

isLight

isLight(name: string): boolean
Test whether a given theme is light.
Parameters
- name: string
Returns boolean
Implementation of IThemeManager.isLight
- Defined in packages/apputils/src/thememanager.ts:292

isSystemColorSchemeDark

isSystemColorSchemeDark(): boolean
Test if the system's preferred color scheme is dark

Returns boolean
- Defined in packages/apputils/src/thememanager.ts:127

isToggledAdaptiveTheme

isToggledAdaptiveTheme(): boolean
Test if the user enables adaptive theme.

Returns boolean
- Defined in packages/apputils/src/thememanager.ts:347

isToggledThemeScrollbars

isToggledThemeScrollbars(): boolean
Test if the user has scrollbar styling enabled.

Returns boolean
- Defined in packages/apputils/src/thememanager.ts:330

loadCSS

loadCSS(path: string): Promise<void>
Load a theme CSS file by path.
Parameters
- path: string
  The path of the file to load.
Returns Promise<void>
Implementation of IThemeManager.loadCSS
- Defined in packages/apputils/src/thememanager.ts:153

loadCSSOverrides

loadCSSOverrides(): void
Loads all current CSS overrides from settings. If an override has been removed or is invalid, this function unloads it instead.

Returns void
- Defined in packages/apputils/src/thememanager.ts:183

register

register(theme: ITheme): 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.
Implementation of IThemeManager.register
- Defined in packages/apputils/src/thememanager.ts:243

setCSSOverride

setCSSOverride(key: string, value: string): Promise<void>
Add a CSS override to the settings.
Parameters
- key: string
- value: string
Returns Promise<void>
- Defined in packages/apputils/src/thememanager.ts:261

setPreferredDarkTheme

setPreferredDarkTheme(name: string): Promise<void>
Set the preferred dark theme.
Parameters
- name: string
Returns Promise<void>
- Defined in packages/apputils/src/thememanager.ts:285

setPreferredLightTheme

setPreferredLightTheme(name: string): Promise<void>
Set the preferred light theme.
Parameters
- name: string
Returns Promise<void>
- Defined in packages/apputils/src/thememanager.ts:278

setTheme

setTheme(name: string): Promise<void>
Set the current theme.
Parameters
- name: string
Returns Promise<void>
Implementation of IThemeManager.setTheme
- Defined in packages/apputils/src/thememanager.ts:271

themeScrollbars

themeScrollbars(name: string): boolean
Test whether a given theme styles scrollbars, and if the user has scrollbar styling enabled.
Parameters
- name: string
Returns boolean
Implementation of IThemeManager.themeScrollbars
- Defined in packages/apputils/src/thememanager.ts:320

toggleAdaptiveTheme

toggleAdaptiveTheme(): Promise<void>
Toggle the adaptive-theme setting.

Returns Promise<void>
- Defined in packages/apputils/src/thememanager.ts:354

toggleThemeScrollbars

toggleThemeScrollbars(): Promise<void>
Toggle the theme-scrollbars setting.

Returns Promise<void>
- Defined in packages/apputils/src/thememanager.ts:337

validateCSS

validateCSS(key: string, val: string): boolean
Validate a CSS value w.r.t. a key
Parameters
- key: string
  A Jupyterlab CSS variable, without the leading '--jp-'.
- val: string
  A candidate CSS value
Returns boolean
- Defined in packages/apputils/src/thememanager.ts:212