Expand all

OO.ui.TextInputWidget

Extends

Constructor

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

TextInputWidgets, like HTML text inputs, can be configured with options that customize the size of the field as well as its presentation. In addition, these widgets can be configured with icons, indicators, an optional validation-pattern (used to determine if an input value is valid or not) and an input filter, which modifies incoming values rather than validating them. Please see the OOUI documentation on MediaWiki for more information and examples.

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

Example

// A TextInputWidget.
    const textInput = new OO.ui.TextInputWidget( {
        value: 'Text input'
    } );
    $( document.body ).append( textInput.$element );

Parameters:

Name Type Attributes Description
config Object optional

Configuration options

Properties:
Name Type Attributes Default Description
type string optional
 'text'

The value of the HTML type attribute: 'text', 'password' 'email', 'url' or 'number'. Subclasses might support other types.
placeholder string optional

Placeholder text
autofocus boolean optional
 false

Use an HTML autofocus attribute to instruct the browser to focus this widget.
readOnly boolean optional
 false

Prevent changes to the value of the text input.
maxLength number optional

Maximum number of characters allowed in the input.
minLength number optional

Minimum number of characters allowed in the input.

For unfortunate historical reasons, this counts the number of UTF-16 code units rather than Unicode codepoints, which means that codepoints outside the Basic Multilingual Plane (e.g. many emojis) count as 2 characters each.
labelPosition string optional
 'after'

The position of the inline label relative to that of the value or placeholder text: 'before' or 'after'
autocomplete boolean | string optional

Should the browser support autocomplete for this field? Type hints such as 'email' are also allowed.
spellcheck boolean optional

Should the browser support spellcheck for this field (undefined means leaving it up to the browser).
validate RegExp | function | string optional

Validation pattern: when string, a 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); when RegExp, a regular expression that must match the value for it to be considered valid; when Function, a function receiving the value as parameter that must return true, or promise resolving to true, for it to be considered valid.
Mixes in:
Source:

TextInputWidgets, like HTML text inputs, can be configured with options that customize the size of the field as well as its presentation.

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

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
Mixes in:
Source:
The symbolic name of the icon (e.g., ‘remove’ or ‘menu’), or a map of symbolic names.

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
Mixes in:
Source:
The icon title, displayed when users move the mouse over the icon.

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
Mixes in:
Source:
Symbolic name of the indicator (e.g.

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
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
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
Inherited from:
Mixes in:
Source:
The title text, a function that returns text, or 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
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Insert new content either side of a selection.

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.

getInputLength() → {number} #

Get the length of the text input value.

This could differ from the length of #getValue if the value gets filtered

Source:

Returns:

Input length

Type
number
Get the length of the text input value.

getRange() → {Object} #

Get an object describing the current selection range in a directional manner

Source:

Returns:

Object containing 'from' and 'to' offsets

Type
Object
Get an object describing the current selection range in a directional manner

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.

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.

Source:

Returns:

A promise that resolves if the value is valid, rejects if not.

Type
jQuery.Promise
Get the validity of current value.

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:
Name Type Attributes Default Description
type string optional
 'text'
Source:

Returns:

Type
string
Get sanitized value for 'type' for given config.

getValue() → {string} #

Get the value of the input.

Inherited from:
Source:

Returns:

Input value

Type
string
Get the value of the input.

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

insertContent(content) → {OO.ui.Widget}chainable #

Insert new content into the input.

Parameters:

Name Type Description
content string

Content to be inserted
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Insert new content into the input.

installParentChangeDetector() #

Support function for making #onElementAttach work.

Source:
Support function for making #onElementAttach work.

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

isReadOnly() → {boolean} #

Check if the input is read-only.

Source:

Returns:

Type
boolean
Check if the input is read-only.

isVisible() → {boolean} #

Check if element is visible.

Inherited from:
Source:

Returns:

element is visible

Type
boolean
Check if element is visible.

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

Focus the input and move the cursor to the end.

Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Focus the input and move the cursor to the end.

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

Focus the input and move the cursor to the start.

Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Focus the input and move the cursor to the start.

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.

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

Focus the input and select the entire text.

Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Focus the input and select the entire text.

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
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Focus the input and select a specified range within the text.

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.

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.

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'
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Set the position of the inline label relative to that of the value: ‘before’ or ‘after’.

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
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Set the 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.
Source:
Set the validation pattern.

setValidityFlag([isValid]) #

Sets the 'invalid' flag appropriately.

Parameters:

Name Type Attributes Description
isValid boolean optional

Optionally override validation result
Source:
Sets the 'invalid' flag appropriately.

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.

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.

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.

Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Update the position of the inline label.

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

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

Parameters:

Name Type Description
value string
Inherited from:
Source:
A change event is emitted when the value 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.

enter() #

An enter event is emitted when the user presses Enter key inside the text box.

Source:
An 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:
A 'toggle' event is emitted when the visibility of the widget changes.