Flarum (v2.0.0-beta.4)
    Preparing search index...

    Class Checkbox<CustomAttrs>

    The Checkbox component defines a checkbox input.

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

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    The attributes passed into the component.

    element: Element

    The root DOM element for the component.

    state: undefined

    Class component state that is persisted between redraws.

    Updating this will not automatically trigger a redraw, unlike other frameworks.

    This is different to Vnode state, which is always an instance of your class component.

    This is undefined by default.

    Methods

    • 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.

      Parameters

      • Optionalselector: string

        a jQuery-compatible selector string

      Returns JQuery

      the jQuery object for the DOM node