Class Property<T>

A property of a generic type.

Type Parameters

  • T

Hierarchy (view full)

Implements

  • IProperty

Properties

key name

Methods

addDependency getDesignSystem getUninitializedRequiredProperties isEnabled isInitialized removeAllListeners removeListener setListener store

Properties

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

Methods

addDependency

getDesignSystem

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

setListener

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

  • Set a listener on this node

    Parameters

    • name: string

      The name of the listener.

    • listener: EventCallback
    • 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