Extends

• Button

Members

protected controlText_ :string

big-play-button.js, line 92

The text that should display over the BigPlayButtons controls. Added to for localization.

Overrides:

• Button#controlText_

Methods

$(selector, contextopt) → {Element|null}

component.js, line 857

Find a single DOM element matching a selector. This can be within the Components contentEl() or another custom context.

Parameters:

Name	Type	Attributes	Default	Description
selector	string			A valid CSS selector, which will be passed to querySelector.
context	Element | string	<optional>	this.contentEl()	A DOM element within which to query. Can also be a selector string in which case the first matching element will get used as context. If missing this.contentEl() gets used. If this.contentEl() returns nothing it falls back to document.

Returns:

Element | null -

the dom element that was found, or null

Overrides:

• Button#$

See:

• Information on CSS Selectors

$$(selector, contextopt) → {NodeList}

component.js, line 879

Finds all DOM element matching a selector. This can be within the Components contentEl() or another custom context.

Parameters:

Name	Type	Attributes	Default	Description
selector	string			A valid CSS selector, which will be passed to querySelectorAll.
context	Element | string	<optional>	this.contentEl()	A DOM element within which to query. Can also be a selector string in which case the first matching element will get used as context. If missing this.contentEl() gets used. If this.contentEl() returns nothing it falls back to document.

Returns:

NodeList -

a list of dom elements that were found

Overrides:

• Button#$$

See:

• Information on CSS Selectors

addChild(child, optionsopt) → {Component}

button.js, line 76

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.

Overrides:

• Button#addChild

Deprecated:

• since version 5

addClass(…classesToAdd)

component.js, line 903

Add a CSS class name to the Components element.

Parameters:

Name	Type	Attributes	Description
classesToAdd	string	<repeatable>	One or more CSS class name to add.

Overrides:

• Button#addClass

any(type, fn)

component.js, line 192

This function will add an event listener that gets triggered only once and is removed from all events. This is like adding an array of event listeners with EventTarget#on that calls EventTarget#off on all events the first time it is triggered.

Parameters:

Name	Type	Description
type	string | Array.<string>	An event name or an array of event names.
fn	function	The function to be called once for each event name.

Overrides:

• Button#any

blur()

component.js, line 1243

Remove the focus from this component

Overrides:

• Button#blur

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'.

Overrides:

• Button#buildCSSClass

cancelAnimationFrame(id) → {number}

component.js, line 1672

Cancels a queued callback passed to Component#requestAnimationFrame (rAF).

If you queue an rAF callback via Component#requestAnimationFrame, use this function instead of window.cancelAnimationFrame. If you don't, your dispose listener will not get cleaned up until Component#dispose!

Parameters:

Name	Type	Description
id	number	The rAF ID to clear. The return value of Component#requestAnimationFrame.

Returns:

number -

Returns the rAF ID that was cleared.

Overrides:

• Button#cancelAnimationFrame

See:

• Similar to

cancelNamedAnimationFrame(name)

component.js, line 1647

Cancels a current named animation frame if it exists.

Parameters:

Name	Type	Description
name	string	The name of the requestAnimationFrame to cancel.

Overrides:

• Button#cancelNamedAnimationFrame

children() → {Array}

component.js, line 462

Get an array of all child components

Returns:

Array -

The children

Overrides:

• Button#children

clearInterval(intervalId) → {number}

component.js, line 1556

Clears an interval that gets created via window.setInterval or Component#setInterval. If you set an interval via Component#setInterval use this function instead of window.clearInterval. If you don't your dispose listener will not get cleaned up until Component#dispose!

Parameters:

Name	Type	Description
intervalId	number	The id of the interval to clear. The return value of Component#setInterval or window.setInterval.

Returns:

number -

Returns the interval id that was cleared.

Overrides:

• Button#clearInterval

See:

• Similar to

clearTimeout(timeoutId) → {number}

component.js, line 1500

Clears a timeout that gets created via window.setTimeout or Component#setTimeout. If you set a timeout via Component#setTimeout use this function instead of window.clearTimout. If you don't your dispose listener will not get cleaned up until Component#dispose!

Parameters:

Name	Type	Description
timeoutId	number	The id of the timeout to clear. The return value of Component#setTimeout or window.setTimeout.

Returns:

number -

Returns the timeout id that was cleared.

Overrides:

• Button#clearTimeout

See:

• Similar to

contentEl() → {Element}

component.js, line 431

Return the Components DOM element. This is where children get inserted. This will usually be the the same as the element returned in Component#el.

Returns:

Element -

The content element for this Component.

Overrides:

• Button#contentEl

controlText(textopt, elopt) → {string}

clickable-component.js, line 144

Get or set the localize text to use for the controls on the ClickableComponent.

Parameters:

Name	Type	Attributes	Default	Description
text	string	<optional>		Control text for element.
el	Element	<optional>	this.el()	Element to set the title on.

Returns:

string -

• The control text when getting

Overrides:

• Button#controlText

createControlTextEl(elopt) → {Element}

clickable-component.js, line 115

Create a control text element on this ClickableComponent

Parameters:

Name	Type	Attributes	Description
el	Element	<optional>	Parent element for the control text.

Returns:

Element -

The control text element that gets created.

Overrides:

• Button#createControlTextEl

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

button.js, line 33

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.

Overrides:

• Button#createEl

currentDimension(widthOrHeight) → {number}

component.js, line 1156

Get the computed width or the height of the component's element.

Uses window.getComputedStyle.

Parameters:

Name	Type	Description
widthOrHeight	string	A string containing 'width' or 'height'. Whichever one you want to get.

Returns:

number -

The dimension that gets asked for or 0 if nothing was set for that dimension.

Overrides:

• Button#currentDimension

currentDimensions() → {Component~DimensionObject}

component.js, line 1202

Get an object that contains computed width and height values of the component's element.

Uses window.getComputedStyle.

Returns:

Component~DimensionObject -

The computed dimensions of the component's element.

Overrides:

• Button#currentDimensions

currentHeight() → {number}

component.js, line 1229

Get the computed height of the component's element.

Uses window.getComputedStyle.

Returns:

number -

The computed height of the component's element.

Overrides:

• Button#currentHeight

currentWidth() → {number}

component.js, line 1217

Get the computed width of the component's element.

Uses window.getComputedStyle.

Returns:

number -

The computed width of the component's element.

Overrides:

• Button#currentWidth

dimension(widthOrHeight, numopt, skipListenersopt) → {number}

component.js, line 1093

Get or set width or height of the Component element. This is the shared code for the Component#width and Component#height.

Things to know:

• If the width or height in an number this will return the number postfixed with 'px'.
• If the width/height is a percent this will return the percent postfixed with '%'
• Hidden elements have a width of 0 with window.getComputedStyle. This function defaults to the Components style.width and falls back to window.getComputedStyle. See this for more information
• If you want the computed style of the component, use Component#currentWidth and {Component#currentHeight

Parameters:

Name	Type	Attributes	Description
widthOrHeight	string		8 'width' or 'height'
num	number | string	<optional>	8 New dimension
skipListeners	boolean	<optional>	Skip componentresize event trigger

Fires:

• Component#event:componentresize

Returns:

number -

The dimension when getting or 0 if unset

Overrides:

• Button#dimension

dimensions(width, height)

component.js, line 1059

Set both the width and height of the Component element at the same time.

Parameters:

Name	Type	Description
width	number | string	Width to set the Components element to.
height	number | string	Height to set the Components element to.

Overrides:

• Button#dimensions

disable()

button.js, line 98

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

Overrides:

• Button#disable

dispose(options)

component.js, line 220

Dispose of the Component and all child components.

Parameters:

Name	Type	Description
options	Object	Properties Name Type Description originalEl Element element with which to replace player element

Fires:

• Component#event:dispose

Overrides:

• Button#dispose

el() → {Element}

component.js, line 324

Get the Components DOM element

Returns:

Element -

The DOM element for this Component.

Overrides:

• Button#el

enable()

button.js, line 89

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

Overrides:

• Button#enable

enableTouchActivity()

component.js, line 1399

This function reports user activity whenever touch events happen. This can get turned off by any sub-components that wants touch events to act another way.

Report user touch activity when touch events occur. User activity gets used to determine when controls should show/hide. It is simple when it comes to mouse events, because any mouse event should show the controls. So we capture mouse events that bubble up to the player and report activity when that happens. With touch events it isn't as easy as touchstart and touchend toggle player controls. So touch events can't help us at the player level either.

User activity gets checked asynchronously. So what could happen is a tap event on the video turns the controls off. Then the touchend event bubbles up to the player. Which, if it reported user activity, would turn the controls right back on. We also don't want to completely block touch events from bubbling up. Furthermore a touchmove event and anything other than a tap, should not turn controls back on.

Listens to Events:

• Component#event:touchstart
• Component#event:touchmove
• Component#event:touchend
• Component#event:touchcancel

Overrides:

• Button#enableTouchActivity

focus()

component.js, line 1236

Set the focus to this component

Overrides:

• Button#focus

getAttribute(attribute) → {string|null}

component.js, line 983

Get the value of an attribute on the Components element.

Parameters:

Name	Type	Description
attribute	string	Name of the attribute to get the value from.

Returns:

string | null -

• The value of the attribute that was asked for. - Can be an empty string on some browsers if the attribute does not exist or has no value - Most browsers will return null if the attribute does not exist or has no value.

Overrides:

• Button#getAttribute

See:

• DOM API

getChild(name) → {Component|undefined}

component.js, line 488

Returns the child Component with the given name.

Parameters:

Name	Type	Description
name	string	The name of the child Component to get.

Returns:

Component | undefined -

The child Component with the given name or undefined.

Overrides:

• Button#getChild

getChildById(id) → {Component|undefined}

component.js, line 475

Returns the child Component with the given id.

Parameters:

Name	Type	Description
id	string	The id of the child Component to get.

Returns:

Component | undefined -

The child Component with the given id or undefined.

Overrides:

• Button#getChildById

getDescendant(…names) → {Component|undefined}

component.js, line 510

Returns the descendant Component following the givent descendant names. For instance ['foo', 'bar', 'baz'] would try to get 'foo' on the current component, 'bar' on the 'foo' component and 'baz' on the 'bar' component and return undefined if any of those don't exist.

Parameters:

Name	Type	Attributes	Description
names	...Array.<string> | string	<repeatable>	The name of the child Component to get.

Returns:

Component | undefined -

The descendant Component following the given descendant names or undefined.

Overrides:

• Button#getDescendant

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	KeyboardEvent	The keydown, tap, or click event that caused this function to be called.

Listens to Events:

• event:tap
• event:click

Overrides:

• Button#handleClick

handleKeyDown(event)

button.js, line 112

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

Parameters:

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

Listens to Events:

• event:keydown

Overrides:

• Button#handleKeyDown

handleKeyPress(event)

component.js, line 1275

Many components used to have a handleKeyPress method, which was poorly named because it listened to a keydown event. This method name now delegates to handleKeyDown. This means anyone calling handleKeyPress will not see their method calls stop working.

Parameters:

Name	Type	Description
event	Event	The event that caused this function to be called.

Overrides:

• Button#handleKeyPress

handleLanguagechange()

clickable-component.js, line 207

Handles language change in ClickableComponent for the player in components

Overrides:

• Button#handleLanguagechange

hasClass(classToCheck) → {boolean}

component.js, line 893

Check if a component's element has a CSS class name.

Parameters:

Name	Type	Description
classToCheck	string	CSS class name to check.

Returns:

boolean -

• True if the Component has the class. - False if the Component does not have the class`

Overrides:

• Button#hasClass

height(numopt, skipListenersopt) → {number|string}

component.js, line 1046

Get or set the height of the component based upon the CSS styles. See Component#dimension for more detailed information.

Parameters:

Name	Type	Attributes	Description
num	number | string	<optional>	The height that you want to set postfixed with '%', 'px' or nothing.
skipListeners	boolean	<optional>	Skip the componentresize event trigger

Returns:

number | string -

The width when getting, zero if there is no width. Can be a string postpixed with '%' or 'px'.

Overrides:

• Button#height

hide()

component.js, line 944

Hide the Components element if it is currently showing by adding the 'vjs-hidden` class name to it.

Overrides:

• Button#hide

id() → {string}

component.js, line 441

Get this Components ID

Returns:

string -

The id of this Component

Overrides:

• Button#id

initChildren()

component.js, line 668

Add and initialize default child Components based upon options.

Overrides:

• Button#initChildren

isDisposed() → {boolean}

component.js, line 284

Determine whether or not this component has been disposed.

Returns:

boolean -

If the component has been disposed, will be true. Otherwise, false.

Overrides:

• Button#isDisposed

localize(string, tokensopt, defaultValueopt) → {string}

component.js, line 385

Localize a string given the string in english.

If tokens are provided, it'll try and run a simple token replacement on the provided string. The tokens it looks for look like {1} with the index being 1-indexed into the tokens array.

If a defaultValue is provided, it'll use that over string, if a value isn't found in provided language files. This is useful if you want to have a descriptive key for token replacement but have a succinct localized string and not require en.json to be included.

Currently, it is used for the progress bar timing.

{
  "progress bar timing: currentTime={1} duration={2}": "{1} of {2}"
}

It is then used like so:

this.localize('progress bar timing: currentTime={1} duration{2}',
              [this.player_.currentTime(), this.player_.duration()],
              '{1} of {2}');

Which outputs something like: 01:23 of 24:56.

Parameters:

Name	Type	Attributes	Description
string	string		The string to localize and the key to lookup in the language files.
tokens	Array.<string>	<optional>	If the current item has token replacements, provide the tokens here.
defaultValue	string	<optional>	Defaults to string. Can be a default value to use for token replacement if the lookup key is needed to be separate.

Returns:

string -

The localized string or if no localization exists the english string.

Overrides:

• Button#localize

name() → {string}

component.js, line 452

Get the Components name. The name gets used to reference the Component and is set during registration.

Returns:

string -

The name of this Component.

Overrides:

• Button#name

off(type, fn)

component.js, line 165

Removes an event listener for a specific event from an instance of EventTarget. This makes it so that the event listener will no longer get called when the named event happens.

Parameters:

Name	Type	Description
type	string | Array.<string>	An event name or an array of event names.
fn	function	The function to remove.

Overrides:

• Button#off

on(type, fn)

component.js, line 152

Adds an event listener to an instance of an EventTarget. An event listener is a function that will get called when an event with a certain name gets triggered.

Parameters:

Name	Type	Description
type	string | Array.<string>	An event name or an array of event names.
fn	function	The function to call with EventTargets

Overrides:

• Button#on

one(type, fn)

component.js, line 178

This function will add an event listener that gets triggered only once. After the first trigger it will get removed. This is like adding an event listener with EventTarget#on that calls EventTarget#off on itself.

Parameters:

Name	Type	Description
type	string | Array.<string>	An event name or an array of event names.
fn	function	The function to be called once for each event name.

Overrides:

• Button#one

options(obj) → {Object}

component.js, line 309

Deep merge of options objects with new options.

Note: When both obj and options contain properties whose values are objects. The two properties get merged using module:obj.merge

Parameters:

Name	Type	Description
obj	Object	The object that contains new options.

Returns:

Object -

A new object of this.options_ and obj merged together.

Overrides:

• Button#options

player() → {default}

component.js, line 294

Return the Player that the Component has attached to.

Returns:

default -

The player that this Component has attached to.

Overrides:

• Button#player

ready(fn) → {Component}

component.js, line 788

Bind a listener to the component's ready state. Different from event listeners in that if the ready event has already happened it will trigger the function immediately.

Parameters:

Name	Type	Description
fn	ReadyCallback	Function that gets called when the Component is ready.

Returns:

Component -

Returns itself; method can be chained.

Overrides:

• Button#ready

removeAttribute(attribute)

component.js, line 1010

Remove an attribute from the Components element.

Parameters:

Name	Type	Description
attribute	string	Name of the attribute to remove.

Overrides:

• Button#removeAttribute

See:

• DOM API

removeChild(component)

component.js, line 629

Remove a child Component from this Components list of children. Also removes the child Components element from this Components element.

Parameters:

Name	Type	Description
component	Component	The child Component to remove.

Overrides:

• Button#removeChild

removeClass(…classesToRemove)

component.js, line 913

Remove a CSS class name from the Components element.

Parameters:

Name	Type	Attributes	Description
classesToRemove	string	<repeatable>	One or more CSS class name to remove.

Overrides:

• Button#removeClass

requestAnimationFrame(fn) → {number}

component.js, line 1590

Queues up a callback to be passed to requestAnimationFrame (rAF), but with a few extra bonuses:

• Supports browsers that do not support rAF by falling back to Component#setTimeout.

• The callback is turned into a Component~GenericCallback (i.e. bound to the component).

• Automatic cancellation of the rAF callback is handled if the component is disposed before it is called.

Parameters:

Name	Type	Description
fn	Component~GenericCallback	A function that will be bound to this component and executed just before the browser's next repaint.

Listens to Events:

• Component#event:dispose

Returns:

number -

Returns an rAF ID that gets used to identify the timeout. It can also be used in Component#cancelAnimationFrame to cancel the animation frame callback.

Overrides:

• Button#requestAnimationFrame

See:

• Similar to

requestNamedAnimationFrame(name, fn)

component.js, line 1621

Request an animation frame, but only one named animation frame will be queued. Another will never be added until the previous one finishes.

Parameters:

Name	Type	Description
name	string	The name to give this requestAnimationFrame
fn	Component~GenericCallback	A function that will be bound to this component and executed just before the browser's next repaint.

Overrides:

• Button#requestNamedAnimationFrame

setAttribute(attribute, value)

component.js, line 998

Set the value of an attribute on the Component's element

Parameters:

Name	Type	Description
attribute	string	Name of the attribute to set.
value	string	Value to set the attribute to.

Overrides:

• Button#setAttribute

See:

• DOM API

setInterval(fn, interval) → {number}

component.js, line 1529

Creates a function that gets run every x milliseconds. This function is a wrapper around window.setInterval. There are a few reasons to use this one instead though.

1. It gets cleared via Component#clearInterval when Component#dispose gets called.
2. The function callback will be a Component~GenericCallback

Parameters:

Name	Type	Description
fn	Component~GenericCallback	The function to run every x seconds.
interval	number	Execute the specified function every x milliseconds.

Listens to Events:

• Component#event:dispose

Returns:

number -

Returns an id that can be used to identify the interval. It can also be be used in Component#clearInterval to clear the interval.

Overrides:

• Button#setInterval

See:

• Similar to

setTimeout(fn, timeout) → {number}

component.js, line 1464

Creates a function that runs after an x millisecond timeout. This function is a wrapper around window.setTimeout. There are a few reasons to use this one instead though:

1. It gets cleared via Component#clearTimeout when Component#dispose gets called.
2. The function callback will gets turned into a Component~GenericCallback

Note: You can't use window.clearTimeout on the id returned by this function. This will cause its dispose listener not to get cleaned up! Please use Component#clearTimeout or Component#dispose instead.

Parameters:

Name	Type	Description
fn	Component~GenericCallback	The function that will be run after timeout.
timeout	number	Timeout in milliseconds to delay before executing the specified function.

Listens to Events:

• Component#event:dispose

Returns:

number -

Returns a timeout ID that gets used to identify the timeout. It can also get used in Component#clearTimeout to clear the timeout that was set.

Overrides:

• Button#setTimeout

See:

• Similar to

show()

component.js, line 936

Show the Components element if it is hidden by removing the 'vjs-hidden' class name from it.

Overrides:

• Button#show

toggleClass(classToToggle, predicateopt)

component.js, line 928

Add or remove a CSS class name from the component's element.

• classToToggle gets added when Component#hasClass would return false.
• classToToggle gets removed when Component#hasClass would return true.

Parameters:

Name	Type	Attributes	Description
classToToggle	string		The class to add or remove based on (@link Component#hasClass}
predicate	boolean | Dom~predicate	<optional>	An Dom~predicate function or a boolean

Overrides:

• Button#toggleClass

trigger(event)

component.js, line 210

This function causes an event to happen. This will then cause any event listeners that are waiting for that event, to get called. If there are no event listeners for an event then nothing will happen.

If the name of the Event that is being triggered is in EventTarget.allowedEvents_. Trigger will also call the on + uppercaseEventName function.

Example: 'click' is in EventTarget.allowedEvents_, so, trigger will attempt to call onClick if it exists.

Parameters:

Name	Type	Description
event	string | Event | Object	The name of the event, an Event, or an object with a key of type set to an event name.

Overrides:

• Button#trigger

triggerReady()

component.js, line 812

Trigger all the ready listeners for this Component.

Fires:

• Component#event:ready

Overrides:

• Button#triggerReady

width(numopt, skipListenersopt) → {number|string}

component.js, line 1028

Get or set the width of the component based upon the CSS styles. See Component#dimension for more detailed information.

Parameters:

Name	Type	Attributes	Description
num	number | string	<optional>	The width that you want to set postfixed with '%', 'px' or nothing.
skipListeners	boolean	<optional>	Skip the componentresize event trigger

Returns:

number | string -

The width when getting, zero if there is no width. Can be a string postpixed with '%' or 'px'.

Overrides:

• Button#width

Events

componentresize

component.js, line 1111

Triggered when a component is resized.

Type:

• Event

Overrides:

• Button#event:componentresize

dispose

component.js, line 231

Triggered when a Component is disposed.

Type:

• Event

Properties:

Name	Type	Attributes	Default	Description
bubbles	boolean	<optional>	false	set to false so that the dispose event does not bubble up

Overrides:

• Button#event:dispose

ready

component.js, line 829

Triggered when a Component is ready.

Type:

• Event

Overrides:

• Button#event:ready

tap

component.js, line 1361

Triggered when a Component is tapped.

Type:

• MouseEvent

Overrides:

• Button#event:tap