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

Checkbox

Extends:

Component → Checkbox

Direct Subclass:

Switch

The Checkbox component defines a checkbox input.

Props

  • state Whether or not the checkbox is checked.
  • className The class name for the root element.
  • disabled Whether or not the checkbox is disabled.
  • onchange A callback to run when the checkbox is checked/unchecked.
  • children A text label to display next to the checkbox.

Member Summary

Public Members
public

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

Method Summary

Public Methods
public

init()

public

view(): *

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

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 loading: Boolean source

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

Public Methods

public init() source

Called when the component is constructed.

Override:

Component#init

public view(): * source

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

Override:

Component#view

Return:

*

Protected Methods

protected getDisplay(): * source

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

Return:

*

protected onchange(checked: Boolean) source

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

Params:

NameTypeAttributeDescription
checked Boolean