Class StateSettings

The state settings atom.

Hierarchy

Properties

all danger info key name ready required success warning

Methods

addDependency getDesignSystem getUninitializedRequiredProperties isEnabled isInitialized removeAllListeners removeListener setListener store

Properties

Readonly all

all: StateSetting[] = []

All state setting properties

Readonly danger

danger: StateSetting

The danger state setting properties

Readonly info

info: StateSetting

The info state setting properties

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 ready

ready: PropertyBoolean

Property set to true when everything is ready

Readonly required

required: boolean

Is this a required atom?

Readonly success

success: StateSetting

The success state setting properties

Readonly warning

warning: StateSetting

The warning state setting properties

Methods

addDependency

getDesignSystem

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

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