Expand all

OO.ui.CheckboxInputWidget

Extends

Constructor

new OO.ui.CheckboxInputWidget([config]) #

CheckboxInputWidgets, like HTML checkboxes, can be selected and/or configured with a value. Note that these input widgets are best laid out in field layouts that use the inline alignment. For more information, please see the OOUI documentation on MediaWiki.

This widget can be used inside an HTML form, such as a OO.ui.FormLayout.

Example

// An example of selected, unselected, and disabled checkbox inputs.
    const checkbox1 = new OO.ui.CheckboxInputWidget( {
            value: 'a',
             selected: true
        } ),
        checkbox2 = new OO.ui.CheckboxInputWidget( {
            value: 'b'
        } ),
        checkbox3 = new OO.ui.CheckboxInputWidget( {
            value:'c',
            disabled: true
        } ),
        // Create a fieldset layout with fields for each checkbox.
        fieldset = new OO.ui.FieldsetLayout( {
            label: 'Checkboxes'
        } );
    fieldset.addItems( [
        new OO.ui.FieldLayout( checkbox1, { label: 'Selected checkbox', align: 'inline' } ),
        new OO.ui.FieldLayout( checkbox2, { label: 'Unselected checkbox', align: 'inline' } ),
        new OO.ui.FieldLayout( checkbox3, { label: 'Disabled checkbox', align: 'inline' } ),
    ] );
    $( document.body ).append( fieldset.$element );

Parameters:

Name Type Attributes Description
config Object optional

Configuration options

Properties:
Name Type Attributes Default Description
selected boolean optional
 false

Select the checkbox initially. By default, the checkbox is not selected.
indeterminate boolean optional
 false

Whether the checkbox is in the indeterminate state.
Source:
CheckboxInputWidgets, like HTML checkboxes, can be selected and/or configured with a value.

Properties

tagNamestatic #

Source:

accessKey #

The access key, a function that returns a key, or null for no access key.

Properties:

Type Description
string | function | null
Inherited from:
Mixes in:
Source:
The access key, a function that returns a key, or null for no access key.

title #

The title text, a function that returns text, or null for no title. The value of the static property is overridden if the #title config option is used.

If the element has a default title (e.g. <input type=file>), null will allow that title to be shown. Use empty string to suppress it.

Properties:

Type Description
string | function | null
Inherited from:
Mixes in:
Source:
The title text, a function that returns text, or null for no title.

Methods

gatherPreInfuseState()static #

Source:

getClosestScrollableElementContainer() → {HTMLElement} #

Get closest scrollable container.

Inherited from:
Source:

Returns:

Closest scrollable container

Type
HTMLElement
Get closest scrollable container.

getData() → {any} #

Get element data.

Inherited from:
Source:

Returns:

Element data

Type
any
Get element data.

getElementDocument() → {HTMLDocument} #

Get the DOM document.

Inherited from:
Source:

Returns:

Document object

Type
HTMLDocument
Get the DOM document.

getElementGroup() → {OO.ui.mixin.GroupElement|null} #

Get group element is in.

Inherited from:
Source:

Returns:

Group element, null if none

Type
OO.ui.mixin.GroupElement | null
Get group element is in.

getElementId() → {string} #

Ensure that the element has an 'id' attribute, setting it to an unique value if it's missing, and return its value.

Inherited from:
Source:

Returns:

Type
string

Ensure that the element has an 'id' attribute, setting it to an unique value if it's missing, and return its value.

getElementWindow() → {Window} #

Get the DOM window.

Inherited from:
Source:

Returns:

Window object

Type
Window
Get the DOM window.

getInputElement(config) → {jQuery}protected #

Get input element.

Subclasses of OO.ui.InputWidget use the config parameter to produce different elements in different circumstances. The element must have a value property (like form elements).

Parameters:

Name Type Description
config Object

Configuration options
Overrides:
Source:

Returns:

Input element

Type
jQuery
Get input element.

getInputId() → {string|null} #

Get an ID of a labelable node which is part of this widget, if any, to be used for <label for> value.

If this function returns null, the widget should have a meaningful #simulateLabelClick method instead.

Inherited from:
Source:

Returns:

The ID of the labelable element

Type
string | null

Get an ID of a labelable node which is part of this widget, if any, to be used for <label for> value.

getTagName() → {string} #

Get the HTML tag name.

Override this method to base the result on instance information.

Inherited from:
Source:

Returns:

HTML tag name

Type
string
Get the HTML tag name.

getValue() → {string} #

Get the value of the input.

Inherited from:
Source:

Returns:

Input value

Type
string
Get the value of the input.

isDisabled() → {boolean} #

Check if the widget is disabled.

Inherited from:
Source:

Returns:

Widget is disabled

Type
boolean
Check if the widget is disabled.

isElementAttached() → {boolean} #

Check if the element is attached to the DOM

Inherited from:
Source:

Returns:

The element is attached to the DOM

Type
boolean
Check if the element is attached to the DOM

isIndeterminate() → {boolean} #

Check if this checkbox is selected.

Source:

Returns:

Checkbox is selected

Type
boolean
Check if this checkbox is selected.

isSelected() → {boolean} #

Check if this checkbox is selected.

Source:

Returns:

Checkbox is selected

Type
boolean
Check if this checkbox is selected.

isVisible() → {boolean} #

Check if element is visible.

Inherited from:
Source:

Returns:

element is visible

Type
boolean
Check if element is visible.

restorePreInfuseState(state)protected #

Restore the pre-infusion dynamic state for this widget.

This method is called after #$element has been inserted into DOM. The parameter is the return value of #gatherPreInfuseState.

