Version: 5.x

vm-caption-control

A control for toggling the visibility of captions. This control is not displayed if there's no track currently set.

Visual#

Vime caption control component

Usage#

<vm-player>
<!-- ... -->
<vm-ui>
<!-- ... -->
<vm-controls>
<!-- ... -->
<vm-caption-control></vm-caption-control>
</vm-controls>
</vm-ui>
</vm-player>

Properties#

PropertyDescriptionTypeDefault
hideIconThe URL to an SVG element or fragment to load.string'captions-off'
hideTooltipWhether the tooltip should not be displayed.booleanfalse
iconsThe name of an icon library to use. Defaults to the library defined by the icons player property.string ∣ undefinedundefined
keysA slash (/) separated string of JS keyboard keys (KeyboardEvent.key), that when caught in a keydown event, will trigger a click event on the control.string ∣ undefined'c'
showIconThe URL to an SVG element or fragment to load.string'captions-on'
tooltipDirectionThe direction in which the tooltip should grow."left" ∣ "right" ∣ undefinedundefined
tooltipPositionWhether the tooltip is positioned above/below the control."bottom" ∣ "top"'top'

Dependencies#

Used by#

Depends on#