Class ThemeManager

A class that provides theme management.

Hierarchy

  • ThemeManager

Implements

Constructors

constructor

Properties

_base _current _host _incrFontSize _initOverrideProps _links _loadSettings _loadTheme _onError _outstanding _overrideProps _overrides _pending _requests _settings _splash _themeChanged _themes _trans translator

Accessors

darkThemes lightThemes preferredDarkTheme preferredLightTheme preferredTheme theme themeChanged themes

Methods

decrFontSize getCSS getDisplayName incrFontSize isLight isSystemColorSchemeDark isToggledAdaptiveTheme isToggledThemeScrollbars loadCSS loadCSSOverrides register setCSSOverride setPreferredDarkTheme setPreferredLightTheme setTheme themeScrollbars toggleAdaptiveTheme toggleThemeScrollbars validateCSS

Constructors

constructor

Properties

Private _base

_base: any

Private _current

_current: any

Private _host

_host: any

Private _incrFontSize

_incrFontSize: any

Change a font size by a positive or negative increment.

Private _initOverrideProps

_initOverrideProps: any

Initialize the key -> property dict for the overrides

Private _links

_links: any

Private _loadSettings

_loadSettings: any

Handle the current settings.

Private _loadTheme

_loadTheme: any

Load the theme.

Notes

This method assumes that the theme exists.

Private _onError

_onError: any

Handle a theme error.

Private _outstanding

_outstanding: any

Private _overrideProps

_overrideProps: any

Private _overrides

_overrides: any

Private _pending

_pending: any

Private _requests

_requests: any

Private _settings

_settings: any

Private _splash

_splash: any

Private _themeChanged

_themeChanged: any

Private _themes

_themes: any

Private _trans

_trans: any

Protected translator

translator: ITranslator

Accessors

darkThemes

  • get darkThemes(): readonly string[]

  • Get the names of the dark themes.

    Returns readonly string[]

lightThemes

  • get lightThemes(): readonly string[]

  • Get the names of the light themes.

    Returns readonly string[]

preferredDarkTheme

  • get preferredDarkTheme(): string

  • Get the name of the preferred dark theme.

    Returns string

preferredLightTheme

  • get preferredLightTheme(): string

  • Get the name of the preferred light theme.

    Returns string

preferredTheme

  • get preferredTheme(): 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 string

theme

  • get theme(): string

  • Get the name of the current theme.

    Returns string

themeChanged

  • get themeChanged(): ISignal<this, IChangedArgs<string, string, string>>

  • A signal fired when the application theme changes.

    Returns ISignal<this, IChangedArgs<string, string, string>>

themes

  • get themes(): readonly string[]

  • The names of the registered themes.

    Returns readonly string[]

Methods

decrFontSize

  • 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>

getCSS

  • 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

getDisplayName

  • Get the display name of the theme.

    Parameters

    • name: string

    Returns string

incrFontSize

  • 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>

isLight

  • Test whether a given theme is light.

    Parameters

    • name: string

    Returns boolean

isSystemColorSchemeDark

  • Test if the system's preferred color scheme is dark

    Returns boolean

isToggledAdaptiveTheme

  • Test if the user enables adaptive theme.

    Returns boolean

isToggledThemeScrollbars

  • Test if the user has scrollbar styling enabled.

    Returns boolean

loadCSS

  • Load a theme CSS file by path.

    Parameters

    • path: string

      The path of the file to load.

    Returns Promise<void>

loadCSSOverrides

  • Loads all current CSS overrides from settings. If an override has been removed or is invalid, this function unloads it instead.

    Returns void

register

  • 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.

setCSSOverride

  • Add a CSS override to the settings.

    Parameters

    • key: string
    • value: string

    Returns Promise<void>

setPreferredDarkTheme

  • Set the preferred dark theme.

    Parameters

    • name: string

    Returns Promise<void>

setPreferredLightTheme

  • Set the preferred light theme.

    Parameters

    • name: string

    Returns Promise<void>

setTheme

  • Set the current theme.

    Parameters

    • name: string

    Returns Promise<void>

themeScrollbars

  • Test whether a given theme styles scrollbars, and if the user has scrollbar styling enabled.

    Parameters

    • name: string

    Returns boolean

toggleAdaptiveTheme

  • Toggle the adaptive-theme setting.

    Returns Promise<void>

toggleThemeScrollbars

  • Toggle the theme-scrollbars setting.

    Returns Promise<void>

validateCSS

  • 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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc