- new Component(player, optionsopt, readyopt)
- Methods
- static getComponent(name) → { Component }
- static registerComponent(name, ComponentToRegister) → { Component }
- $(selector, contextopt) → {Element|null}
- $$(selector, contextopt) → {NodeList}
- addChild(child, optionsopt, indexopt) → { Component }
- addClass(classToAdd)
- blur()
- abstract buildCSSClass() → {string}
- cancelAnimationFrame(id) → {number}
- cancelNamedAnimationFrame(name)
- children() → {Array}
- clearInterval(intervalId) → {number}
- clearTimeout(timeoutId) → {number}
- contentEl() → {Element}
- createEl(tagNameopt, propertiesopt, attributesopt) → {Element}
- currentDimension(widthOrHeight) → {number}
- currentDimensions() → { Component~DimensionObject }
- currentHeight() → {number}
- currentWidth() → {number}
- dimension(widthOrHeight, numopt, skipListenersopt) → {number}
- dimensions(width, height)
- dispose()
- el() → {Element}
- enableTouchActivity()
- focus()
- getAttribute(attribute) → {string|null}
- getChild(name) → { Component |undefined}
- getChildById(id) → { Component |undefined}
- getDescendant(…names) → { Component |undefined}
- handleKeyDown(event)
- handleKeyPress(event)
- abstract handleLanguagechange()
- hasClass(classToCheck) → {boolean}
- height(numopt, skipListenersopt) → {number|string}
- hide()
- id() → {string}
- initChildren()
- isDisposed() → {boolean}
- localize(string, tokensopt, defaultValueopt) → {string}
- name() → {string}
- options(obj) → {Object}
- player() → { Player }
- ready() → { Component }
- removeAttribute(attribute)
- removeChild(component)
- removeClass(classToRemove)
- requestAnimationFrame(fn) → {number}
- requestNamedAnimationFrame(name, fn)
- setAttribute(attribute, value)
- setInterval(fn, interval) → {number}
- setTimeout(fn, timeout) → {number}
- show()
- toggleClass(classToToggle, predicateopt)
- triggerReady()
- width(numopt, skipListenersopt) → {number|string}
- Type Definitions
- Events
new Component(player, optionsopt, readyopt)
[component.js](https://docs.videojs.com/component.js.html)
, [line 27](https://docs.videojs.com/component.js.html#line27)
Creates an instance of this class.
Parameters:
Name | Type | Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
player | Player | The | |||||||||
options | Object | <optional> | The key/value store of player options. Properties
| ||||||||
ready | Component~ReadyCallback | <optional> | Function that gets called when the |
Methods
static getComponent(name) → {Component}
[component.js](https://docs.videojs.com/component.js.html)
, [line 1719](https://docs.videojs.com/component.js.html#line1719)
Get a Component
based on the name it was registered with.
Parameters:
Name | Type | Description |
---|---|---|
name | string | The Name of the component to get. |
Returns:
The Component
that got registered under the given name.
Deprecated:
- In `videojs` 6 this will not return `Component`s that were not registered using Component.registerComponent. Currently we check the global `videojs` object for a `Component` name and return that if it exists.
static registerComponent(name, ComponentToRegister) → {Component}
[component.js](https://docs.videojs.com/component.js.html)
, [line 1652](https://docs.videojs.com/component.js.html#line1652)
Register a Component
with videojs
given the name and the component.
NOTE: Techs should not be registered as a
Component
. Techs should be registered using Tech.registerTech or videojs:videojs.registerTech.NOTE: This function can also be seen on videojs as videojs:videojs.registerComponent.
Parameters:
Name | Type | Description |
---|---|---|
name | string | The name of the |
ComponentToRegister | Component | The |
Returns:
The Component
that was registered.
$(selector, contextopt) → {Element|null}
[component.js](https://docs.videojs.com/component.js.html)
, [line 767](https://docs.videojs.com/component.js.html#line767)
Find a single DOM element matching a selector
. This can be within the Component
s contentEl()
or another custom context.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
selector | string | A valid CSS selector, which will be passed to | ||
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 |
Returns:
Element | null -
the dom element that was found, or null
$$(selector, contextopt) → {NodeList}
[component.js](https://docs.videojs.com/component.js.html)
, [line 789](https://docs.videojs.com/component.js.html#line789)
Finds all DOM element matching a selector
. This can be within the Component
s contentEl()
or another custom context.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
selector | string | A valid CSS selector, which will be passed to | ||
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 |
Returns:
NodeList -
a list of dom elements that were found
addChild(child, optionsopt, indexopt) → {Component}
[component.js](https://docs.videojs.com/component.js.html)
, [line 458](https://docs.videojs.com/component.js.html#line458)
Add a child Component
inside the current Component
.
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. |
index | number | <optional> | this.children_.length | The index to attempt to add a child into. |
Returns:
The Component
that gets added as a child. When using a string the Component
will get created by this process.
addClass(classToAdd)
[component.js](https://docs.videojs.com/component.js.html)
, [line 813](https://docs.videojs.com/component.js.html#line813)
Add a CSS class name to the Component
s element.
Parameters:
Name | Type | Description |
---|---|---|
classToAdd | string | CSS class name to add |
blur()
[component.js](https://docs.videojs.com/component.js.html)
, [line 1153](https://docs.videojs.com/component.js.html#line1153)
Remove the focus from this component
abstract buildCSSClass() → {string}
[component.js](https://docs.videojs.com/component.js.html)
, [line 684](https://docs.videojs.com/component.js.html#line684)
Builds the default DOM class name. Should be overriden by sub-components.
Returns:
string -
The DOM class name for this object.
cancelAnimationFrame(id) → {number}
[component.js](https://docs.videojs.com/component.js.html)
, [line 1585](https://docs.videojs.com/component.js.html#line1585)
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.
See:
cancelNamedAnimationFrame(name)
[component.js](https://docs.videojs.com/component.js.html)
, [line 1560](https://docs.videojs.com/component.js.html#line1560)
Cancels a current named animation frame if it exists.
Parameters:
Name | Type | Description |
---|---|---|
name | string | The name of the requestAnimationFrame to cancel. |
children() → {Array}
[component.js](https://docs.videojs.com/component.js.html)
, [line 375](https://docs.videojs.com/component.js.html#line375)
Get an array of all child components
Returns:
Array -
The children
clearInterval(intervalId) → {number}
[component.js](https://docs.videojs.com/component.js.html)
, [line 1464](https://docs.videojs.com/component.js.html#line1464)
Clears an interval that gets created via window.setInterval
or Component#setInterval. If you set an inteval 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 |
Returns:
number -
Returns the interval id that was cleared.
See:
clearTimeout(timeoutId) → {number}
[component.js](https://docs.videojs.com/component.js.html)
, [line 1408](https://docs.videojs.com/component.js.html#line1408)
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 |
Returns:
number -
Returns the timeout id that was cleared.
See:
contentEl() → {Element}
[component.js](https://docs.videojs.com/component.js.html)
, [line 344](https://docs.videojs.com/component.js.html#line344)
Return the Component
s 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
.
createEl(tagNameopt, propertiesopt, attributesopt) → {Element}
[component.js](https://docs.videojs.com/component.js.html)
, [line 256](https://docs.videojs.com/component.js.html#line256)
Create the Component
s DOM element.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
tagName | string | <optional> | Element’s DOM node type. e.g. ‘div’ |
properties | Object | <optional> | An object of properties that should be set. |
attributes | Object | <optional> | An object of attributes that should be set. |
Returns:
Element -
The element that gets created.
currentDimension(widthOrHeight) → {number}
[component.js](https://docs.videojs.com/component.js.html)
, [line 1066](https://docs.videojs.com/component.js.html#line1066)
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.
currentDimensions() → {Component~DimensionObject}
[component.js](https://docs.videojs.com/component.js.html)
, [line 1112](https://docs.videojs.com/component.js.html#line1112)
Get an object that contains computed width and height values of the component’s element.
Uses window.getComputedStyle
.
Returns:
The computed dimensions of the component’s element.
currentHeight() → {number}
[component.js](https://docs.videojs.com/component.js.html)
, [line 1139](https://docs.videojs.com/component.js.html#line1139)
Get the computed height of the component’s element.
Uses window.getComputedStyle
.
Returns:
number -
The computed height of the component’s element.
currentWidth() → {number}
[component.js](https://docs.videojs.com/component.js.html)
, [line 1127](https://docs.videojs.com/component.js.html#line1127)
Get the computed width of the component’s element.
Uses window.getComputedStyle
.
Returns:
number -
The computed width of the component’s element.
dimension(widthOrHeight, numopt, skipListenersopt) → {number}
[component.js](https://docs.videojs.com/component.js.html)
, [line 1003](https://docs.videojs.com/component.js.html#line1003)
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 theComponent
sstyle.width
and falls back towindow.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:
Returns:
number -
The dimension when getting or 0 if unset
dimensions(width, height)
[component.js](https://docs.videojs.com/component.js.html)
, [line 969](https://docs.videojs.com/component.js.html#line969)
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 |
height | number | string | Height to set the |
dispose()
[component.js](https://docs.videojs.com/component.js.html)
, [line 134](https://docs.videojs.com/component.js.html#line134)
Dispose of the Component
and all child components.
Fires:
el() → {Element}
[component.js](https://docs.videojs.com/component.js.html)
, [line 237](https://docs.videojs.com/component.js.html#line237)
Get the Component
s DOM element
Returns:
Element -
The DOM element for this Component
.
enableTouchActivity()
[component.js](https://docs.videojs.com/component.js.html)
, [line 1307](https://docs.videojs.com/component.js.html#line1307)
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
focus()
[component.js](https://docs.videojs.com/component.js.html)
, [line 1146](https://docs.videojs.com/component.js.html#line1146)
Set the focus to this component
getAttribute(attribute) → {string|null}
[component.js](https://docs.videojs.com/component.js.html)
, [line 893](https://docs.videojs.com/component.js.html#line893)
Get the value of an attribute on the Component
s 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 attibute does not exist or has no value.
See:
getChild(name) → {Component|undefined}
[component.js](https://docs.videojs.com/component.js.html)
, [line 401](https://docs.videojs.com/component.js.html#line401)
Returns the child Component
with the given name
.
Parameters:
Name | Type | Description |
---|---|---|
name | string | The name of the child |
Returns:
Component | undefined -
The child Component
with the given name
or undefined.
getChildById(id) → {Component|undefined}
[component.js](https://docs.videojs.com/component.js.html)
, [line 388](https://docs.videojs.com/component.js.html#line388)
Returns the child Component
with the given id
.
Parameters:
Name | Type | Description |
---|---|---|
id | string | The id of the child |
Returns:
Component | undefined -
The child Component
with the given id
or undefined.
getDescendant(…names) → {Component|undefined}
[component.js](https://docs.videojs.com/component.js.html)
, [line 423](https://docs.videojs.com/component.js.html#line423)
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 |
Returns:
Component | undefined -
The descendant Component
following the given descendant names
or undefined.
handleKeyDown(event)
[component.js](https://docs.videojs.com/component.js.html)
, [line 1164](https://docs.videojs.com/component.js.html#line1164)
When this Component receives a keydown
event which it does not process, it passes the event to the Player for handling.
Parameters:
Name | Type | Description |
---|---|---|
event | EventTarget~Event | The |
handleKeyPress(event)
[component.js](https://docs.videojs.com/component.js.html)
, [line 1183](https://docs.videojs.com/component.js.html#line1183)
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 | EventTarget~Event | The event that caused this function to be called. |
abstract handleLanguagechange()
[component.js](https://docs.videojs.com/component.js.html)
, [line 335](https://docs.videojs.com/component.js.html#line335)
Handles language change for the player in components. Should be overriden by sub-components.
hasClass(classToCheck) → {boolean}
[component.js](https://docs.videojs.com/component.js.html)
, [line 803](https://docs.videojs.com/component.js.html#line803)
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 theComponent
does not have the class`
height(numopt, skipListenersopt) → {number|string}
[component.js](https://docs.videojs.com/component.js.html)
, [line 956](https://docs.videojs.com/component.js.html#line956)
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’.
hide()
[component.js](https://docs.videojs.com/component.js.html)
, [line 854](https://docs.videojs.com/component.js.html#line854)
Hide the Component
s element if it is currently showing by adding the ‘vjs-hidden` class name to it.
id() → {string}
[component.js](https://docs.videojs.com/component.js.html)
, [line 354](https://docs.videojs.com/component.js.html#line354)
Get this Component
s ID
Returns:
string -
The id of this Component
initChildren()
[component.js](https://docs.videojs.com/component.js.html)
, [line 581](https://docs.videojs.com/component.js.html#line581)
Add and initialize default child Component
s based upon options.
isDisposed() → {boolean}
[component.js](https://docs.videojs.com/component.js.html)
, [line 197](https://docs.videojs.com/component.js.html#line197)
Determine whether or not this component has been disposed.
Returns:
boolean -
If the component has been disposed, will be true
. Otherwise, false
.
localize(string, tokensopt, defaultValueopt) → {string}
[component.js](https://docs.videojs.com/component.js.html)
, [line 298](https://docs.videojs.com/component.js.html#line298)
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 |
Returns:
string -
The localized string or if no localization exists the english string.
name() → {string}
[component.js](https://docs.videojs.com/component.js.html)
, [line 365](https://docs.videojs.com/component.js.html#line365)
Get the Component
s name. The name gets used to reference the Component
and is set during registration.
Returns:
string -
The name of this Component
.
options(obj) → {Object}
[component.js](https://docs.videojs.com/component.js.html)
, [line 222](https://docs.videojs.com/component.js.html#line222)
Deep merge of options objects with new options.
Note: When both
obj
andoptions
contain properties whose values are objects. The two properties get merged using module:mergeOptions
Parameters:
Name | Type | Description |
---|---|---|
obj | Object | The object that contains new options. |
Returns:
Object -
A new object of this.options_
and obj
merged together.
player() → {Player}
[component.js](https://docs.videojs.com/component.js.html)
, [line 207](https://docs.videojs.com/component.js.html#line207)
Return the Player that the Component
has attached to.
Returns:
Player -
The player that this Component
has attached to.
ready() → {Component}
[component.js](https://docs.videojs.com/component.js.html)
, [line 698](https://docs.videojs.com/component.js.html#line698)
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.
Returns:
Returns itself; method can be chained.
removeAttribute(attribute)
[component.js](https://docs.videojs.com/component.js.html)
, [line 920](https://docs.videojs.com/component.js.html#line920)
Remove an attribute from the Component
s element.
Parameters:
Name | Type | Description |
---|---|---|
attribute | string | Name of the attribute to remove. |
See:
removeChild(component)
[component.js](https://docs.videojs.com/component.js.html)
, [line 542](https://docs.videojs.com/component.js.html#line542)
Remove a child Component
from this Component
s list of children. Also removes the child Component
s element from this Component
s element.
Parameters:
Name | Type | Description |
---|---|---|
component | Component | The child |
removeClass(classToRemove)
[component.js](https://docs.videojs.com/component.js.html)
, [line 823](https://docs.videojs.com/component.js.html#line823)
Remove a CSS class name from the Component
s element.
Parameters:
Name | Type | Description |
---|---|---|
classToRemove | string | CSS class name to remove |
requestAnimationFrame(fn) → {number}
[component.js](https://docs.videojs.com/component.js.html)
, [line 1498](https://docs.videojs.com/component.js.html#line1498)
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:
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.
See:
requestNamedAnimationFrame(name, fn)
[component.js](https://docs.videojs.com/component.js.html)
, [line 1534](https://docs.videojs.com/component.js.html#line1534)
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. |
setAttribute(attribute, value)
[component.js](https://docs.videojs.com/component.js.html)
, [line 908](https://docs.videojs.com/component.js.html#line908)
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. |
See:
setInterval(fn, interval) → {number}
[component.js](https://docs.videojs.com/component.js.html)
, [line 1437](https://docs.videojs.com/component.js.html#line1437)
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.
- It gets cleared via Component#clearInterval when Component#dispose gets called.
- The function callback will be a Component~GenericCallback
Parameters:
Name | Type | Description |
---|---|---|
fn | Component~GenericCallback | The function to run every |
interval | number | Execute the specified function every |
Listens to Events:
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.
See:
setTimeout(fn, timeout) → {number}
[component.js](https://docs.videojs.com/component.js.html)
, [line 1372](https://docs.videojs.com/component.js.html#line1372)
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:
- It gets cleared via Component#clearTimeout when Component#dispose gets called.
- 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 | number | Timeout in milliseconds to delay before executing the specified function. |
Listens to Events:
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.
See:
show()
[component.js](https://docs.videojs.com/component.js.html)
, [line 846](https://docs.videojs.com/component.js.html#line846)
Show the Component
s element if it is hidden by removing the ‘vjs-hidden’ class name from it.
toggleClass(classToToggle, predicateopt)
[component.js](https://docs.videojs.com/component.js.html)
, [line 838](https://docs.videojs.com/component.js.html#line838)
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 |
triggerReady()
[component.js](https://docs.videojs.com/component.js.html)
, [line 722](https://docs.videojs.com/component.js.html#line722)
Trigger all the ready listeners for this Component
.
Fires:
width(numopt, skipListenersopt) → {number|string}
[component.js](https://docs.videojs.com/component.js.html)
, [line 938](https://docs.videojs.com/component.js.html#line938)
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’.
Type Definitions
DimensionObject
[component.js](https://docs.videojs.com/component.js.html)
, [line 1090](https://docs.videojs.com/component.js.html#line1090)
An object that contains width and height values of the Component
s computed style. Uses window.getComputedStyle
.
Properties:
Name | Type | Description |
---|---|---|
width | number | The width of the |
height | number | The height of the |
GenericCallback()
[component.js](https://docs.videojs.com/component.js.html)
, [line 1339](https://docs.videojs.com/component.js.html#line1339)
A callback that has no parameters and is bound into Component
s context.
This:
ReadyCallback()
[component.js](https://docs.videojs.com/component.js.html)
, [line 29](https://docs.videojs.com/component.js.html#line29)
A callback that is called when a component is ready. Does not have any paramters and any callback value will be ignored.
This:
Events
componentresize
[component.js](https://docs.videojs.com/component.js.html)
, [line 1021](https://docs.videojs.com/component.js.html#line1021)
Triggered when a component is resized.
Type:
dispose
[component.js](https://docs.videojs.com/component.js.html)
, [line 145](https://docs.videojs.com/component.js.html#line145)
Triggered when a Component
is disposed.
Type:
Listeners of This Event:
- AudioTrackButton#requestAnimationFrame
- AudioTrackButton#setInterval
- AudioTrackButton#setTimeout
- AudioTrackMenuItem#requestAnimationFrame
- AudioTrackMenuItem#setInterval
- AudioTrackMenuItem#setTimeout
- BigPlayButton#requestAnimationFrame
- BigPlayButton#setInterval
- BigPlayButton#setTimeout
- Button#requestAnimationFrame
- Button#setInterval
- Button#setTimeout
- CaptionsButton#requestAnimationFrame
- CaptionsButton#setInterval
- CaptionsButton#setTimeout
- CaptionSettingsMenuItem#requestAnimationFrame
- CaptionSettingsMenuItem#setInterval
- CaptionSettingsMenuItem#setTimeout
- ChaptersButton#requestAnimationFrame
- ChaptersButton#setInterval
- ChaptersButton#setTimeout
- ChaptersTrackMenuItem#requestAnimationFrame
- ChaptersTrackMenuItem#setInterval
- ChaptersTrackMenuItem#setTimeout
- ClickableComponent#requestAnimationFrame
- ClickableComponent#setInterval
- ClickableComponent#setTimeout
- CloseButton#requestAnimationFrame
- CloseButton#setInterval
- CloseButton#setTimeout
- Component#requestAnimationFrame
- Component#setInterval
- Component#setTimeout
- ControlBar#requestAnimationFrame
- ControlBar#setInterval
- ControlBar#setTimeout
- CurrentTimeDisplay#requestAnimationFrame
- CurrentTimeDisplay#setInterval
- CurrentTimeDisplay#setTimeout
- CustomControlSpacer#requestAnimationFrame
- CustomControlSpacer#setInterval
- CustomControlSpacer#setTimeout
- DescriptionsButton#requestAnimationFrame
- DescriptionsButton#setInterval
- DescriptionsButton#setTimeout
- DurationDisplay#requestAnimationFrame
- DurationDisplay#setInterval
- DurationDisplay#setTimeout
- ErrorDisplay#requestAnimationFrame
- ErrorDisplay#setInterval
- ErrorDisplay#setTimeout
- FullscreenToggle#requestAnimationFrame
- FullscreenToggle#setInterval
- FullscreenToggle#setTimeout
- Html5#requestAnimationFrame
- Html5#setInterval
- Html5#setTimeout
- LiveDisplay#requestAnimationFrame
- LiveDisplay#setInterval
- LiveDisplay#setTimeout
- LoadingSpinner#requestAnimationFrame
- LoadingSpinner#setInterval
- LoadingSpinner#setTimeout
- LoadProgressBar#requestAnimationFrame
- LoadProgressBar#setInterval
- LoadProgressBar#setTimeout
- MediaLoader#requestAnimationFrame
- MediaLoader#setInterval
- MediaLoader#setTimeout
- Menu#requestAnimationFrame
- Menu#setInterval
- Menu#setTimeout
- MenuButton#requestAnimationFrame
- MenuButton#setInterval
- MenuButton#setTimeout
- MenuItem#requestAnimationFrame
- MenuItem#setInterval
- MenuItem#setTimeout
- ModalDialog#requestAnimationFrame
- ModalDialog#setInterval
- ModalDialog#setTimeout
- MouseTimeDisplay#requestAnimationFrame
- MouseTimeDisplay#setInterval
- MouseTimeDisplay#setTimeout
- MouseVolumeLevelDisplay#requestAnimationFrame
- MouseVolumeLevelDisplay#setInterval
- MouseVolumeLevelDisplay#setTimeout
- MuteToggle#requestAnimationFrame
- MuteToggle#setInterval
- MuteToggle#setTimeout
- OffTextTrackMenuItem#requestAnimationFrame
- OffTextTrackMenuItem#setInterval
- OffTextTrackMenuItem#setTimeout
- PictureInPictureToggle#requestAnimationFrame
- PictureInPictureToggle#setInterval
- PictureInPictureToggle#setTimeout
- PlaybackRateMenuButton#requestAnimationFrame
- PlaybackRateMenuButton#setInterval
- PlaybackRateMenuButton#setTimeout
- PlaybackRateMenuItem#requestAnimationFrame
- PlaybackRateMenuItem#setInterval
- PlaybackRateMenuItem#setTimeout
- Player#requestAnimationFrame
- Player#setInterval
- Player#setTimeout
- PlayProgressBar#requestAnimationFrame
- PlayProgressBar#setInterval
- PlayProgressBar#setTimeout
- PlayToggle#requestAnimationFrame
- PlayToggle#setInterval
- PlayToggle#setTimeout
- PosterImage#requestAnimationFrame
- PosterImage#setInterval
- PosterImage#setTimeout
- ProgressControl#requestAnimationFrame
- ProgressControl#setInterval
- ProgressControl#setTimeout
- RemainingTimeDisplay#requestAnimationFrame
- RemainingTimeDisplay#setInterval
- RemainingTimeDisplay#setTimeout
- ResizeManager#requestAnimationFrame
- ResizeManager#setInterval
- ResizeManager#setTimeout
- SeekBar#requestAnimationFrame
- SeekBar#setInterval
- SeekBar#setTimeout
- SeekToLive#requestAnimationFrame
- SeekToLive#setInterval
- SeekToLive#setTimeout
- Slider#requestAnimationFrame
- Slider#setInterval
- Slider#setTimeout
- Spacer#requestAnimationFrame
- Spacer#setInterval
- Spacer#setTimeout
- SubsCapsButton#requestAnimationFrame
- SubsCapsButton#setInterval
- SubsCapsButton#setTimeout
- SubsCapsMenuItem#requestAnimationFrame
- SubsCapsMenuItem#setInterval
- SubsCapsMenuItem#setTimeout
- SubtitlesButton#requestAnimationFrame
- SubtitlesButton#setInterval
- SubtitlesButton#setTimeout
- Tech#requestAnimationFrame
- Tech#setInterval
- Tech#setTimeout
- TextTrackButton#requestAnimationFrame
- TextTrackButton#setInterval
- TextTrackButton#setTimeout
- TextTrackDisplay#requestAnimationFrame
- TextTrackDisplay#setInterval
- TextTrackDisplay#setTimeout
- TextTrackMenuItem#requestAnimationFrame
- TextTrackMenuItem#setInterval
- TextTrackMenuItem#setTimeout
- TextTrackSettings#requestAnimationFrame
- TextTrackSettings#setInterval
- TextTrackSettings#setTimeout
- TimeDisplay#requestAnimationFrame
- TimeDisplay#setInterval
- TimeDisplay#setTimeout
- TimeDivider#requestAnimationFrame
- TimeDivider#setInterval
- TimeDivider#setTimeout
- TimeTooltip#requestAnimationFrame
- TimeTooltip#setInterval
- TimeTooltip#setTimeout
- TrackButton#requestAnimationFrame
- TrackButton#setInterval
- TrackButton#setTimeout
- VolumeBar#requestAnimationFrame
- VolumeBar#setInterval
- VolumeBar#setTimeout
- VolumeControl#requestAnimationFrame
- VolumeControl#setInterval
- VolumeControl#setTimeout
- VolumeLevel#requestAnimationFrame
- VolumeLevel#setInterval
- VolumeLevel#setTimeout
- VolumeLevelTooltip#requestAnimationFrame
- VolumeLevelTooltip#setInterval
- VolumeLevelTooltip#setTimeout
- VolumePanel#requestAnimationFrame
- VolumePanel#setInterval
- VolumePanel#setTimeout
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
bubbles | boolean | <optional> | false | set to false so that the dispose event does not bubble up |
ready
[component.js](https://docs.videojs.com/component.js.html)
, [line 739](https://docs.videojs.com/component.js.html#line739)
Triggered when a Component
is ready.
Type:
tap
[component.js](https://docs.videojs.com/component.js.html)
, [line 1269](https://docs.videojs.com/component.js.html#line1269)
Triggered when a Component
is tapped.