Interface ThemeApi

interface ThemeApi {
    getGeneratedPalettes(): Promise<GeneratedPalettes>;
    getSelectedScheme(): Promise<ColorSchemeOptionType>;
    getThemes(): Promise<CustomThemes>;
    setSelectedScheme(newScheme: ColorSchemeOptionType): Promise<void>;
}

Index

Methods

getGeneratedPalettes getSelectedScheme getThemes setSelectedScheme

Methods

getGeneratedPalettes

getGeneratedPalettes(): Promise<GeneratedPalettes>
Get the generated palettes from the platform provider.

Returns Promise<GeneratedPalettes>
the generated palettes.

getSelectedScheme

getSelectedScheme(): Promise<ColorSchemeOptionType>
Get the selected scheme from the platform provider.

Returns Promise<ColorSchemeOptionType>
the selected scheme.

getThemes

getThemes(): Promise<CustomThemes>
Returns Promise<CustomThemes>
the legacy themes or null if the platform provider is using the new theme system.

Deprecated
This method is deprecated. It is recommended to use getGeneratedPalettes instead. Get the legacy themes from the platform provider.

setSelectedScheme

setSelectedScheme(newScheme): Promise<void>
Set the selected scheme for the platform provider.
Parameters
- newScheme: ColorSchemeOptionType
  the new scheme to set.
Returns Promise<void>