Interface IThemeManager

An interface for a theme manager.

interface IThemeManager {
    darkThemes?: readonly string[];
    lightThemes?: readonly string[];
    preferredDarkTheme?: string;
    preferredLightTheme?: string;
    preferredTheme?: null | string;
    theme: null | string;
    themeChanged: ISignal<
        IThemeManager,
        IChangedArgs<string, null | string, string>,
    >;
    themes: readonly string[];
    getDisplayName(name: string): string;
    isLight(name: string): boolean;
    loadCSS(path: string): Promise<void>;
    register(theme: ITheme): IDisposable;
    setTheme(name: string): Promise<void>;
    themeScrollbars(name: string): boolean;
}

Implemented by

Properties

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

Methods

getDisplayName isLight loadCSS register setTheme themeScrollbars

Properties

Optional ReadonlydarkThemes

darkThemes?: readonly string[]

Get the names of the registered dark themes.

Optional ReadonlylightThemes

lightThemes?: readonly string[]

Get the names of the registered light themes.

Optional ReadonlypreferredDarkTheme

preferredDarkTheme?: string

Get the name of the preferred dark theme.

Optional ReadonlypreferredLightTheme

preferredLightTheme?: string

Get the name of the preferred light theme.

Optional ReadonlypreferredTheme

preferredTheme?: null | string

Get the name of the preferred theme.

Readonlytheme

theme: null | string

Get the name of the current theme.

ReadonlythemeChanged

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

A signal fired when the application theme changes.

Readonlythemes

themes: readonly string[]

The names of the registered themes.

Methods

getDisplayName

isLight

loadCSS

register

setTheme

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

Settings

Member Visibility

On This Page

Properties
Methods