vime-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

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

Properties

PropertyAttributeDescriptionTypeDefault
hideIconhide-iconThe URL to an SVG element or fragment to load.string'#vime-captions-off'
hideTooltiphide-tooltipWhether the tooltip should not be displayed.booleanfalse
keyskeysA 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'
showIconshow-iconThe URL to an SVG element or fragment to load.string'#vime-captions-on'
tooltipDirectiontooltip-directionThe direction in which the tooltip should grow."left" ∣ "right" ∣ undefinedundefined
tooltipPositiontooltip-positionWhether the tooltip is positioned above/below the control."bottom" ∣ "top"'top'

Dependencies

Used by

Depends on

Graph

graph TD;
vime-caption-control --> vime-control
vime-caption-control --> vime-icon
vime-caption-control --> vime-tooltip
vime-default-controls --> vime-caption-control
style vime-caption-control fill:#f9f,stroke:#333,stroke-width:4px

Built with StencilJS