Class ModalManagerState

constructor

• new ModalManagerState(): ModalManagerState

• Returns ModalManagerState

Internal backdropShown

Internal loadingModal

Internal modal

Internal modalList

close

• close(): void

• Closes the topmost currently open dialog, if one is open.

  Returns void

isModalOpen

• isModalOpen(): boolean

• Checks if a modal is currently open.

  Returns boolean

  true if a modal dialog is currently open, otherwise false.

show

• show(componentClass, attrs?, stackModal?): Promise<void>

• Shows a modal dialog.

  If stackModal is true, the modal will be shown on top of the current modal.

  If a value for stackModal is not provided, opening a new modal will close any others currently being shown for backwards compatibility.

  Parameters

  • componentClass: UnsafeModalClass | AsyncModalClass

  • attrs: Record<string, unknown> = {}

  • stackModal: boolean = false

  Returns Promise<void>

  Example

  Show a modal

  app.modal.show(MyCoolModal, { attr: 'value' });
  Copy

  Example

  Show a modal from a lifecycle method (oncreate, view, etc.)

  // This "hack" is needed due to quirks with nested redraws in Mithril.
  setTimeout(() => app.modal.show(MyCoolModal, { attr: 'value' }), 0);
  Copy

  Example

  Stacking modals

  app.modal.show(MyCoolStackedModal, { attr: 'value' }, true);
  Copy