PopupManagerPlugin

Defined in: plugins/PopupManagerPlugin.ts:37

PopupManager

Extends

• Plugin

Implements

• IPopupManagerPlugin

Constructors

new PopupManagerPlugin()

new PopupManagerPlugin(id): PopupManagerPlugin

Defined in: plugins/Plugin.ts:48

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:39

Inherited from

Plugin.__dill_pixel_method_binding_root

---

id

readonly id: string = 'popups'

Defined in: plugins/PopupManagerPlugin.ts:38

Implementation of

IPopupManagerPlugin.id

Overrides

Plugin.id

---

onHidePopup

onHidePopup: Signal<(detail) => void>

Defined in: plugins/PopupManagerPlugin.ts:43

Implementation of

IPopupManagerPlugin.onHidePopup

---

onPopupChanged

onPopupChanged: Signal<(detail) => void>

Defined in: plugins/PopupManagerPlugin.ts:44

Implementation of

IPopupManagerPlugin.onPopupChanged

---

onShowPopup

onShowPopup: Signal<(detail) => void>

Defined in: plugins/PopupManagerPlugin.ts:42

Implementation of

IPopupManagerPlugin.onShowPopup

---

view

readonly view: Container<Application<DataSchema, ActionContext, Action, Renderer>>

Defined in: plugins/PopupManagerPlugin.ts:39

Implementation of

IPopupManagerPlugin.view

Accessors

app

Get Signature

get app(): A

Defined in: plugins/Plugin.ts:53

Returns

A

Implementation of

IPopupManagerPlugin.app

Inherited from

Plugin.app

---

current

Get Signature

get current(): undefined | IPopup<any>

Defined in: plugins/PopupManagerPlugin.ts:60

Returns

undefined | IPopup<any>

Implementation of

IPopupManagerPlugin.current

---

currentPopupId

Get Signature

get currentPopupId(): undefined | string | number

Defined in: plugins/PopupManagerPlugin.ts:52

Returns

undefined | string | number

Implementation of

IPopupManagerPlugin.currentPopupId

---

hasActivePopups

Get Signature

get hasActivePopups(): boolean

Defined in: plugins/PopupManagerPlugin.ts:67

Returns

boolean

Implementation of

IPopupManagerPlugin.hasActivePopups

---

options

Get Signature

get options(): O

Defined in: plugins/Plugin.ts:44

Returns

O

Implementation of

IPopupManagerPlugin.options

Inherited from

Plugin.options

---

popupCount

Get Signature

get popupCount(): number

Defined in: plugins/PopupManagerPlugin.ts:56

Returns

number

Implementation of

IPopupManagerPlugin.popupCount

Methods

addPopup()

addPopup<T>(id, popup): void

Defined in: plugins/PopupManagerPlugin.ts:95

Add a popup

Type Parameters

• T = any

Parameters

id

The id of the popup

string | number

popup

PopupConstructor<T>

The popup constructor

Returns

void

Implementation of

IPopupManagerPlugin.addPopup

---

addSignalConnection()

addSignalConnection(…args): void

Defined in: plugins/Plugin.ts:79

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:85

Returns

void

Implementation of

IPopupManagerPlugin.clearSignalConnections

Inherited from

Plugin.clearSignalConnections

---

destroy()

destroy(): void

Defined in: plugins/PopupManagerPlugin.ts:85

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:139

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(): void

Defined in: plugins/PopupManagerPlugin.ts:76

Initialize the PopupManager

Returns

void

Implementation of

IPopupManagerPlugin.initialize

Overrides

Plugin.initialize

---

postInitialize()

postInitialize(_app): void | Promise<void>

Defined in: plugins/Plugin.ts:68

Parameters

_app

IApplication

Returns

void | Promise<void>

Implementation of

IPopupManagerPlugin.postInitialize

Inherited from

Plugin.postInitialize

---

removeAllPopups()

removeAllPopups(animate): void

Defined in: plugins/PopupManagerPlugin.ts:163

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:105

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