Class UmbModalToken<ModalDataType, ModalValueType>

constructor

• new UmbModalToken<
      ModalDataType extends { [key: string]: any } = { [key: string]: any },
      ModalValueType = unknown,
  >(
      alias: string,
      defaults?: UmbModalTokenDefaults<ModalDataType, ModalValueType>,
  ): UmbModalToken<ModalDataType, ModalValueType>

  Type Parameters

  • ModalDataType extends { [key: string]: any } = { [key: string]: any }
  • ModalValueType = unknown

  Parameters

  • alias: string

    Unique identifier for the token,
  • Optionaldefaults: UmbModalTokenDefaults<ModalDataType, ModalValueType>

    Defaults for the modal,

  Returns UmbModalToken<ModalDataType, ModalValueType>

ReadonlyDATA

`typeof MyModal.TYPE`
Copy

ReadonlyVALUE

`typeof MyModal.VALUE`
Copy

getDefaultData

• getDefaultData(): undefined | ModalDataType

  Returns undefined | ModalDataType

getDefaultModal

• getDefaultModal(): undefined | UmbModalConfig

  Returns undefined | UmbModalConfig

getDefaultValue

• getDefaultValue(): undefined | ModalValueType

  Returns undefined | ModalValueType

toString

• toString(): string

  This method must always return the unique alias of the token since that will be used to look up the token in the injector.

  Returns string

  the unique alias of the token