Expand all

OO.ui.CheckboxMultiselectWidget

Extends

Constructor

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

CheckboxMultiselectWidget is a multiselect widget that contains checkboxes and is used together with OO.ui.CheckboxMultioptionWidget. The CheckboxMultiselectWidget provides an interface for adding, removing and selecting options. Please see the OOUI documentation on MediaWiki for more information.

If you want to use this within an HTML form, such as a OO.ui.FormLayout, use OO.ui.CheckboxMultiselectInputWidget instead.

Example

// A CheckboxMultiselectWidget with CheckboxMultioptions.
    const option1 = new OO.ui.CheckboxMultioptionWidget( {
            data: 'a',
            selected: true,
            label: 'Selected checkbox'
        } ),
        option2 = new OO.ui.CheckboxMultioptionWidget( {
            data: 'b',
            label: 'Unselected checkbox'
        } ),
        multiselect = new OO.ui.CheckboxMultiselectWidget( {
            items: [ option1, option2 ]
        } );
    $( document.body ).append( multiselect.$element );

Parameters:

Name Type Attributes Description
config Object optional

Configuration options
Source:

CheckboxMultiselectWidget is a multiselect widget that contains checkboxes and is used together with OO.ui.CheckboxMultioptionWidget.

Properties

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

findSelectedItems() → {Array.<OO.ui.MultioptionWidget>} #

Find options that are selected.

Inherited from:
Source:

Returns:

Selected options

Type
Array.<OO.ui.MultioptionWidget>
Find options that are selected.

findSelectedItemsData() → {Array.<Object>|Array.<string>} #

Find the data of options that are selected.

Inherited from:
Source:

Returns:

Values of selected options

Type
Array.<Object> | Array.<string>
Find the data of options that are selected.

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

Focus the widget

Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Focus the widget

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.

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.

getRelativeFocusableItem(item, direction) → {OO.ui.CheckboxMultioptionWidget|null} #

Get an option by its position relative to the specified item (or to the start of the option array, if item is null). The direction in which to search through the option array is specified with a number: -1 for reverse (the default) or 1 for forward. The method will return an option, or null if there are no options in the array.

Parameters:

Name Type Description
item OO.ui.CheckboxMultioptionWidget | null

Item to describe the start position, or null to start at the beginning of the array.
direction number

Direction to move in: -1 to move backward, 1 to move forward
Source:

Returns:

Item at position, null if there are no items in the select.

Type
OO.ui.CheckboxMultioptionWidget | null

Get an option by its position relative to the specified item (or to the start of the option array, if item is null).

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.

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

isVisible() → {boolean} #

Check if element is visible.

Inherited from:
Source:

Returns:

element is visible

Type
boolean
Check if element is visible.

onClick(e) #

Handle click events on checkboxes.

Parameters:

Name Type Description
e jQuery.Event
Source:
Handle click events on checkboxes.

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
Inherited from:
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.

selectItems(items) → {OO.ui.Widget}chainable #

Select options by reference. Options not mentioned in the items array will be deselected.

Parameters:

Name Type Description
items Array.<OO.ui.MultioptionWidget>

Items to select
Inherited from:
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Select options by reference.

selectItemsByData(datas) → {OO.ui.Widget}chainable #

Select items by their data. Options not mentioned in the datas array will be deselected.

Parameters:

Name Type Description
datas Array.<Object> | Array.<string>

Values of items to select
Inherited from:
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Select items by their data.

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.

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.

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.

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() #

A change event is emitted when the set of items changes, or an item is selected or deselected.

Inherited from:
Source:
A change event is emitted when the set of items changes, or an item is selected or deselected.

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.

select() #

A select event is emitted when an item is selected or deselected.

Inherited from:
Source:
A select event is emitted when an item is selected or deselected.

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.