Parameters:

Name Type Description
state Object
Overrides:
Source:
Restore the pre-infusion dynamic state for this widget.

scrollElementIntoView([config]) → {jQuery.Promise} #

Scroll element into view.

Parameters:

Name Type Attributes Description
config Object optional

Configuration options
Inherited from:
Source:

Returns:

Promise which resolves when the scroll is complete

Type
jQuery.Promise
Scroll element into view.

setData(data) → {OO.ui.Element}chainable #

Set element data.

Parameters:

Name Type Description
data any

Element data
Inherited from:
Source:

Returns:

The element, for chaining

Type
OO.ui.Element
Set element data.

setDir(dir) → {OO.ui.Widget}chainable #

Set the directionality of the input.

Parameters:

Name Type Description
dir string

Text directionality: 'ltr', 'rtl' or 'auto'
Inherited from:
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Set the directionality of the input.

setDisabled([disabled]) → {OO.ui.Widget}chainable #

Set the 'disabled' state of the widget.

When a widget is disabled, it cannot be used and its appearance is updated to reflect this state.

Parameters:

Name Type Attributes Default Description
disabled boolean optional
 false

Disable widget
Inherited from:
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Set the 'disabled' state of the widget.

setElementGroup(group) → {OO.ui.Element}chainable #

Set group element is in.

Parameters:

Name Type Description
group OO.ui.mixin.GroupElement | null

Group element, null if none
Inherited from:
Source:

Returns:

The element, for chaining

Type
OO.ui.Element
Set group element is in.

setElementId(id) → {OO.ui.Element}chainable #

Set the element has an 'id' attribute.

Parameters:

Name Type Description
id string
Inherited from:
Source:

Returns:

The element, for chaining

Type
OO.ui.Element
Set the element has an 'id' attribute.

setIndeterminate([state], [internal]) → {OO.ui.CheckboxInputWidget}chainable #

Set indeterminate state of this checkbox.

Parameters:

Name Type Attributes Default Description
state boolean optional
 false

Indeterminate state
internal boolean optional
 false

Used for internal calls to suppress events
Source:

Returns:

The widget, for chaining

Type
OO.ui.CheckboxInputWidget
Set indeterminate state of this checkbox.

setInputId(id) → {OO.ui.Widget}chainable #

Set the 'id' attribute of the <input> element.

Parameters:

Name Type Description
id string
Inherited from:
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Set the 'id' attribute of the <input> element.

setLabelledBy(id) #

Set the element with the given ID as a label for this widget.

Parameters:

Name Type Description
id string | null
Inherited from:
Source:
Set the element with the given ID as a label for this widget.

setSelected([state], [internal]) → {OO.ui.CheckboxInputWidget}chainable #

Set selection state of this checkbox.

Parameters:

Name Type Attributes Default Description
state boolean optional
 false

Selected state
internal boolean optional
 false

Used for internal calls to suppress events
Source:

Returns:

The widget, for chaining

Type
OO.ui.CheckboxInputWidget
Set selection state of this checkbox.

setValue(value) → {OO.ui.Widget}chainable #

Set the value of the input.

Parameters:

Name Type Description
value string

New value
Inherited from:
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget

Fires:

Set the value of the input.

simulateLabelClick() #

Simulate the behavior of clicking on a label (a HTML <label> element) bound to this input. HTML only allows <label> to act on specific "labelable" elements; complex widgets might need to override this method to provide intuitive, accessible behavior.

By default, this does nothing. OO.ui.mixin.TabIndexedElement overrides it for focusable widgets. Individual widgets may override it too.

This method is called by OO.ui.LabelWidget and OO.ui.FieldLayout. It should not be called directly.

Overrides:
Source:
Simulate the behavior of clicking on a label (a HTML <label> element) bound to this input.

supports(methods) → {boolean} #

Check if element supports one or more methods.

Parameters:

Name Type Description
methods string | Array.<string>

Method or list of methods to check
Inherited from:
Source:

Returns:

All methods are supported

Type
boolean
Check if element supports one or more methods.

toggle([show]) → {OO.ui.Element}chainable #

Toggle visibility of an element.

Parameters:

Name Type Attributes Description
show boolean optional

Make element visible, omit to toggle visibility
Inherited from:
Source:

Returns:

The element, for chaining

Type
OO.ui.Element

Fires:

Toggle visibility of an element.

updateDisabled() → {OO.ui.Widget}chainable #

Update the disabled state, in case of changes in parent widget.

Inherited from:
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Update the disabled state, in case of changes in parent widget.

updateThemeClasses() #

Update the theme-provided classes.

This is called in element mixins and widget classes any time state changes. Updating is debounced, minimizing overhead of changing multiple attributes and guaranteeing that theme updates do not occur within an element's constructor

Inherited from:
Source:
Update the theme-provided classes.

Events

change(selected, indeterminate) #

A change event is emitted when the state of the input changes.

Parameters:

Name Type Description
selected boolean
indeterminate boolean
Overrides:
Source:
A change event is emitted when the state of the input changes.

disable(disabled) #

A 'disable' event is emitted when the disabled state of the widget changes (i.e. on disable and enable).

Parameters:

Name Type Description
disabled boolean

Widget is disabled
Inherited from:
Source:

A 'disable' event is emitted when the disabled state of the widget changes (i.e.

toggle(visible) #

A 'toggle' event is emitted when the visibility of the widget changes.

Parameters:

Name Type Description
visible boolean

Widget is visible
Inherited from:
Source:
A 'toggle' event is emitted when the visibility of the widget changes.