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

Alert

Extends:

Component → Alert

The Alert component represents an alert box, which contains a message, some controls, and may be dismissible.

The alert may have the following special props:

  • type The type of alert this is. Will be used to give the alert a class name of Alert--{type}.
  • controls An array of controls to show in the alert.
  • dismissible Whether or not the alert can be dismissed.
  • ondismiss A callback to run when the alert is dismissed.

All other props will be assigned as attributes on the alert element.

Method Summary

Public Methods
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.

Public Methods

public view(): * source

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

Override:

Component#view

Return:

*