Class PopUpManager

constructor

• new PopUpManager(
      navController: NavController,
      options?: Partial<PopUpManagerOptions>,
  ): PopUpManager

  Parameters

  • navController: NavController
  • Optionaloptions: Partial<PopUpManagerOptions>

  Returns PopUpManager

ReadonlynavController

options

destroy

• destroy(): void

  Cleanup and destroy the PopUpManager instance. This:

  • Removes the existing pop up
  • Cleans up all internal and external listeners

  Returns void

listen

• listen<
      const EventDefinition extends
          Readonly<{ type: "hide-pop-up" | "nav-select" }>,
  >(
      event: EventDefinition,
      listener: (
          event: ExtractEventByType<PopUpManagerEvents, EventDefinition["type"]>,
      ) => MaybePromise<void>,
      options?: PartialWithUndefined<{}>,
  ): RemoveListenerCallback

  Listen to events emitted from a PopUpManager instance.

  Type Parameters

  • const EventDefinition extends Readonly<{ type: "hide-pop-up" | "nav-select" }>

  Parameters

  • event: EventDefinition
  • listener: (
        event: ExtractEventByType<PopUpManagerEvents, EventDefinition["type"]>,
    ) => MaybePromise<void>
  • Optionaloptions: PartialWithUndefined<{}>

  Returns RemoveListenerCallback

removePopUp

• removePopUp(): void

  Trigger removal or hiding of the pop up.

  Returns void

showPopUp

• showPopUp(
      rootElement: HTMLElement,
      options?: Partial<PopUpManagerOptions>,
  ): ShowPopUpResult

  Trigger showing the pop up.

  Parameters

  • rootElement: HTMLElement
  • Optionaloptions: Partial<PopUpManagerOptions>

  Returns ShowPopUpResult