Class PopUpManager

A "pop up" manager for items that pop up from the HTML page, like dropdowns or menus.

Index

Constructors

Methods

destroy listen removePopUp showPopUp

Constructors

constructor

new PopUpManager(options?: Partial<PopUpManagerOptions>): PopUpManager
Parameters
- Optionaloptions: Partial<PopUpManagerOptions>
Returns PopUpManager
- Defined in packages/vira/src/util/pop-up-manager.ts:133

Methods

destroy

destroy(): void
Cleanup and destroy the PopUpManager instance. This:
- Removes the existing pop up
- Cleans up all internal and external listeners
Returns void
- Defined in packages/vira/src/util/pop-up-manager.ts:297

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
- Defined in packages/vira/src/util/pop-up-manager.ts:215

removePopUp

removePopUp(): void
Trigger removal or hiding of the pop up.

Returns void
- Defined in packages/vira/src/util/pop-up-manager.ts:230

showPopUp

showPopUp(
rootElement: HTMLElement,
options?: Partial<PopUpManagerOptions>,
): ShowPopUpResult
Trigger showing the pop up.
Parameters
- rootElement: HTMLElement
- Optionaloptions: Partial<PopUpManagerOptions>
Returns ShowPopUpResult
- Defined in packages/vira/src/util/pop-up-manager.ts:236