Extends

• Button

Methods

addChild(child, optionsopt) → {Component}

button.js, line 73

Add a child Component inside of this Button.

Parameters:

Name	Type	Attributes	Default	Description
child	string | Component			The name or instance of a child to add.
options	Object	<optional>	{}	The key/value store of options that will get passed to children of the child.

Returns:

Component -

The Component that gets added as a child. When using a string the Component will get created by this process.

Inherited From:

• Button#addChild

Deprecated:

• since version 5

buildCSSClass() → {string}

big-play-button.js, line 29

Builds the default DOM className.

Returns:

string -

The DOM className for this object. Always returns 'vjs-big-play-button'.

createEl(tagopt, propsopt, attributesopt) → {Element}

button.js, line 32

Create the Buttons DOM element.

Parameters:

Name	Type	Attributes	Default	Description
tag	string	<optional>	"button"	The element's node type. This argument is IGNORED: no matter what is passed, it will always create a button element.
props	Object	<optional>	{}	An object of properties that should be set on the element.
attributes	Object	<optional>	{}	An object of attributes that should be set on the element.

Returns:

Element -

The element that gets created.

Inherited From:

• Button#createEl

disable()

button.js, line 95

Disable the Button element so that it cannot be activated or clicked. Use this with Button#enable.

Inherited From:

• Button#disable

enable()

button.js, line 86

Enable the Button element so that it can be activated or clicked. Use this with Button#disable.

Inherited From:

• Button#enable

handleClick(event)

big-play-button.js, line 44

This gets called when a BigPlayButton "clicked". See ClickableComponent for more detailed information on what a click can be.

Parameters:

Name	Type	Description
event	EventTarget~Event	The keydown, tap, or click event that caused this function to be called.

Listens to Events:

• event:tap
• event:click

handleKeyPress(event)

button.js, line 109

This gets called when a Button has focus and keydown is triggered via a key press.

Parameters:

Name	Type	Description
event	EventTarget~Event	The event that caused this function to get called.

Listens to Events:

• event:keydown

Overrides:

• Button#handleKeyPress