Interface IThemeManager

An interface for a theme manager.

Hierarchy

  • IThemeManager

Properties

darkThemes? lightThemes? preferredDarkTheme? preferredLightTheme? preferredTheme? theme themeChanged themes

Methods

getDisplayName isLight loadCSS register setTheme themeScrollbars

Properties

Optional Readonly darkThemes

darkThemes?: readonly string[]

Get the names of the registered dark themes.

Optional Readonly lightThemes

lightThemes?: readonly string[]

Get the names of the registered light themes.

Optional Readonly preferredDarkTheme

preferredDarkTheme?: string

Get the name of the preferred dark theme.

Optional Readonly preferredLightTheme

preferredLightTheme?: string

Get the name of the preferred light theme.

Optional Readonly preferredTheme

preferredTheme?: string

Get the name of the preferred theme.

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

  • Get display name for theme.

    Parameters

    • name: string

    Returns string

isLight

  • Test whether a given theme is light.

    Parameters

    • name: string

    Returns boolean

loadCSS

  • Load a theme CSS file by path.

    Parameters

    • path: string

      The path of the file to load.

    Returns Promise<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.

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc