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

Switch

Extends:

ComponentCheckbox → Switch

The Switch component is a Checkbox, but with a switch display instead of a tick/cross one.

Static Method Summary

Static Public Methods
public static

initProps(props: *)

Method Summary

Public Methods
public

getDisplay(): *

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.

From class Checkbox
public

Whether or not the checkbox's value is in the process of being saved.

public

init()

public

view(): *

protected

getDisplay(): *

Get the template for the checkbox's display (tick/cross icon).

protected

onchange(checked: Boolean)

Run a callback when the state of the checkbox is changed.

Static Public Methods

public static initProps(props: *) source

Initialize the component's props.

Override:

Component#initProps

Params:

NameTypeAttributeDescription
props *

Public Methods

public getDisplay(): * source

Get the template for the checkbox's display (tick/cross icon).

Override:

Checkbox#getDisplay

Return:

*