Extends

• ModalDialog

Methods

inherited overrides $(selector, context){Element|null}

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

Name	Type	Default	Description
selector	string		A valid CSS selector, which will be passed to querySelector.
context	Element | string	this.contentEl()	optional 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.

See:

• Information on CSS Selectors

Returns:

Type	Description
Element | null	the dom element that was found, or null

inherited overrides $$(selector, context){NodeList}

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

Name	Type	Default	Description
selector	string		A valid CSS selector, which will be passed to querySelectorAll.
context	Element | string	this.contentEl()	optional 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.

See:

• Information on CSS Selectors

Returns:

Type	Description
NodeList	a list of dom elements that were found

inherited overrides addChild(child, options, index){Component}

Add a child Component inside the current Component.

Name	Type	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.
index	number	this.children_.length	optional The index to attempt to add a child into.

Returns:

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

inherited overrides addClass(classesToAdd)

Add a CSS class name to the Components element.

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

inherited overrides any(type, fn)

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.

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.

inherited overrides blur()

Remove the focus from this component

overrides buildCSSClass(){string}

Builds the default DOM className.

Deprecated

• Since version 5.

Returns:

Type	Description
string	The DOM className for this object.

inherited overrides cancelAnimationFrame(id){number}

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!

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

See:

• Similar to

Returns:

Type	Description
number	Returns the rAF ID that was cleared.

inherited overrides cancelNamedAnimationFrame(name)

Cancels a current named animation frame if it exists.

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

inherited overrides children(){Array}

Get an array of all child components

Returns:

Type	Description
Array	The children

inherited overrides clearInterval(intervalId){number}

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!

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

See:

• Similar to

Returns:

Type	Description
number	Returns the interval id that was cleared.

inherited overrides clearTimeout(timeoutId){number}

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!

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

See:

• Similar to

Returns:

Type	Description
number	Returns the timeout id that was cleared.

inherited overrides close()

Closes the modal, does nothing if the ModalDialog is not open.

Fires:

• ModalDialog#event:beforemodalclose
• ModalDialog#event:modalclose

inherited overrides closeable(value){boolean}

Check to see if the ModalDialog is closeable via the UI.

Name	Type	Description
value	boolean	optional If given as a boolean, it will set the closeable option.

Returns:

Type	Description
boolean	Returns the final value of the closable option.

overrides content(){string}

Gets the localized error message based on the Players error.

Returns:

Type	Description
string	The Players error message localized or an empty string.

inherited overrides contentEl(){Element}

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:

Type	Description
Element	The content element for this Component.

inherited overrides createEl(){Element}

Create the ModalDialog's DOM element

Returns:

Type	Description
Element	The DOM element that gets created.

inherited overrides currentDimension(widthOrHeight){number}

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

Uses window.getComputedStyle.

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

Returns:

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

inherited overrides currentDimensions(){Component~DimensionObject}

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

Uses window.getComputedStyle.

Returns:

Type	Description
Component~DimensionObject	The computed dimensions of the component's element.

inherited overrides currentHeight(){number}

Get the computed height of the component's element.

Uses window.getComputedStyle.

Returns:

Type	Description
number	The computed height of the component's element.

inherited overrides currentWidth(){number}

Get the computed width of the component's element.

Uses window.getComputedStyle.

Returns:

Type	Description
number	The computed width of the component's element.

inherited overrides description(){string}

Returns the description string for this modal. Primarily used for accessibility.

Returns:

Type	Description
string	The localized or raw description of this modal.

inherited overrides dimension(widthOrHeight, num, skipListeners){number|undefined}

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

Name	Type	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:

Type	Description
number | undefined	The dimension when getting or 0 if unset

inherited overrides dimensions(width, height)

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

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

inherited overrides dispose(options)

Dispose of the Component and all child components.

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

Fires:

• Component#event:dispose

inherited overrides el(){Element}

Get the Components DOM element

Returns:

Type	Description
Element	The DOM element for this Component.

inherited overrides protectedemitTapEvents()

Emit a 'tap' events when touch event support gets detected. This gets used to support toggling the controls through a tap on the video. They get enabled because every sub-component would have extra overhead otherwise.

Fires:

• Component#event:tap

Listens to Events:

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

inherited overrides empty()

Empties the content element. This happens anytime the modal is filled.

Fires:

• ModalDialog#event:beforemodalempty
• ModalDialog#event:modalempty

inherited overrides enableTouchActivity()

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

inherited overrides fill()

Fill the modal's content element with the modal's "content" option. The content element will be emptied before this change takes place.

inherited overrides fillWith(content)

Fill the modal's content element with arbitrary content. The content element will be emptied before this change takes place.

Name	Type	Description
content	ContentDescriptor	optional The same rules apply to this as apply to the content option.

Fires:

• ModalDialog#event:beforemodalfill
• ModalDialog#event:modalfill

inherited overrides focus()

Set the focus to this component

inherited overrides getAttribute(attribute){string|null}

Get the value of an attribute on the Components element.

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

See:

• DOM API

Returns:

Type	Description
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.

inherited overrides getChild(name){Component|undefined}

Returns the child Component with the given name.

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

Returns:

Type	Description
Component | undefined	The child Component with the given name or undefined.

inherited overrides getChildById(id){Component|undefined}

Returns the child Component with the given id.

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

Returns:

Type	Description
Component | undefined	The child Component with the given id or undefined.

inherited overrides getDescendant(names){Component|undefined}

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.

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

Returns:

Type	Description
Component | undefined	The descendant Component following the given descendant names or undefined.

inherited overrides getIsAvailableToBeFocused(el){boolean}

Determine whether or not this component is currently visible/enabled/etc...

Name	Type	Description
el	HTMLElement	The HTML element representing the component.

Returns:

Type	Description
boolean	If the component can is currently visible & enabled, will be true. Otherwise, false.

inherited overrides getIsFocusable(el){boolean}

Determine whether or not this component can be considered as focusable component.

Name	Type	Description
el	HTMLElement	The HTML element representing the component.

Returns:

Type	Description
boolean	If the component can be focused, will be true. Otherwise, false.

inherited overrides getPositions(){Object}

Retrieves the position and size information of the component's element.

Returns:

Type	Description
Object	An object with boundingClientRect and center properties. - boundingClientRect: An object with properties x, y, width, height, top, right, bottom, and left, representing the bounding rectangle of the element. - center: An object with properties x and y, representing the center point of the element. width and height are set to 0.

inherited overrides handleKeyDown()

Keydown handler. Attached when modal is focused.

Listens to Events:

• event:keydown

inherited overrides handleKeyPress(event)

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.

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

inherited overrides abstracthandleLanguagechange()

Handles language change for the player in components. Should be overridden by sub-components.

inherited overrides hasClass(classToCheck){boolean}

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

Name	Type	Description
classToCheck	string	CSS class name to check.

Returns:

