The body styles atom.

Hierarchy (view full)

Properties

The body1 topography styling properties

The body1 bold topography styling properties

The body2 topography styling properties

The body2 bold topography styling properties

The body3 topography styling properties

The body3 bold topography styling properties

key: string

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

name: string

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

required: boolean

Is this a required atom?

Methods

  • 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.

  • 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.

  • 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.