Expand all

OO.ui.ButtonWidget

Extends

Constructor

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

ButtonWidget is a generic widget for buttons. A wide variety of looks, feels, and functionality can be customized via the class’s configuration options and methods. Please see the OOUI documentation on MediaWiki for more information and examples.

NOTE: HTML form buttons should use the OO.ui.ButtonInputWidget class.

Example

// A button widget.
    const button = new OO.ui.ButtonWidget( {
        label: 'Button with Icon',
        icon: 'trash',
        title: 'Remove'
    } );
    $( document.body ).append( button.$element );

Parameters:

Name Type Attributes Description
config Object optional

Configuration options

Properties:
Name Type Attributes Default Description
active boolean optional
 false

Whether button should be shown as active
href string optional
 null

Hyperlink to visit when the button is clicked.
target string optional
 null

The frame or window in which to open the hyperlink.
noFollow boolean optional
 true

Search engine traversal hint
rel string | Array.<string> optional
 []

Relationship attributes for the hyperlink
Mixes in:
Source:
ButtonWidget is a generic widget for buttons.

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.

cancelButtonMouseDownEvents #

Cancel mouse down events.

This property is usually set to true to prevent the focus from changing when the button is clicked. Classes such as DraggableElement and ButtonOptionWidget use a value of false so that dragging behavior is possible and mousedown events can be handled by a parent widget.

Properties:

Type Description
boolean
Mixes in:
Source:
Cancel mouse down events.

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

cancelButtonMouseDownEventsstatic #

Source:

tagNamestatic #

Source:

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.

getHref() → {string|null} #

Get hyperlink location.

Source:

Returns:

Hyperlink location

Type
string | null
Get hyperlink location.

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.

getNoFollow() → {boolean} #

Get search engine traversal hint.

Source:

Returns:

Whether search engines should avoid traversing this hyperlink

Type
boolean
Get search engine traversal hint.

getRel() → {Array.<string>} #

Get the relationship attribute of the hyperlink.

Source:

Returns:

Relationship attributes that apply to the hyperlink

Type
Array.<string>
Get the relationship attribute of the hyperlink.

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.

getTarget() → {string|null} #

Get hyperlink target.

Source:

Returns:

Hyperlink target

Type
string | null
Get hyperlink target.

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

isActive() #

Source:

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.

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.

setActive() #

Source:

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.

setHref(href) → {OO.ui.Widget}chainable #

Set hyperlink location.

Parameters:

Name Type Description
href string | null

Hyperlink location, null to remove
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Set hyperlink location.

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.

setNoFollow([noFollow]) → {OO.ui.Widget} #

Set search engine traversal hint.

Parameters:

Name Type Attributes Default Description
noFollow boolean optional
 true

True if search engines should avoid traversing this hyperlink
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Set search engine traversal hint.

setRel([rel]) → {OO.ui.Widget} #

Set the rel attribute of the hyperlink.

Parameters:

Name Type Attributes Description
rel string | Array.<string> optional

Relationship attributes for the hyperlink, omit to remove
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Set the rel attribute of the hyperlink.

setTarget(target) → {OO.ui.Widget} #

Set hyperlink target.

Parameters:

Name Type Description
target string | null

Hyperlink target, null to remove
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Set hyperlink target.

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.