Class ThemeManager

A class that provides theme management.

Implements

IThemeManager

Constructors

constructor

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

Properties

`Private` _base

_base: string

`Private` _current

_current: null | string = null

`Private` _host

_host: Widget

`Private` _links

_links: HTMLLinkElement[] = []

`Private` _outstanding

_outstanding: null | Promise<void> = null

`Private` _overrideProps

_overrideProps: Dict<string> = {}

`Private` _overrides

_overrides: Dict<string> = {}

`Private` _pending

_pending: number = 0

`Private` _requests

_requests: {
[theme: string]: number;
} = {}

Type declaration

[theme: string]: number

`Private` _settings

_settings: ISettingRegistry.ISettings<ReadonlyPartialJSONObject>

`Private` _splash

_splash: null | ISplashScreen

`Private` _themeChanged

_themeChanged: Signal<ThemeManager, IChangedArgs<string, null | string, string>> = ...

`Private` _themes

_themes: {
[key: string]: ITheme;
} = {}

Type declaration

[key: string]: ITheme

`Private` _trans

_trans: IRenderMime.TranslationBundle

`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

`Private` _incrFontSize

_incrFontSize(key, add?): Promise<void>
Change a font size by a positive or negative increment.
Parameters
- key: string
- add: boolean = true
Returns Promise<void>
- Defined in packages/apputils/src/thememanager.ts:371

`Private` _initOverrideProps

_initOverrideProps(): void
Initialize the key -> property dict for the overrides

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

`Private` _loadSettings

_loadSettings(): void
Handle the current settings.

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

`Private` _loadTheme

_loadTheme(theme): Promise<void>
Load the theme.

Notes
This method assumes that the theme exists.
Parameters
- theme: string
Returns Promise<void>
- Defined in packages/apputils/src/thememanager.ts:493

`Private` _onError

_onError(reason): void
Handle a theme error.
Parameters
- reason: any
Returns void
- Defined in packages/apputils/src/thememanager.ts:549

decrFontSize

decrFontSize(key): 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
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
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): 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): 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): 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): 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, value): 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): Promise<void>
Set the preferred dark theme.
Parameters
- name: string
Returns Promise<void>
- Defined in packages/apputils/src/thememanager.ts:285

setPreferredLightTheme

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

setTheme

setTheme(name): 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): 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, val): 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