Class: ButtonInputWidget

.ui.ButtonInputWidget(configopt)

new ButtonInputWidget(configopt)

ButtonInputWidget is used to submit HTML forms and is intended to be used within a OO.ui.FormLayout. If you do not need the button to work with HTML forms, you probably want to use OO.ui.ButtonWidget instead. Button input widgets can be rendered as either an HTML <button> (the default) or an HTML <input> tags. See the [OOjs UI documentation on MediaWiki] [1] for more information.

Parameters:
Name Type Attributes Description
config Object <optional>

Configuration options

Properties
Name Type Attributes Default Description
type string <optional>
 'button'

The value of the HTML 'type' attribute: 'button', 'submit' or 'reset'.
useInputTag boolean <optional>
 false

Use an <input> tag instead of a <button> tag, the default. Widgets configured to be an <input> do not support icons and indicators, non-plaintext labels, or values. In general, useInputTag should only be set to true when there’s need to support IE 6 in a form with multiple buttons.
Mixes In:
Source:
Example
// A ButtonInputWidget rendered as an HTML button, the default.
    var button = new OO.ui.ButtonInputWidget( {
        label: 'Input button',
        icon: 'check',
        value: 'check'
    } );
    $( 'body' ).append( button.$element );

[1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Inputs#Button_inputs

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

(protected) getInputElement(config) → {jQuery}

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

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.

Overrides:
Source:
Returns:

The ID of the labelable element

Type
string | null

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

getValue() → {string}

Get the value of the input.

Inherited From:
Source:
Returns:

Input value

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:

setDir(dir)

Set the directionality of the input.

Parameters:
Name Type Description
dir string

Text directionality: 'ltr', 'rtl' or 'auto'
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:

setInputId(id)

Set the 'id' attribute of the <input> element.

Parameters:
Name Type Description
id string
Inherited From:
Source:

setLabel(label)

Set label value.

If #useInputTag is true, the label is set as the value of the <input> tag.

Parameters:
Name Type Description
label jQuery | string | function | null

Label nodes, text, a function that returns nodes or text, or null for no label
Source:

setValue(value)

Set the value of the input.

This method is disabled for button inputs configured as tags, as they do not support values.

Parameters:
Name Type Description
value string

New value
Overrides:
Source:

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:

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: