Skip to content

PopupManagerPlugin

Defined in: plugins/PopupManagerPlugin.ts:38

PopupManager

Extends

Implements

Constructors

new PopupManagerPlugin()

new PopupManagerPlugin(id): PopupManagerPlugin

Defined in: plugins/Plugin.ts:40

Parameters

id

string = 'Plugin'

Returns

PopupManagerPlugin

Inherited from

Plugin.constructor

Properties

__dill_pixel_method_binding_root

__dill_pixel_method_binding_root: boolean

Defined in: plugins/Plugin.ts:37

Inherited from

Plugin.__dill_pixel_method_binding_root


id

readonly id: string = 'popups'

Defined in: plugins/PopupManagerPlugin.ts:39

Implementation of

IPopupManagerPlugin.id

Overrides

Plugin.id


onHidePopup

onHidePopup: Signal<(detail) => void>

Defined in: plugins/PopupManagerPlugin.ts:44

Implementation of

IPopupManagerPlugin.onHidePopup


onPopupChanged

onPopupChanged: Signal<(detail) => void>

Defined in: plugins/PopupManagerPlugin.ts:45

Implementation of

IPopupManagerPlugin.onPopupChanged


onShowPopup

onShowPopup: Signal<(detail) => void>

Defined in: plugins/PopupManagerPlugin.ts:43

Implementation of

IPopupManagerPlugin.onShowPopup


view

readonly view: Container

Defined in: plugins/PopupManagerPlugin.ts:40

Implementation of

IPopupManagerPlugin.view

Accessors

app

Get Signature

get app(): T

Defined in: plugins/Plugin.ts:45

Returns

T

Implementation of

IPopupManagerPlugin.app

Inherited from

Plugin.app


current

Get Signature

get current(): undefined | IPopup

Defined in: plugins/PopupManagerPlugin.ts:61

Returns

undefined | IPopup

Implementation of

IPopupManagerPlugin.current


currentPopupId

Get Signature

get currentPopupId(): undefined | string | number

Defined in: plugins/PopupManagerPlugin.ts:53

Returns

undefined | string | number

Implementation of

IPopupManagerPlugin.currentPopupId


hasActivePopups

Get Signature

get hasActivePopups(): boolean

Defined in: plugins/PopupManagerPlugin.ts:68

Returns

boolean

Implementation of

IPopupManagerPlugin.hasActivePopups


popupCount

Get Signature

get popupCount(): number

Defined in: plugins/PopupManagerPlugin.ts:57

Returns

number

Implementation of

IPopupManagerPlugin.popupCount

Methods

addPopup()

addPopup<T>(id, popup): void

Defined in: plugins/PopupManagerPlugin.ts:96

Add a popup

Type Parameters

T = any

Parameters

id

The id of the popup

string | number

PopupConstructor<T>

The popup constructor

Returns

void

Implementation of

IPopupManagerPlugin.addPopup


addSignalConnection()

addSignalConnection(…args): void

Defined in: plugins/Plugin.ts:71

Add signal connections to the container.

Parameters

args

SignalConnection[]

The signal connections to add.

Returns

void

Implementation of

IPopupManagerPlugin.addSignalConnection

Inherited from

Plugin.addSignalConnection


clearSignalConnections()

clearSignalConnections(): void

Defined in: plugins/Plugin.ts:77

Returns

void

Implementation of

IPopupManagerPlugin.clearSignalConnections

Inherited from

Plugin.clearSignalConnections


destroy()

destroy(): void

Defined in: plugins/PopupManagerPlugin.ts:86

Destroy the PopupManager

Returns

void

Implementation of

IPopupManagerPlugin.destroy

Overrides

Plugin.destroy


hidePopup()

hidePopup<T>(id, data?): Promise<undefined | IPopup<T>>

Defined in: plugins/PopupManagerPlugin.ts:140

Hide a popup

Type Parameters

T = any

Parameters

id

The id of the popup

string | number

data?

T

Returns

Promise<undefined | IPopup<T>>

a promise resolving to the popup, if it exists

Implementation of

IPopupManagerPlugin.hidePopup


initialize()

initialize(_app): void

Defined in: plugins/PopupManagerPlugin.ts:77

Initialize the PopupManager

Parameters

_app

IApplication

Returns

void

Implementation of

IPopupManagerPlugin.initialize

Overrides

Plugin.initialize


postInitialize()

postInitialize(_app): void | Promise<void>

Defined in: plugins/Plugin.ts:60

Parameters

_app

IApplication

Returns

void | Promise<void>

Implementation of

IPopupManagerPlugin.postInitialize

Inherited from

Plugin.postInitialize


removeAllPopups()

removeAllPopups(animate): void

Defined in: plugins/PopupManagerPlugin.ts:164

Remove all popups

Parameters

animate

boolean = false

Whether to animate the removal

Returns

void

Implementation of

IPopupManagerPlugin.removeAllPopups


showPopup()

showPopup<T>(id, config): Promise<undefined | IPopup<T>>

Defined in: plugins/PopupManagerPlugin.ts:106

Show a popup

Type Parameters

T = any

Parameters

id

The id of the popup

string | number

config

Partial<PopupConfig<T>> = {}

The configuration for the popup

Returns

Promise<undefined | IPopup<T>>

a promise resolving to the popup, if it exists

Implementation of

IPopupManagerPlugin.showPopup