Reference Source
import AlertManager from 'flarum/components/AlertManager'
public class | source

AlertManager

Extends:

Component → AlertManager

The AlertManager component provides an area in which Alert components can be shown and dismissed.

Member Summary

Protected Members
protected

An array of Alert components which are currently showing.

Method Summary

Public Methods
public

clear()

Clear all alerts.

public

config(isInitialized: *, context: *)

public

dismiss(component: Alert)

Dismiss an alert.

public

init()

public

show(component: Alert)

Show an Alert in the alerts area.

public

view(): *

Inherited Summary

From class Component
public static

component(props: Object, children: *): Object

Get a Mithril component object for this component, preloaded with props.

public static

initProps(props: Object)

Initialize the component's props.

public

element: *

The root DOM element for the component.

public

The properties passed into the component.

public

Whether or not to retain the component's subtree on redraw.

public

$(selector: String): jQuery

Returns a jQuery object for this component's element. If you pass in a selector string, this method will return a jQuery object, using the current element as its buffer.

For example, calling component.$('li') will return a jQuery object containing all of the li elements inside the DOM element of this component.

public

config(isInitialized: Boolean, context: Object, vdom: Object)

Called after the component's root element is redrawn. This hook can be used to perform any actions on the DOM, both on the initial draw and any subsequent redraws. See Mithril's documentation for more information.

public

Called when the component is destroyed, i.e.

public

Get the renderable virtual DOM that represents the component's view.

This should NOT be overridden by subclasses. Subclasses wishing to define their virtual DOM should override Component#view instead.

protected

init()

Called when the component is constructed.

protected

Get the virtual DOM that represents the component's view.

Protected Members

protected components: Alert[] source

An array of Alert components which are currently showing.

Public Methods

public clear() source

Clear all alerts.

public config(isInitialized: *, context: *) source

Called after the component's root element is redrawn. This hook can be used to perform any actions on the DOM, both on the initial draw and any subsequent redraws. See Mithril's documentation for more information.

Override:

Component#config

Params:

NameTypeAttributeDescription
isInitialized *
context *

public dismiss(component: Alert) source

Dismiss an alert.

Params:

NameTypeAttributeDescription
component Alert

public init() source

Called when the component is constructed.

Override:

Component#init

public show(component: Alert) source

Show an Alert in the alerts area.

Params:

NameTypeAttributeDescription
component Alert

public view(): * source

Get the virtual DOM that represents the component's view.

Override:

Component#view

Return:

*