Type	Description
boolean	True if the Component has the class. - False if the Component does not have the class`

inherited overrides height(num, skipListeners){number|undefined}

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

Name	Type	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:

Type	Description
number | undefined	The height when getting, zero if there is no height

inherited overrides hide()

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

inherited overrides id(){string}

Get this Components ID

Returns:

Type	Description
string	The id of this Component

inherited overrides initChildren()

Add and initialize default child Components based upon options.

inherited overrides isDisposed(){boolean}

Determine whether or not this component has been disposed.

Returns:

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

inherited overrides label(){string}

Returns the label string for this modal. Primarily used for accessibility.

Returns:

Type	Description
string	the localized or raw label of this modal.

inherited overrides localize(string, tokens, defaultValue){string}

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.

Name	Type	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:

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

inherited overrides name(){string}

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

Returns:

Type	Description
string	The name of this Component.

inherited overrides off(type, fn)

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.

Name	Type	Description
type	string | Array.<string>	An event name or an array of event names.
fn	function	optional The function to remove. If not specified, all listeners managed by Video.js will be removed.

inherited overrides on(type, fn)

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.

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

inherited overrides one(type, fn)

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.

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.

inherited overrides open()

Opens the modal.

Fires:

• ModalDialog#event:beforemodalopen
• ModalDialog#event:modalopen

inherited overrides opened(value){boolean}

If the ModalDialog is currently open or closed.

Name	Type	Description
value	boolean	optional If given, it will open (true) or close (false) the modal.

Returns:

Type	Description
boolean	the current open state of the modaldialog

inherited overrides options(obj){Object}

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

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

Returns:

Type	Description
Object	A new object of this.options_ and obj merged together.

inherited overrides player(){Player}

Return the Player that the Component has attached to.

Returns:

Type	Description
Player	The player that this Component has attached to.

inherited overrides ready(fn)

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.

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

inherited overrides removeAttribute(attribute)

Remove an attribute from the Components element.

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

See:

• DOM API

inherited overrides removeChild(component)

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

Name	Type	Description
component	Component	The child Component to remove.

inherited overrides removeClass(classesToRemove)

Remove a CSS class name from the Components element.

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

inherited overrides requestAnimationFrame(fn){number}

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.

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

See:

• Similar to

Listens to Events:

• Component#event:dispose

Returns:

Type	Description
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.

inherited overrides requestNamedAnimationFrame(name, fn)

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

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.

inherited overrides setAttribute(attribute, value)

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

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

See:

• DOM API

inherited overrides setIcon(iconName, el){Element}

Adds an SVG icon element to another element or component.

Name	Type	Default	Description
iconName	string		The name of icon. A list of all the icon names can be found at 'sandbox/svg-icons.html'
el	Element	this.el()	optional Element to set the title on. Defaults to the current Component's element.

Returns:

Type	Description
Element	The newly created icon element.

inherited overrides setInterval(fn, interval){number}

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

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

See:

• Similar to

Listens to Events:

• Component#event:dispose

Returns:

Type	Description
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.

inherited overrides setTimeout(fn, timeout){number}

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.

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.

See:

• Similar to

Listens to Events:

• Component#event:dispose

Returns:

Type	Description
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.

inherited overrides show()

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

inherited overrides toggleClass(classToToggle, predicate)

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.

Name	Type	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

inherited overrides trigger(event, hash)

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.

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.
hash	Object	optional Optionally extra argument to pass through to an event listener

inherited overrides triggerReady()

Trigger all the ready listeners for this Component.

Fires:

• Component#event:ready

inherited overrides width(num, skipListeners){number|undefined}

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

Name	Type	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:

Type	Description
number | undefined	The width when getting, zero if there is no width

Events

inherited overrides aftermodalfill

Fired after ModalDialog is re-filled with content & close button is appended.

Type:

• Event

inherited overrides beforemodalclose

Fired just before a ModalDialog is closed.

Type:

• Event

inherited overrides beforemodalempty

Fired just before a ModalDialog is emptied.

Type:

• Event

inherited overrides beforemodalfill

Fired just before a ModalDialog is filled with content.

Type:

• Event

inherited overrides beforemodalopen

Fired just before a ModalDialog is opened.

Type:

• Event

inherited overrides componentresize

Triggered when a component is resized.

Type:

• Event

inherited overrides dispose

Triggered when a Component is disposed.

Type:

• Event

Properties:

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

inherited overrides modalclose

Fired just after a ModalDialog is closed.

Type:

• Event

Properties:

Name	Type	Argument	Default	Description
bubbles	boolean	<optional>	true

inherited overrides modalempty

Fired just after a ModalDialog is emptied.

Type:

• Event

inherited overrides modalfill

Fired just after a ModalDialog is filled with content.

Type:

• Event

inherited overrides modalKeydown

Fired a custom keyDown event that bubbles.

Type:

• Event

inherited overrides modalopen

Fired just after a ModalDialog is opened.

Type:

• Event

inherited overrides ready

Triggered when a Component is ready.

Type:

• Event

inherited overrides tap

Triggered when a Component is tapped.

Type:

• MouseEvent