Expand all

OO.ui.OptionWidget

Extends

Constructor

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

OptionWidgets are special elements that can be selected and configured with data. The data is often unique for each option, but it does not have to be. OptionWidgets are used with OO.ui.SelectWidget to create a selection of mutually exclusive options. For more information and examples, please see the OOUI documentation on MediaWiki.

Parameters:

Name Type Attributes Description
config Object optional

Configuration options

Properties:
Name Type Attributes Default Description
selected boolean optional
 false
Mixes in:
Source:
OptionWidgets are special elements that can be selected and configured with data.

Properties

accessKey #

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

Properties:

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

flags #

Initial value to pass to setFlags if no value is provided in config.

Properties:

Type Description
string | Array.<string> | Object.<string, boolean>
Mixes in:
Source:
Initial value to pass to setFlags if no value is provided in config.

label #

The label text. The label can be specified as a plaintext string, a function that will produce a string (will be resolved on construction time), or null for no label. The static value will be overridden if a label is specified with the #label config option.

Properties:

Type Description
string | function | null
Mixes in:
Source:
The label text.

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
Mixes in:
Source:
The title text, a function that returns text, or null for no title.

highlightablestatic #

Whether this option can be highlighted. See #setHighlighted.

Properties:

Type Description
boolean
Source:
Whether this option can be highlighted.

pressablestatic #

Whether this option can be pressed. See #setPressed.

Properties:

Type Description
boolean
Source:
Whether this option can be pressed.

scrollIntoViewOnSelectstatic #

Whether this option will be scrolled into view when it is selected.

Properties:

Type Description
boolean
Source:
Whether this option will be scrolled into view when it is selected.

selectablestatic #

Whether this option can be selected. See #setSelected.

Properties:

Type Description
boolean
Source:
Whether this option can be selected.

Methods

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.

getMatchText() → {string|boolean} #

Get text to match search strings against.

The default implementation returns the label text, but subclasses can override this to provide more complex behavior.

Source:

Returns:

String to match search string against

Type
string | boolean
Get text to match search strings against.

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.

highlightQuery(text, query, [compare], [combineMarks]) → {jQuery} #

Highlight the first occurrence of the query in the given text

Parameters:

Name Type Attributes Default Description
text string

Text
query string

Query to find
compare function optional

Optional string comparator, e.g. Intl.Collator().compare
combineMarks boolean optional
 false

Pull combining marks into highlighted text
Mixes in:
Source:

Returns:

Text with the first match of the query sub-string wrapped in highlighted span

Type
jQuery
Highlight the first occurrence of the query in the given text

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

isHighlightable() → {boolean} #

Check if the option can be highlighted. A highlight indicates that the option may be selected when a user presses Enter key or clicks. Disabled items cannot be highlighted.

Source:

Returns:

Item is highlightable

Type
boolean
Check if the option can be highlighted.

isHighlighted() → {boolean} #

Check if the option is highlighted. A highlight indicates that the item may be selected when a user presses Enter key or clicks.

Source:

Returns:

Item is highlighted

Type
boolean
Check if the option is highlighted.

isPressable() → {boolean} #

Check if the option can be pressed. The pressed state occurs when a user mouses down on an item, but has not yet let go of the mouse.

Source:

Returns:

Item is pressable

Type
boolean
Check if the option can be pressed.

isPressed() → {boolean} #

Check if the option is pressed. The pressed state occurs when a user mouses down on an item, but has not yet let go of the mouse. The item may appear selected, but it will not be selected until the user releases the mouse.

Source:

Returns:

Item is pressed

Type
boolean
Check if the option is pressed.

isSelectable() → {boolean} #

Check if the option can be selected.

Source:

Returns:

Item is selectable

Type
boolean
Check if the option can be selected.

isSelected() → {boolean} #

Check if the option is selected.

Source:

Returns:

Item is selected

Type
boolean
Check if the option 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
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.

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.

setHighlighted([state]) → {OO.ui.Widget}chainable #

Set the option’s highlighted state. In general, all programmatic modifications to the highlight should be handled by the SelectWidget’s highlightItem( [item] ) method instead of this method.

Parameters:

Name Type Attributes Default Description
state boolean optional
 false

Highlight option
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Set the option’s highlighted state.

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.

setPressed([state]) → {OO.ui.Widget}chainable #

Set the option’s pressed state. In general, all programmatic modifications to the pressed state should be handled by the SelectWidget’s pressItem( [item] ) method instead of this method.

Parameters:

Name Type Attributes Default Description
state boolean optional
 false

Press option
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Set the option’s pressed state.

setSelected([state]) → {OO.ui.Widget}chainable #

Set the option’s selected state. In general, all modifications to the selection should be handled by the SelectWidget’s selectItem( [item] ) method instead of this method.

Parameters:

Name Type Attributes Default Description
state boolean optional
 false

Select option
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Set the option’s selected state.

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.

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

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.