DescriptionsButton

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

Hide the menu if the number of items is less than or equal to this threshold. This defaults to 0 and whenever we add items which can be hidden to the menu we'll increment it. We list it here because every time we run createMenu we need to reset the value.

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

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

Add a child Component inside the current Component.

Add a CSS class name to the Components element.

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.

Remove the focus from the actual button, not this element

Builds the default DOM className.

Allow sub components to stack CSS class names for the wrapper element

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!

Cancels a current named animation frame if it exists.

Get an array of all child components

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!

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!

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.

Get or set the localized control text that will be used for accessibility.

NOTE: This will come from the internal menuButton_ element.

Create the MenuButtonss DOM element.

Create a menu item for each text track

Create the menu and add all items to it.

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

Uses window.getComputedStyle.

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

Uses window.getComputedStyle.

Get the computed height of the component's element.

Uses window.getComputedStyle.

Get the computed width of the component's element.

Uses window.getComputedStyle.

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

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

Disable the MenuButton. Don't allow it to be clicked.

Dispose of the menu-button and all child components.

Get the Components DOM element

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.

Enable the MenuButton. Allow it to be clicked.

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.

Set the focus to the actual button, not to this element

Get the value of an attribute on the Components element.

Returns the child Component with the given name.

Returns the child Component with the given id.

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.

Handle a click on a MenuButton. See ClickableComponent#handleClick for instances where this is called.

Handle tab, escape, down arrow, and up arrow keys for MenuButton. See ClickableComponent#handleKeyDown for instances where this is called.

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.

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

Handle a keyup event on a MenuButton. The listener for this is added in the constructor.

Handle mouseleave for MenuButton.

Handle a keydown event on a sub-menu. The listener for this is added in the constructor.

This method name now delegates to handleSubmenuKeyDown. This means anyone calling handleSubmenuKeyPress will not see their method calls stop working.

Handle text track change

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

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

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

Get this Components ID

Add and initialize default child Components based upon options.

Determine whether or not this component has been disposed.

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.

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

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.

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.

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.

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

Return the Player that the Component has attached to.

Put the current MenuButton into a pressed state.

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.

Remove an attribute from the Components element.

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

Remove a CSS class name from the Components element.

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.

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

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

Overwrites the setIcon method from Component. In this case, we want the icon to be appended to the menuButton.

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

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.

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

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.

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.

Trigger all the ready listeners for this Component.

Take the current MenuButton out of a pressed state.

Update the menu based on the current state of its items.

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

Triggered when a component is resized.

Triggered when a Component is disposed.

Triggered when a Component is ready.

Triggered when a Component is tapped.