Class AlertManagerState

Index

Constructors

Properties

activeAlerts alertId

Methods

clear dismiss getActiveAlerts show

Constructors

constructor

new AlertManagerState(): AlertManagerState
Returns AlertManagerState

Properties

`Protected`activeAlerts

activeAlerts: { [id: number]: AlertState } = {}

`Protected`alertId

alertId: number = 0

Methods

clear

clear(): void
Clear all alerts.

Returns void
- Defined in flarum/framework/core/js/src/common/states/AlertManagerState.ts:68

dismiss

dismiss(key: number | null): void
Dismiss an alert.
Parameters
- key: number | null
Returns void
- Defined in flarum/framework/core/js/src/common/states/AlertManagerState.ts:58

getActiveAlerts

getActiveAlerts(): { [id: number]: AlertState }
Returns { [id: number]: AlertState }
- Defined in flarum/framework/core/js/src/common/states/AlertManagerState.ts:19

show

show(children: Children): number
Show an Alert in the alerts area.
Parameters
- children: Children
Returns number
The alert's ID, which can be used to dismiss the alert.
- Defined in flarum/framework/core/js/src/common/states/AlertManagerState.ts:28
show(attrs: AlertAttrs, children: Children): number
Show an Alert in the alerts area.
Parameters
- attrs: AlertAttrs
- children: Children
Returns number
The alert's ID, which can be used to dismiss the alert.
- Defined in flarum/framework/core/js/src/common/states/AlertManagerState.ts:29
show(
    componentClass: typeof Alert,
    attrs: AlertAttrs,
    children: Children,
): number
Show an Alert in the alerts area.
Parameters
- componentClass: typeof Alert
- attrs: AlertAttrs
- children: Children
Returns number
The alert's ID, which can be used to dismiss the alert.
- Defined in flarum/framework/core/js/src/common/states/AlertManagerState.ts:30