Class ColorThemes

The color themes atom.

Hierarchy

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

Readonly defaultTheme

defaultTheme: PropertyStringSelectable

The default theme name property

Readonly key

key: string

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

Readonly name

name: string

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

Readonly required

required: boolean

Is this a required atom?

Methods

addDependency

createTheme

  • Create a new color theme.

    Returns

    The newly created theme.

    Parameters

    • name: string

      The name of the theme to create.

    • Optional skipInitDefault: boolean

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

    Returns ColorTheme

getDefaultTheme

getDefaultThemeName

  • Get the default theme name (if any).

    Returns

    The default theme name (if any).

    Returns undefined | string

getDesignSystem

getTheme

getThemeNames

  • Get the names of all themes.

    Returns

    The names of all existing themes.

    Returns string[]

getThemes

getUninitializedRequiredProperties

  • Return the keys of all properties which are required and not initialized.

    Returns

    Returns the keys of all properties which are required and not initialized.

    Returns string[]

isEnabled

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

    Returns

    True if enabled, or false otherwise.

    Returns boolean

isInitialized

  • 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

    True if initialized, or false otherwise.

    Returns boolean

removeAllListeners

removeListener

  • Remove a listener by name.

    Parameters

    • name: string

      The name of the listener to remove

    Returns void

setDefaultTheme

setListener

  • Set a listener on this node

    Returns

    The ListenerSubscription which should be canceled to stop listening.

    Parameters

    • name: string

      The name of the listener.

    • callback: EventCallback

      The callback to call when an event occurs.

    • Optional eventTypes: EventType[]

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

    Returns ListenerSubscription

store

  • Store persistently the state of the design system.

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc