Class ColorThemes

The color themes atom.

Hierarchy (view full)

Implements

  • IColorThemes

Properties

defaultTheme key name required

Methods

addDependency createTheme getDefaultTheme getDefaultThemeName getDesignSystem getTheme getThemeNames getThemes getUninitializedRequiredProperties isEnabled isInitialized removeAllListeners removeListener setDefaultTheme setListener store

Properties

ReadonlydefaultTheme

defaultTheme: PropertyStringSelectable

The default theme name property

Readonlykey

key: string

The unique key for the node. It is unique from all other nodes in the ThemeBuilder

Readonlyname

name: string

The name of the node, which is unique relative to it's siblings

Readonlyrequired

required: boolean

Is this a required atom?

Methods

addDependency

createTheme

  • createTheme(name, skipInitDefault?): ColorTheme

  • Create a new color theme.

    Parameters

    • name: string

      The name of the theme to create.

    • OptionalskipInitDefault: boolean

      If true, do not attempt to set this as the default theme if there is not yet a default theme.

    Returns ColorTheme

    The newly created theme.

getDefaultTheme

getDefaultThemeName

  • getDefaultThemeName(): undefined | string

  • Get the default theme name (if any).

    Returns undefined | string

    The default theme name (if any).

getDesignSystem

getTheme

getThemeNames

  • getThemeNames(): string[]

  • Get the names of all themes.

    Returns string[]

    The names of all existing themes.

getThemes

getUninitializedRequiredProperties

isEnabled

  • isEnabled(): boolean

  • Determine if this node is enabled. A node is enabled if all other nodes on which this node depends have been initialized.

    Returns boolean

    True if enabled, or false otherwise.

isInitialized

  • isInitialized(): boolean

  • Determine if this node is initialized.

    If this node is a property, it is initialized if it is not required to have a value, or if it is required and has either a default or non-default value.

    Returns boolean

    True if initialized, or false otherwise.

removeAllListeners

removeListener

  • removeListener(name): void

  • Remove a listener by name.

    Parameters

    • name: string

      The name of the listener to remove

    Returns void

setDefaultTheme

setListener

  • setListener(name, callback, eventTypes?): ListenerSubscription

  • Set a listener on this node

    Parameters

    • name: string

      The name of the listener.

    • callback: EventCallback

      The callback to call when an event occurs.

    • OptionaleventTypes: EventType[]

      The types of events to wait for. If none are specified, listen for all events.

    Returns ListenerSubscription

    The ListenerSubscription which should be canceled to stop listening.

store

Settings

Member Visibility

On This Page

Properties
Methods