Class: ButtonWidget

.ui.ButtonWidget(configopt)

new ButtonWidget(configopt)

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] [1] for more information and examples. [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Buttons_and_Switches
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>
Hyperlink to visit when the button is clicked.
target string <optional>
The frame or window in which to open the hyperlink.
congif.noFollow boolean <optional>
Search engine traversal hint (default: true)
Mixes In:
Source:
Example
// A button widget
    var button = new OO.ui.ButtonWidget( {
        label: 'Button with Icon',
        icon: 'trash',
        iconTitle: 'Remove'
    } );
    $( 'body' ).append( button.$element );

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

Extends

Methods

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

getHref() → {string}

Get hyperlink location.
Source:
Returns:
Hyperlink location
Type
string

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

getNoFollow() → {boolean}

Get search engine traversal hint.
Source:
Returns:
Whether search engines should avoid traversing this hyperlink
Type
boolean

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

getTarget() → {string}

Get hyperlink target.
Source:
Returns:
Hyperlink target
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:

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

setHref(href)

Set hyperlink location.
Parameters:
Name Type Description
href string | null Hyperlink location, null to remove
Source:

setNoFollow(noFollow)

Set search engine traversal hint.
Parameters:
Name Type Description
noFollow boolean True if search engines should avoid traversing this hyperlink
Source:

setTarget(target)

Set hyperlink target.
Parameters:
Name Type Description
target string | null Hyperlink target, null to remove
Source:

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: