Button

Button

Class representing a generic button.

Constructor

new Button(configopt)

Source:

src/Button.js, line 27

Create a button.

Parameters:

Name Type Attributes Description

config

object

<optional>

Properties

Name	Type	Attributes	Default	Description
`element`	Element	<optional>		Pre-created element (usually provided instead of config).
`buttonElement`	Element	<optional>		Pre-created link element.
`labelElement`	Element	<optional>		Pre-created label element.
`iconElement`	Element	<optional>		Pre-created icon element.
`tagName`	string	<optional>	`'a'`	Tag name of the button element.
`classes`	Array.<string>	<optional>	`[]`	List of classes to add to the button element.
`id`	string	<optional>		ID attribute of the button.
`href`	string	<optional>		Value of the `href` parameter to add to the link element.
`label`	string	<optional>		Label of the button.
`tooltip`	string	<optional>		Tooltip for the button.
`flags`	Array.<string>	<optional>		Flags to apply to an OOUI button.
`action`	function	<optional>		Function to execute on click or Enter press.

Members

buttonElement :Element

Source:

src/Button.js, line 83

Button element (an 'a' element by default) which can be the same as the main element or its descendant.

Type:

Element

element :Element

Source:

src/Button.js, line 75

Main element which can be the same as the link element or a wrapper around it.

Type:

Element

iconElement :Element|undefined

Source:

src/Button.js, line 98

Button icon element, a descendant of the link element.

Type:

Element | undefined

labelElement :Element

Source:

src/Button.js, line 91

Button label element which can be the same as the link element or its descendant.

Type:

Element

Methods

hide() → {Button}

Source:

src/Button.js, line 245

Hide the button.

Returns:

This button.

Type: Button

isDisabled() → {boolean}

Source:

src/Button.js, line 227

Check whether the button is disabled.

Returns:

Type: boolean

isPending() → {boolean}

Source:

src/Button.js, line 236

Check whether the button is pending.

Returns:

Type: boolean

maybeExecuteAction(action, e)

Source:

src/Button.js, line 188

Execute a pre-defined action if the button is conditions are met.

Parameters:

Name	Type	Description
`action`	function
`e`	Event

setAction(actionnullable) → {Button}

Source:

src/Button.js, line 204

Set the action of the button. It will be executed on click or Enter press.

Parameters:

Name	Type	Attributes	Description
`action`	function	<nullable>

Returns:

This button.

Type: Button

setDisabled(disabled) → {Button}

Source:

src/Button.js, line 123

Set the button disabled or not.

Parameters:

Name	Type	Description
`disabled`	boolean

Returns:

This button.

Type: Button

setHref(href) → {Button}

Source:

src/Button.js, line 152

Set the href attribute of the button.

Parameters:

Name	Type	Description
`href`	string

Returns:

This button.

Type: Button

setIconProgressive()

Source:

src/Button.js, line 282

Set the class to an OOUI icon to make it look like icons with the "progressive" flag do. Somehow OOUI doesn't set it at the building stage.

setLabel(label) → {Button}

Source:

src/Button.js, line 164

Set the label of the button.

Parameters:

Name	Type	Description
`label`	string

Returns:

This button.

Type: Button

setPending(pending) → {Button}

Source:

src/Button.js, line 138

Set the button pending or not.

Parameters:

Name	Type	Description
`pending`	boolean

Returns:

This button.

Type: Button

setTooltip(tooltip) → {Button}

Source:

src/Button.js, line 176

Set the tooltip of the button.

Parameters:

Name	Type	Description
`tooltip`	string

Returns:

This button.

Type: Button

show() → {Button}

Source:

src/Button.js, line 256

Show the button.

Returns:

This button.

Type: Button

toggle(show) → {Button}

Source:

src/Button.js, line 268

Show or hide the button, depending on the parameter.

Parameters:

Name	Type	Description
`show`	boolean	Whether to show the button.

Returns:

This button.

Type: Button