vm-scrim

A darkened overlay or gradient that covers the current video to enable controls placed on it to be more visible.

Usage

HTML

<vm-player>

<!-- ... -->

<vm-ui>

<!-- ... -->

<vm-scrim></vm-scrim>

</vm-ui>

</vm-player>

React

import React from 'react';

import { Player, Ui, Scrim } from '@vime/react';

function Example() {

return (

<Player>

{/* ... */}

<Ui>

{/* ... */}

<Scrim />

</Ui>

</Player>

);

}

Vue

example.vue

<template>

<Player>

<!-- ... -->

<Ui>

<!-- ... -->

<Scrim />

</Ui>

</Player>

</template>

<script>

import { Player, Ui, Scrim } from '@vime/vue';

export default {

components: {

Player,

Ui,

Scrim,

},

};

</script>

Svelte

example.svelte

<Player>

<!-- ... -->

<Ui>

<!-- ... -->

<Scrim />

</Ui>

</Player>

<script lang="ts">

import { Player, Ui, Scrim } from '@vime/svelte';

</script>

Stencil

class Example {

render() {

return (

<vm-player>

{/* ... */}

<vm-ui>

{/* ... */}

<vm-scrim />

</vm-ui>

</vm-player>

);

}

}

Angular

example.html

<vm-player>

<!-- ... -->

<vm-ui>

<!-- ... -->

<vm-scrim></vm-scrim>

</vm-ui>

</vm-player>

Properties

Property	Description	Type	Default
gradient	If this prop is defined, a dark gradient that smoothly fades out without being noticed will be used instead of a set color. This prop also sets the direction in which the dark end of the gradient should start. If the direction is set to up, the dark end of the gradient will start at the bottom of the player and fade out to the center. If the direction is set to down, the gradient will start at the top of the player and fade out to the center.	"down" ∣ "up" ∣ undefined	undefined

CSS Custom Properties

Name	Description
--vm-scrim-bg	The background color of the scrim.
--vm-scrim-z-index	The position in the UI z-axis stack inside the player.

Dependencies

Used by

• vm-default-controls