Class Code

Code generation for theme builder.

Hierarchy (view full)

Properties

cssGenerator key name

Methods

addDependency getCSSVarGroup getCSSVarGroupKeys getCSSVars getDesignSystem getJSON getJSONBase getJSONDM getJSONLM getUninitializedRequiredProperties isEnabled isInitialized removeAllListeners removeListener setCSSVarListener setListener store

Properties

cssGenerator

cssGenerator: CSSGenerator

The CSS code generator

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

getCSSVarGroup

  • getCSSVarGroup(node): CSSVarGroup

  • Get a group of CSS variables associated with a particular node (i.e. atom, molecule, or organism).

    Parameters

    • node: INode

      The node for which we are getting the group of variables.

    Returns CSSVarGroup

    The variable group

getCSSVarGroupKeys

  • getCSSVarGroupKeys(): string[]

  • Get all keys of all CSS variable groups.

    Returns string[]

    All keys associated with all CSS variable groups.

getCSSVars

  • getCSSVars(): {
        [name: string]: string;
    }

  • Get all CSS variables for this design system.

    Returns {
        [name: string]: string;
    }

    All CSS variables for this design system.

    • [name: string]: string

getDesignSystem

getJSON

  • getJSON(lm): Object

  • Get the JSON code generated by the theme builder for the default theme for light or dark mode.

    Parameters

    • lm: boolean

    Returns Object

    The JSON object.

getJSONBase

  • getJSONBase(): Object

  • Get the base JSON code generated by the theme builder for the default theme.

    Returns Object

    The JSON object.

getJSONDM

  • getJSONDM(): Object

  • Get the darkmode JSON code generated by the theme builder for the default theme.

    Returns Object

    The JSON object.

getJSONLM

  • getJSONLM(): Object

  • Get the lightmode JSON code generated by the theme builder for the default theme.

    Returns Object

    The JSON object.

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

setCSSVarListener

  • setCSSVarListener(name, listener?): void

  • Set a CSS variable listener which is called each time a CSS variable value is changed.

    Parameters

    • name: string

      The listener name.

    • Optionallistener: VarListener

      The listener callback.

    Returns void

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