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

Modal

Extends:

Component → Modal

The Modal component displays a modal dialog, wrapped in a form. Subclasses should implement the className, title, and content methods.

Static Member Summary

Static Public Members
public static

Determine whether or not the modal should be dismissible via an 'x' button.

Member Summary

Public Members
public

Attributes for an alert component to show below the header.

public

Method Summary

Public Methods
public abstract

Get the class name to apply to the modal.

public

config(isInitialized: *, context: *)

public abstract

content(): VirtualElement

Get the content of the modal.

public

hide()

Hide the modal.

public

init()

public

loaded()

Stop loading.

public

onerror(error: RequestError)

Show an alert describing an error returned from the API, and give focus to the first relevant field.

public

onhide()

public

Focus on the first input when the modal is ready to be used.

public

onsubmit(e: Event)

Handle the modal form's submit event.

public abstract

Get the title of the modal dialog.

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.

Static Public Members

public static isDismissible: * source

Determine whether or not the modal should be dismissible via an 'x' button.

Public Members

public alertAttrs: object source

Attributes for an alert component to show below the header.

public loading: boolean source

Public Methods

public abstract className(): String source

Get the class name to apply to the modal.

Return:

String

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 abstract content(): VirtualElement source

Get the content of the modal.

Return:

VirtualElement

public hide() source

Hide the modal.

public init() source

Called when the component is constructed.

Override:

Component#init

public loaded() source

Stop loading.

public onerror(error: RequestError) source

Show an alert describing an error returned from the API, and give focus to the first relevant field.

Params:

NameTypeAttributeDescription
error RequestError

public onhide() source

public onready() source

Focus on the first input when the modal is ready to be used.

public onsubmit(e: Event) source

Handle the modal form's submit event.

Params:

NameTypeAttributeDescription
e Event

public abstract title(): String source

Get the title of the modal dialog.

Return:

String

public view(): * source

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

Override:

Component#view

Return:

*