vime-caption-control

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

Visual

Usage

HTML

<vime-player>

<!-- ... -->

<vime-ui>

<!-- ... -->

<vime-controls>

<!-- ... -->

<vime-caption-control></vime-caption-control>

</vime-controls>

</vime-ui>

</vime-player>

React

import React from 'react';

import {

VimePlayer,

VimeUi,

VimeControls,

VimeCaptionControl,

} from '@vime/react';

function Example() {

return (

<VimePlayer>

{/* ... */}

<VimeUi>

{/* ... */}

<VimeControls>

<VimeCaptionControl />

</VimeControls>

</VimeUi>

</VimePlayer>

);

}

Vue

example.vue

<template>

<VimePlayer>

<!-- ... -->

<VimeUi>

<!-- ... -->

<VimeControls>

<VimeCaptionControl />

</VimeControls>

</VimeUi>

</VimePlayer>

</template>

<script>

import {

VimePlayer,

VimeUi,

VimeControls,

VimeCaptionControl,

} from '@vime/vue';

export default {

components: {

VimePlayer,

VimeUi,

VimeControls,

VimeCaptionControl,

},

};

</script>

Svelte

example.svelte

<VimePlayer>

<!-- ... -->

<VimeUi>

<!-- ... -->

<VimeControls>

<VimeCaptionControl />

</VimeControls>

</VimeUi>

</VimePlayer>

<script lang="ts">

import {

VimePlayer,

VimeUi,

VimeClickToPlay,

VimeCaptionControl,

} from '@vime/svelte';

</script>

Stencil

class Example {

render() {

return (

<vime-player>

{/* ... */}

<vime-ui>

{/* ... */}

<vime-controls>

<vime-caption-control />

</vime-controls>

</vime-ui>

</vime-player>

);

}

}

Angular

example.html

<vime-player>

<!-- ... -->

<vime-ui>

<!-- ... -->

<vime-controls>

<!-- ... -->

<vime-caption-control></vime-caption-control>

</vime-controls>

</vime-ui>

</vime-player>

Properties

Property	Attribute	Description	Type	Default
hideIcon	hide-icon	The URL to an SVG element or fragment to load.	string	'#vime-captions-off'
hideTooltip	hide-tooltip	Whether the tooltip should not be displayed.	boolean	false
keys	keys	A 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'
showIcon	show-icon	The URL to an SVG element or fragment to load.	string	'#vime-captions-on'
tooltipDirection	tooltip-direction	The direction in which the tooltip should grow.	"left" ∣ "right" ∣ undefined	undefined
tooltipPosition	tooltip-position	Whether the tooltip is positioned above/below the control.	"bottom" ∣ "top"	'top'

Dependencies

Used by

• vime-default-controls

Depends on

• vime-control
• vime-icon
• vime-tooltip

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