vime-click-to-play

Enables toggling playback by clicking the player.

Usage

HTML

<vime-player>

<!-- ... -->

<vime-ui>

<!-- ... -->

<vime-click-to-play></vime-click-to-play>

</vime-ui>

</vime-player>

React

import React from 'react';

import { VimePlayer, VimeUi, VimeClickToPlay } from '@vime/react';

function Example() {

return (

<VimePlayer>

{/* ... */}

<VimeUi>

{/* ... */}

<VimeClickToPlay />

</VimeUi>

</VimePlayer>

);

}

Vue

example.vue

<template>

<VimePlayer>

<!-- ... -->

<VimeUi>

<!-- ... -->

<VimeClickToPlay />

</VimeUi>

</VimePlayer>

</template>

<script>

import { VimePlayer, VimeUi, VimeClickToPlay } from '@vime/vue';

export default {

components: {

VimePlayer,

VimeUi,

VimeClickToPlay,

},

};

</script>

Svelte

example.svelte

<VimePlayer>

<!-- ... -->

<VimeUi>

<!-- ... -->

<VimeClickToPlay />

</VimeUi>

</VimePlayer>

<script lang="ts">

import { VimePlayer, VimeUi, VimeClickToPlay } from '@vime/svelte';

</script>

Stencil

class Example {

render() {

return (

<vime-player>

{/* ... */}

<vime-ui>

{/* ... */}

<vime-click-to-play />

</vime-ui>

</vime-player>

);

}

}

Angular

example.html

<vime-player>

<!-- ... -->

<vime-ui>

<!-- ... -->

<vime-click-to-play></vime-click-to-play>

</vime-ui>

</vime-player>

Properties

Property	Attribute	Description	Type	Default
useOnMobile	use-on-mobile	By default this is disabled on mobile to not interfere with playback, set this to true to enable it.	boolean	false

CSS Custom Properties

Name	Description
--vm-click-to-play-z-index	The position in the UI z-axis stack inside the player.

Dependencies

Used by

• vime-default-ui

Graph

graph TD;

vime-default-ui --> vime-click-to-play

style vime-click-to-play fill:#f9f,stroke:#333,stroke-width:4px

---

Built with StencilJS