Extends
Constructor
new OO.ui.ComboBoxInputWidget([config])
#
Hierarchy
ComboBoxInputWidgets combine a text input
(where a value
can be entered manually) and a menu of options
(from which
a value can be chosen instead). Users can choose options from the combo box in one of two ways:
- by typing a value in the text input field. If the value exactly matches the value of a menu option, that option will appear to be selected.
- by choosing a value from the menu. The value of the chosen option will then appear in the text input field.
After the user chooses an option, its data
will be used as a new value for the widget.
A label
also can be specified for each option: if given, it will be shown instead of the
data
in the dropdown menu.
This widget can be used inside an HTML form, such as a OO.ui.FormLayout.
For more information about menus and options, please see the OOUI documentation on MediaWiki.
Examples
// A ComboBoxInputWidget.
const comboBox = new OO.ui.ComboBoxInputWidget( {
value: 'Option 1',
options: [
{ data: 'Option 1' },
{ data: 'Option 2' },
{ data: 'Option 3' }
]
} );
$( document.body ).append( comboBox.$element );
const comboBox = new OO.ui.ComboBoxInputWidget( {
value: 'Option 1',
options: [
{
data: 'Option 1',
label: 'Option One'
},
{
data: 'Option 2',
label: 'Option Two'
},
{
data: 'Option 3',
label: 'Option Three'
}
]
} );
$( document.body ).append( comboBox.$element );
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
config |
Object |
optional |
Configuration options Properties:
|
- Source:
ComboBoxInputWidgets combine a text input
(where a value
can be entered manually) and a menu of options
(from which
a value can be chosen instead).
Properties
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:
null
for no access key.
flags
#
Initial value to pass to setFlags if no value is provided in config.
Properties:
- Inherited from:
- Mixes in:
- Source:
icon
#
The symbolic name of the icon (e.g., ‘remove’ or ‘menu’), or a map of symbolic names. A map
is used for i18n purposes and contains a default
icon name and additional names keyed by
language code. The default
name is used when no icon is keyed by the user's language.
Example of an i18n map:
{ default: 'bold-a', en: 'bold-b', de: 'bold-f' }
Note: the static property will be overridden if the #icon configuration is used.
Properties:
Type | Description |
---|---|
Object | string |
- Inherited from:
- Mixes in:
- Source:
iconTitle
#
The icon title, displayed when users move the mouse over the icon. The value can be text, a
function that returns title text, or null
for no title.
The static property will be overridden if the #iconTitle configuration is used.
Properties:
Type | Description |
---|---|
string
|
function
|
null
|
- Inherited from:
- Mixes in:
- Source:
indicator
#
Symbolic name of the indicator (e.g. ‘required’ or ‘down’). The static property will be overridden if the #indicator configuration is used.
Properties:
Type | Description |
---|---|
string
|
null
|
- Inherited from:
- Mixes in:
- Source:
indicatorTitle
#
A text string used as the indicator title, a function that returns title text, or null
for no title. The static property will be overridden if the #indicatorTitle configuration is
used.
Properties:
Type | Description |
---|---|
string
|
function
|
null
|
- Inherited from:
- Mixes in:
- Source:
A text string used as the indicator title, a function that returns title text, or null
for no title.
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
|
- Inherited from:
- Mixes in:
- Source:
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:
null
for no title.
Methods
encapsulateContent(pre, post) → {OO.ui.Widget}chainable
#
Insert new content either side of a selection.
Parameters:
Name | Type | Description |
---|---|---|
pre |
string | Content to be inserted before the selection |
post |
string | Content to be inserted after the selection |
- Inherited from:
- Source:
Returns:
The widget, for chaining
- Type
- OO.ui.Widget
getClosestScrollableElementContainer() → {HTMLElement}
#
Get closest scrollable container.
- Inherited from:
- Source:
Returns:
Closest scrollable container
- Type
- HTMLElement
getData() → {any}
#
Get element data.
- Inherited from:
- Source:
Returns:
Element data
- Type
- any
getElementDocument() → {HTMLDocument}
#
getElementGroup() → {OO.ui.mixin.GroupElement|null
}
#
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
Ensure that the element has an 'id' attribute, setting it to an unique value if it's missing, and return its value.
getElementWindow() → {Window}
#
getInput() → {OO.ui.TextInputWidget}
#
Get the combobox's text input widget.
- Source:
Returns:
Text input widget
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 |
- Inherited from:
- Source:
Returns:
Input element
- Type
- jQuery
getInputId() → {string|null
}
#
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.
getInputLength() → {number}
#
Get the length of the text input value.
This could differ from the length of #getValue if the value gets filtered
- Inherited from:
- Source:
Returns:
Input length
- Type
- number
getMenu() → {OO.ui.MenuSelectWidget}
#
Get the combobox's menu.
- Source:
Returns:
Menu widget
getRange() → {Object}
#
Get an object describing the current selection range in a directional manner
- Inherited from:
- Source:
Returns:
Object containing 'from' and 'to' offsets
- Type
- Object
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
getValidity() → {jQuery.Promise}
#
Get the validity of current value.
This method returns a promise that resolves if the value is valid and rejects if
it isn't. Uses the validation pattern
to check for validity.
- Inherited from:
- Source:
Returns:
A promise that resolves if the value is valid, rejects if not.
- Type
- jQuery.Promise
getValidType(config) → {string}protected
#
Get sanitized value for 'type' for given config. Subclasses might support other types.
Parameters:
Name | Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
config |
Object | Configuration options Properties:
|
- Inherited from:
- Source:
Returns:
- Type
- string
getValue() → {string}
#
Get the value of the input.
- Inherited from:
- Source:
Returns:
Input value
- Type
- string
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 |
- Inherited from:
- Mixes in:
- Source:
Returns:
Text with the first match of the query sub-string wrapped in highlighted span
- Type
- jQuery
insertContent(content) → {OO.ui.Widget}chainable
#
Insert new content into the input.
Parameters:
Name | Type | Description |
---|---|---|
content |
string | Content to be inserted |
- Inherited from:
- Source:
Returns:
The widget, for chaining
- Type
- OO.ui.Widget
installParentChangeDetector()
#
Support function for making #onElementAttach work.
- Inherited from:
- Source:
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
isReadOnly() → {boolean}
#
Check if the input is read-only
.
- Inherited from:
- Source:
Returns:
- Type
- boolean
read-only
.
isVisible() → {boolean}
#
Check if element is visible.
- Inherited from:
- Source:
Returns:
element is visible
- Type
- boolean
moveCursorToEnd() → {OO.ui.Widget}chainable
#
Focus the input and move the cursor to the end.
- Inherited from:
- Source:
Returns:
The widget, for chaining
- Type
- OO.ui.Widget
moveCursorToStart() → {OO.ui.Widget}chainable
#
Focus the input and move the cursor to the start.
- Inherited from:
- Source:
Returns:
The widget, for chaining
- Type
- OO.ui.Widget
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:
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
select() → {OO.ui.Widget}chainable
#
Focus the input and select the entire text.
- Inherited from:
- Source:
Returns:
The widget, for chaining
- Type
- OO.ui.Widget
selectRange(from, [to]) → {OO.ui.Widget}chainable
#
Focus the input and select a specified range within the text.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
from |
number | Select from offset |
||
to |
number |
optional |
from | Select to offset |
- Inherited from:
- Source:
Returns:
The widget, for chaining
- Type
- OO.ui.Widget
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
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
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 |
- Overrides:
- Source:
Returns:
The widget, for chaining
- Type
- OO.ui.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
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
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
<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:
setLabelPosition(labelPosition) → {OO.ui.Widget}chainable
#
Set the position of the inline label relative to that of the value: ‘before’
or ‘after’
.
Parameters:
Name | Type | Description |
---|---|---|
labelPosition |
string | Label position, 'before' or 'after' |
- Inherited from:
- Source:
Returns:
The widget, for chaining
- Type
- OO.ui.Widget
‘before’
or ‘after’
.
setOptions(options) → {OO.ui.Widget}chainable
#
Set the options available for this input.
Parameters:
Name | Type | Description |
---|---|---|
options |
Array.<Object> | Array of menu options in the format |
- Source:
Returns:
The widget, for chaining
- Type
- OO.ui.Widget
setReadOnly([state]) → {OO.ui.Widget}chainable
#
Set the read-only
state of the input.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
state |
boolean |
optional |
false | Make input read-only |
- Overrides:
- Source:
Returns:
The widget, for chaining
- Type
- OO.ui.Widget
read-only
state of the input.
setValidation(validate)
#
Set the validation pattern.
The validation pattern is either a regular expression, a function, or the symbolic name of a pattern defined by the class: 'non-empty' (the value cannot be an empty string) or 'integer' (the value must contain only numbers).
Parameters:
Name | Type | Description |
---|---|---|
validate |
RegExp
|
function
|
string
|
null
|
Regular expression, function, or the symbolic name of a pattern (either ‘integer’ or ‘non-empty’) defined by the class. |
- Inherited from:
- Source:
setValidityFlag([isValid])
#
Sets the 'invalid' flag appropriately.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
isValid |
boolean |
optional |
Optionally override validation result |
- Inherited from:
- Source:
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:
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:
<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
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:
updateControlsDisabled() → {OO.ui.ComboBoxInputWidget}protectedchainable
#
Update the disabled state of the controls
- Source:
Returns:
The widget, for chaining
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
updatePosition() → {OO.ui.Widget}chainable
#
Update the position of the inline label.
This method is called by #setLabelPosition, and can also be called on its own if something causes the label to be mispositioned.
- Inherited from:
- Source:
Returns:
The widget, for chaining
- Type
- OO.ui.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:
Events
change(value)
#
A change event is emitted when the value of the input changes.
Parameters:
Name | Type | Description |
---|---|---|
value |
string |
- Inherited from:
- Source:
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.
enter()
#
An enter
event is emitted when the user presses Enter key inside the text box.
- Inherited from:
- Source:
enter
event is emitted when the user presses Enter key inside the text box.
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: