关闭按钮

CloseButton 是一个 Button，点击时会触发 close 事件。

构造函数

new CloseButton(player, optionsopt)

创建此类的实例。

参数
名称类型属性描述
播放器播放器

此类应附着到的Player。

选项对象<可选>

播放器选项的键/值存储。

源

继承

成员

(protected) controlText_

覆盖
源

方法

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

查找匹配selector的单个DOM元素。这可以在Component的contentEl()中或另一个自定义上下文中进行。

参数
名称类型属性默认描述
选择器字符串

一个有效的CSS选择器，将传递给querySelector。

上下文Element | string<可选>
this.contentEl()

一个用于查询的DOM元素。也可以是选择器字符串，在这种情况下，第一个匹配的元素将被用作上下文。如果缺少，则使用this.contentEl()。如果this.contentEl()不返回任何内容，则回退到document。

覆盖
源
参见
返回

找到的DOM元素，或null

类型： 
Element | null

$$(selector, contextopt) → {NodeList}

查找匹配selector的所有DOM元素。这可以在Component的contentEl()中或另一个自定义上下文中进行。

参数
名称类型属性默认描述
选择器字符串

一个有效的CSS选择器，将传递给querySelectorAll。

上下文Element | string<可选>
this.contentEl()

一个用于查询的DOM元素。也可以是选择器字符串，在这种情况下，第一个匹配的元素将被用作上下文。如果缺少，则使用this.contentEl()。如果this.contentEl()不返回任何内容，则回退到document。

覆盖
源
参见
返回

找到的DOM元素列表

类型： 
NodeList

addChild(child, options可选) → {Component}

在此Button内部添加一个子Component。

参数
名称类型属性默认描述
子项string | Component

要添加的子项的名称或实例。

选项对象<可选>
{}

将传递给子项的子项的选项的键/值存储。

覆盖
已废弃
  • 自版本5起
源
返回

作为子项添加的Component。使用字符串时，Component将由该过程创建。

类型： 
组件

addClass(…classesToAdd)

向Component的元素添加CSS类名。

参数
名称类型属性描述
要添加的类字符串<可重复>

一个或多个要添加的CSS类名。

覆盖
源

blur()

从此组件中移除焦点

覆盖
源

buildCSSClass() → {string}

构建默认的DOM className。

覆盖
源
返回

此对象的DOM className。

类型： 
字符串

cancelAnimationFrame(id) → {number}

取消传递给Component#requestAnimationFrame (rAF) 的排队回调。

如果您通过 Component#requestAnimationFrame 排队 rAF 回调，请使用此函数而不是 window.cancelAnimationFrame。否则，您的销毁监听器将不会在 Component#dispose 之前被清理！

参数
名称类型描述
ID数字

要清除的rAF ID。Component#requestAnimationFrame的返回值。

覆盖
源
参见
返回

返回已清除的rAF ID。

类型： 
数字

cancelNamedAnimationFrame(name)

如果存在，取消当前的命名动画帧。

参数
名称类型描述
名称字符串

要取消的requestAnimationFrame的名称。

覆盖
源

children() → {Array}

获取所有子组件的数组

覆盖
源
返回

子项

类型： 
数组

clearInterval(intervalId) → {number}

清除通过 window.setInterval 或 Component#setInterval 创建的间隔。如果您通过 Component#setInterval 设置间隔，请使用此函数而不是 window.clearInterval。否则，您的销毁监听器将不会在 Component#dispose 之前被清理！

参数
名称类型描述
间隔ID数字

要清除的间隔ID。Component#setInterval或window.setInterval的返回值。

覆盖
源
参见
返回

返回已清除的间隔ID。

类型： 
数字

clearTimeout(timeoutId) → {number}

清除通过 window.setTimeout 或 Component#setTimeout 创建的超时。如果您通过 Component#setTimeout 设置超时，请使用此函数而不是 window.clearTimout。否则，您的销毁监听器将不会在 Component#dispose 之前被清理！

参数
名称类型描述
超时ID数字

要清除的超时ID。Component#setTimeout或window.setTimeout的返回值。

覆盖
源
参见
返回

返回已清除的超时ID。

类型： 
数字

contentEl() → {Element}

返回Component的DOM元素。子项将插入到此处。这通常与Component#el中返回的元素相同。

覆盖
源
返回

此Component的内容元素。

类型： 
元素

controlText(textopt, elopt) → {string}

获取或设置用于ClickableComponent控件的本地化文本。

参数
名称类型属性默认描述
文本字符串<可选>

元素的控制文本。

元素元素<可选>
this.el()

要设置标题的元素。

覆盖
源
返回
  • 获取时的控制文本
类型： 
字符串

createControlTextEl(elopt) → {Element}

在此ClickableComponent上创建控制文本元素

参数
名称类型属性描述
元素元素<可选>

控制文本的父元素。

覆盖
源
返回

创建的控制文本元素。

类型： 
元素

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

创建Button的DOM元素。

参数
名称类型属性默认描述
标签字符串<可选>
"按钮"

元素的节点类型。此参数被忽略：无论传递什么，它始终会创建一个button元素。

属性对象<可选>
{}

应在元素上设置的属性对象。

属性对象<可选>
{}

应在元素上设置的属性对象。

覆盖
源
返回

创建的元素。

类型： 
元素

currentDimension(widthOrHeight) → {number}

获取组件元素的计算宽度或高度。

使用window.getComputedStyle。

参数
名称类型描述
宽度或高度字符串

包含“width”或“height”的字符串。您想获取的任何一个。

覆盖
源
返回

请求的维度，如果该维度未设置，则为0。

类型： 
数字

currentDimensions() → {Component~DimensionObject}

获取一个包含组件元素计算宽度和高度值的对象。

使用window.getComputedStyle。

覆盖
源
返回

组件元素的计算维度。

类型： 
Component~DimensionObject

currentHeight() → {number}

获取组件元素的计算高度。

使用window.getComputedStyle。

覆盖
源
返回

组件元素的计算高度。

类型： 
数字

currentWidth() → {number}

获取组件元素的计算宽度。

使用window.getComputedStyle。

覆盖
源
返回

组件元素的计算宽度。

类型： 
数字

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

获取或设置Component元素的宽度或高度。这是Component#width和Component#height的共享代码。

需要了解的事项

  • 如果宽度或高度是数字，这将返回以“px”为后缀的数字。
  • 如果宽度/高度是百分比，这将返回以“%”为后缀的百分比
  • 隐藏元素的宽度在 window.getComputedStyle 中为0。此函数默认为 Component 的 style.width，并回退到 window.getComputedStyle。有关更多信息，请参阅此处
  • 如果您想要组件的计算样式，请使用Component#currentWidth和{Component#currentHeight
参数
名称类型属性描述
宽度或高度字符串

8 'width' 或 'height'

数字number | string<可选>

8 新维度

跳过监听器布尔值<可选>

跳过componentresize事件触发

覆盖
源
触发
返回

获取时的维度，如果未设置则为0

类型： 
number | undefined

dimensions(width, height)

同时设置Component元素的宽度和高度。

参数
名称类型描述
宽度number | string

要设置Component元素的宽度。

高度number | string

要设置Component元素的高度。

覆盖
源

disable()

禁用Button元素，使其无法被激活或点击。与Button#enable一起使用。

覆盖
源

dispose(options)

销毁Component及所有子组件。

参数
名称类型描述
选项对象
属性
名称类型描述
原始元素元素

用于替换播放器元素的元素

覆盖
源
触发

el() → {Element}

获取Component的DOM元素

覆盖
源
返回

此Component的DOM元素。

类型： 
元素

(protected) emitTapEvents()

检测到触摸事件支持时发出“tap”事件。这用于通过轻触视频来支持切换控件。它们之所以启用，是因为否则每个子组件都会有额外的开销。

覆盖
源
触发
监听事件
  • Component#event:touchstart
  • Component#event:touchmove
  • Component#event:touchleave
  • Component#event:touchcancel
  • Component#event:touchend

enable()

启用Button元素，使其可以被激活或点击。与Button#disable一起使用。

覆盖
源

enableTouchActivity()

