new CheckboxMultiselectInputWidget(configopt)
CheckboxMultiselectInputWidget is a
CheckboxMultiselectWidget intended to be used within a
HTML form, such as a OO.ui.FormLayout. The selected values are synchronized with the value of
HTML `` tags. Please see the [OOUI documentation on MediaWiki][1] for
more information about input widgets.
Parameters:
Name | Type | Attributes | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
config |
Object |
<optional> |
Configuration options
Properties
|
Example
// Example: A CheckboxMultiselectInputWidget with three options
var multiselectInput = new OO.ui.CheckboxMultiselectInputWidget( {
options: [
{ data: 'a', label: 'First' },
{ data: 'b', label: 'Second'},
{ data: 'c', label: 'Third' }
]
} );
$( 'body' ).append( multiselectInput.$element );
[1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs
Extends
Methods
cleanUpValue(value) → {Array.<string>}
Clean up incoming value.
Parameters:
Name | Type | Description |
---|---|---|
value |
Array.<string> | Original value |
- Overrides:
- OO.ui.InputWidget#cleanUpValue
- Source:
Returns:
Cleaned up value
- Type
- Array.<string>
focus()
getClosestScrollableElementContainer() → {HTMLElement}
Get closest scrollable container.
- Inherited From:
- Source:
Returns:
Closest scrollable container
- Type
- HTMLElement
getData() → {Mixed}
Get element data.
- Inherited From:
- Source:
Returns:
Element data
- Type
- Mixed
getElementDocument() → {HTMLDocument}
Get the DOM document.
- Inherited From:
- Source:
Returns:
Document object
- Type
- HTMLDocument
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
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
getElementWindow() → {Window}
Get the DOM window.
- Inherited From:
- Source:
Returns:
Window object
- Type
- Window
(protected) getInputElement(config) → {jQuery}
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
getInputId() → {string|null}
Get an ID of a labelable node which is part of this widget, if any, to be used for `
- Inherited From:
- Source:
Returns:
The ID of the labelable element
- Type
- string | 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
getValue() → {string}
Get the value of the input.
- Overrides:
- Source:
Returns:
Input value
- Type
- string
isDisabled() → {boolean}
Check if the widget is disabled.
- Inherited From:
- Source:
Returns:
Widget is disabled
- Type
- boolean
isElementAttached() → {boolean}
Check if the element is attached to the DOM
- Inherited From:
- Source:
Returns:
The element is attached to the DOM
- Type
- boolean
isVisible() → {boolean}
Check if element is visible.
- Inherited From:
- Source:
Returns:
element is visible
- Type
- boolean
(protected) restorePreInfuseState(state)
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:
scrollElementIntoView(configopt) → {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
setData(data)
Set element data.
Parameters:
Name | Type | Description |
---|---|---|
data |
Mixed | Element data |
- Inherited From:
- Source:
setDir(dir)
Set the directionality of the input.
Parameters:
Name | Type | Description |
---|---|---|
dir |
string | Text directionality: 'ltr', 'rtl' or 'auto' |
- Inherited From:
- Source:
setDisabled(disabled)
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 | Description |
---|---|---|
disabled |
boolean | Disable widget |
- Overrides:
- Source:
setElementGroup(group)
Set group element is in.
Parameters:
Name | Type | Description |
---|---|---|
group |
OO.ui.mixin.GroupElement | null | Group element, null if none |
- Inherited From:
- Source:
setElementId(id)
Set the element has an 'id' attribute.
Parameters:
Name | Type | Description |
---|---|---|
id |
string |
- Inherited From:
- Source:
setInputId(id)
Set the 'id' attribute of the `` element.
Parameters:
Name | Type | Description |
---|---|---|
id |
string |
- Inherited From:
- Source:
setOptions(options)
Set the options available for this input.
Parameters:
Name | Type | Description |
---|---|---|
options |
Array.<Object> | Array of menu options in the format `{ data: …, label: …, disabled: … }` |
setValue(value)
Set the value of the input.
Parameters:
Name | Type | Description |
---|---|---|
value |
string | New value |
- Overrides:
- Source:
Fires:
simulateLabelClick()
Simulate the behavior of clicking on a label (a HTML `
- Inherited From:
- Source:
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
toggle(showopt)
Toggle visibility of an element.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
show |
boolean |
<optional> |
Make element visible, omit to toggle visibility |
- Inherited From:
- Source:
Fires:
- event:visible
updateDisabled()
Update the disabled state, in case of changes in parent widget.
- Inherited From:
- Source:
updateThemeClasses()
Update the theme-provided classes.
- Inherited From:
- Source: