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

ModalManager

Extends:

Component → ModalManager

The ModalManager component manages a modal dialog. Only one modal dialog can be shown at once; loading a new component into the ModalManager will overwrite the previous one.

Member Summary

Public Members
public
public
public

Method Summary

Public Methods
public

close()

Close the modal dialog.

public

config(isInitialized: *, context: *)

public

init()

public

show(component: Modal)

Show a modal dialog.

public

view(): *

Protected Methods
protected

clear()

Clear content from the modal area.

protected

When the modal dialog is ready to be used, tell it!

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 Members

public component: * source

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

Override:

Component#component

public hideTimeout: * source

public showing: boolean source

Public Methods

public close() source

Close the modal dialog.

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 init() source

Called when the component is constructed.

Override:

Component#init

public show(component: Modal) source

Show a modal dialog.

Params:

NameTypeAttributeDescription
component Modal

public view(): * source

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

Override:

Component#view

Return:

*

Protected Methods

protected clear() source

Clear content from the modal area.

protected onready() source

When the modal dialog is ready to be used, tell it!