此函数在触摸事件发生时报告用户活动。这可以被任何希望触摸事件以其他方式运行的子组件关闭。

当发生触摸事件时报告用户触摸活动。用户活动用于确定何时显示/隐藏控件。对于鼠标事件来说很简单，因为任何鼠标事件都应该显示控件。因此，我们捕获冒泡到播放器的鼠标事件，并在发生时报告活动。对于触摸事件，它不像 touchstart 和 touchend 切换播放器控件那么简单。因此触摸事件也无法在播放器层面帮助我们。

用户活动是异步检查的。因此可能发生的情况是，视频上的轻触事件关闭了控件。然后 touchend 事件冒泡到播放器。如果它报告了用户活动，就会立即重新打开控件。我们也不想完全阻止触摸事件冒泡。此外，touchmove 事件和除了轻触之外的任何事件，都不应该重新打开控件。

覆盖
源
监听事件
  • Component#event:touchstart
  • Component#event:touchmove
  • Component#event:touchend
  • Component#event:touchcancel

focus()

将焦点设置到此组件

覆盖
源

getAttribute(attribute) → {string|null}

获取Component元素上的属性值。

参数
名称类型描述
属性字符串

要获取其值的属性名称。

覆盖
源
参见
返回
  • 请求的属性值。- 在某些浏览器中，如果属性不存在或没有值，则可能为空字符串 - 大多数浏览器在属性不存在或没有值时将返回null。
类型： 
string | null

getChild(name) → {Component|undefined}

返回具有给定name的子Component。

参数
名称类型描述
名称字符串

要获取的子Component的名称。

覆盖
源
返回

具有给定name的子Component或undefined。

类型： 
Component | undefined

getChildById(id) → {Component|undefined}

返回具有给定id的子Component。

参数
名称类型描述
ID字符串

要获取的子Component的ID。

覆盖
源
返回

具有给定id的子Component或undefined。

类型： 
Component | undefined

getDescendant(…names) → {Component|undefined}

返回遵循给定子代 names 的后代 Component。例如，['foo', 'bar', 'baz'] 将尝试在当前组件上获取 'foo'，在 'foo' 组件上获取 'bar'，在 'bar' 组件上获取 'baz'，如果其中任何一个不存在则返回 undefined。

参数
名称类型属性描述
名称...Array.<string> | string<可重复>

要获取的子Component的名称。

覆盖
源
返回

遵循给定后代names的后代Component或undefined。

类型： 
Component | undefined

getIsAvailableToBeFocused(el) → {boolean}

确定此组件是否当前可见/启用/等...

参数
名称类型描述
元素HTMLElement

代表组件的HTML元素。

覆盖
源
返回

如果组件当前可见且启用，则为true。否则，为false。

类型： 
布尔值

getIsFocusable(el) → {boolean}

确定此组件是否可被视为可聚焦组件。

参数
名称类型描述
元素HTMLElement

代表组件的HTML元素。

覆盖
源
返回

如果组件可以被聚焦，则为true。否则，为false。

类型： 
布尔值

getPositions() → {Object}

检索组件元素的位置和大小信息。

覆盖
源
返回

一个包含 boundingClientRect 和 center 属性的对象。 - boundingClientRect：一个包含 x、y、width、height、top、right、bottom 和 left 属性的对象，表示元素的边界矩形。 - center：一个包含 x 和 y 属性的对象，表示元素的中心点。width 和 height 设置为 0。

类型： 
对象

handleClick(event)

当 CloseButton 被点击时调用此函数。有关何时触发此函数，请参阅 ClickableComponent#handleClick。

参数
名称类型描述
事件事件

导致此函数被调用的keydown、tap或click事件。

覆盖
源
触发
监听事件
  • event:tap
  • event:click

handleKeyDown(event)

当 CloseButton 接收到 keydown 事件时调用的事件处理程序。

默认情况下，如果键是 Esc，它将触发 click 事件。

参数
名称类型描述
事件KeyboardEvent

导致此函数被调用的keydown事件。

覆盖
源
监听事件
  • event:keydown

handleKeyPress(event)

许多组件过去都有一个 handleKeyPress 方法，但其命名不佳，因为它监听的是 keydown 事件。此方法名现在委托给 handleKeyDown。这意味着任何调用 handleKeyPress 的人都不会看到他们的方法调用停止工作。

参数
名称类型描述
事件KeyboardEvent

导致此函数被调用的事件。

覆盖
源

handleLanguagechange()

处理ClickableComponent中播放器组件的语言更改

覆盖
源

hasClass(classToCheck) → {boolean}

检查组件元素是否具有CSS类名。

参数
名称类型描述
要检查的类字符串

要检查的CSS类名。

覆盖
源
返回
  • 如果Component具有该类，则为True。- 如果Component不具有该类，则为False。
类型： 
布尔值

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

根据CSS样式获取或设置组件的高度。有关更详细的信息，请参见Component#dimension。

参数
名称类型属性描述
数字number | string<可选>

您要设置的高度，后缀为“%”、“px”或无。

跳过监听器布尔值<可选>

跳过componentresize事件触发器

覆盖
源
返回

获取时的高度，如果没有高度则为零

类型： 
number | undefined

hide()

如果Component的元素当前正在显示，则通过向其添加“vjs-hidden”类名来隐藏它。

覆盖
源

id() → {string}

获取此Component的ID

覆盖
源
返回

此Component的ID

类型： 
字符串

initChildren()

根据选项添加和初始化默认子Component。

覆盖
源

isDisposed() → {boolean}

确定此组件是否已销毁。

覆盖
源
返回

如果组件已销毁，则为true。否则，为false。

类型： 
布尔值

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

给定英文字符串，将字符串本地化。

如果提供了令牌，它将尝试对提供的字符串进行简单的令牌替换。它查找的令牌看起来像{1}，其中索引是令牌数组中的1-indexed。

如果提供了 defaultValue，并且在提供的语言文件中未找到值，则将使用 defaultValue 而不是 string。这对于您想要一个描述性的令牌替换键，但又希望有一个简洁的本地化字符串且不要求包含 en.json 的情况很有用。

目前，它用于进度条计时。

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

然后像这样使用

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

输出类似：01:23 of 24:56。

参数
名称类型属性描述
字符串字符串

要本地化的字符串和在语言文件中查找的键。

令牌Array.<string><可选>

如果当前项有令牌替换，请在此处提供令牌。

默认值字符串<可选>

默认为string。如果查找键需要单独，则可以作为令牌替换的默认值。

覆盖
源
返回

本地化字符串，或者如果不存在本地化，则为英文字符串。

类型： 
字符串

name() → {string}

获取Component的名称。该名称用于引用Component并在注册期间设置。

覆盖
源
返回

此Component的名称。

类型： 
字符串

options(obj) → {Object}

使用新选项深度合并选项对象。

注意：当obj和options都包含其值为对象的属性时。这两个属性将使用module:obj.merge合并

参数
名称类型描述
对象对象

包含新选项的对象。

覆盖
源
返回

this.options_和obj合并后的新对象。

类型： 
对象

player() → {Player}

返回Component所附着的Player。

覆盖
源
返回

此Component所附着的播放器。

类型： 
播放器

ready(fn)

将监听器绑定到组件的就绪状态。与事件监听器不同，如果就绪事件已经发生，它将立即触发函数。

参数
名称类型描述
函数就绪回调

当Component就绪时调用的函数。

覆盖
源

removeAttribute(attribute)

从Component的元素中移除属性。

参数
名称类型描述
属性字符串

要移除的属性名称。

覆盖
源
参见

removeChild(component)

从此Component的子项列表中移除子Component。同时从此Component的元素中移除子Component的元素。

参数
名称类型描述
组件组件

要移除的子Component。

覆盖
源

removeClass(…classesToRemove)

从Component的元素中移除CSS类名。

参数
名称类型属性描述
要移除的类字符串<可重复>

一个或多个要移除的CSS类名。

覆盖
源

requestAnimationFrame(fn) → {number}

将回调排队传递给requestAnimationFrame (rAF)，但有一些额外的优点

参数
名称类型描述
函数Component~GenericCallback

一个函数，它将绑定到此组件并在浏览器下一次重绘之前执行。

覆盖
源
参见
监听事件
返回

返回一个rAF ID，用于标识超时。它也可以在Component#cancelAnimationFrame中使用以取消动画帧回调。

类型： 
数字

requestNamedAnimationFrame(name, fn)

请求一个动画帧，但只排队一个命名动画帧。在前面的动画帧完成之前，永远不会添加另一个。

参数
名称类型描述
名称字符串

此requestAnimationFrame的名称

函数Component~GenericCallback

一个函数，它将绑定到此组件并在浏览器下一次重绘之前执行。

覆盖
源

setAttribute(attribute, value)

设置Component元素上的属性值

参数
名称类型描述
属性字符串

要设置的属性名称。

值字符串

要将属性设置为的值。

覆盖
源
参见

setIcon(iconName, elopt) → {Element}

向另一个元素或组件添加SVG图标元素。

参数
名称类型属性默认描述
图标名称字符串

图标的名称。所有图标名称的列表可以在“sandbox/svg-icons.html”中找到

元素元素<可选>
this.el()

要设置标题的元素。默认为当前组件的元素。

覆盖
源
返回

新创建的图标元素。

类型： 
元素

setInterval(fn, interval) → {number}

创建一个每x毫秒运行一次的函数。此函数是window.setInterval的包装。但仍有一些原因选择使用此函数。

  1. 当Component#dispose被调用时，它通过Component#clearInterval被清除。
  2. 函数回调将是Component~GenericCallback
参数
名称类型描述
函数Component~GenericCallback

每x秒运行的函数。

间隔数字

每x毫秒执行指定的函数。

覆盖
源
参见
监听事件
返回

返回一个可用于标识间隔的ID。它也可以在Component#clearInterval中使用以清除间隔。

类型： 
数字

setTimeout(fn, timeout) → {number}

创建一个在x毫秒超时后运行的函数。此函数是window.setTimeout的包装。但仍有一些原因选择使用此函数

  1. 当Component#dispose被调用时，它通过Component#clearTimeout被清除。
  2. 函数回调将被转换为Component~GenericCallback

注意：您不能对此函数返回的ID使用 window.clearTimeout。这将导致其销毁监听器无法被清理！请改用 Component#clearTimeout 或 Component#dispose。

参数
名称类型描述
函数Component~GenericCallback

将在timeout后运行的函数。

超时数字

在执行指定函数之前延迟的毫秒数。

覆盖
源
参见
监听事件
返回

返回一个超时ID，用于标识超时。它也可以在Component#clearTimeout中使用以清除已设置的超时。

类型： 
数字

show()

如果Component的元素被隐藏，则通过从其移除“vjs-hidden”类名来显示它。

覆盖
源

toggleClass(classToToggle, predicateopt)

向组件的元素添加或移除CSS类名。

参数
名称类型属性描述
要切换的类字符串

要添加或移除的类。传递给DOMTokenList的toggle()

谓词boolean | Dom.PredicateCallback<可选>

一个布尔值或返回布尔值的函数。传递给DOMTokenList的toggle()。

覆盖
源

triggerReady()

触发此Component的所有就绪监听器。

覆盖
源
触发

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

根据CSS样式获取或设置组件的宽度。有关更详细的信息，请参见Component#dimension。

参数
名称类型属性描述
数字number | string<可选>

您要设置的宽度，后缀为“%”、“px”或无。

跳过监听器布尔值<可选>

跳过componentresize事件触发器

覆盖
源
返回

获取时的宽度，如果没有宽度则为零

类型： 
number | undefined

事件

关闭

当 CloseButton 被点击时触发。

类型
属性
名称类型属性默认描述
冒泡布尔值<可选>
假

设置为 false，以便在没有监听器的情况下，关闭事件不会冒泡到父级。

源

组件大小调整

当组件大小调整时触发。

类型
覆盖
源

销毁

当Component被销毁时触发。

类型
属性
名称类型属性默认描述
冒泡布尔值<可选>
假

设置为false，以便销毁事件不冒泡

覆盖
源

就绪

当Component就绪时触发。

类型
覆盖
源

轻触

当Component被轻触时触发。

类型
  • MouseEvent
覆盖
源