vime-poster

Loads the poster set in the player prop currentPoster and displays it. The poster will automatically dissapear once playback starts.

Visual

Usage

HTML

<vime-player>

<!-- ... -->

<vime-ui>

<!-- ... -->

<vime-poster></vime-poster>

</vime-ui>

</vime-player>

React

import React from 'react';

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

function Example() {

return (

<VimePlayer>

{/* ... */}

<VimeUi>

{/* ... */}

<VimePoster />

</VimeUi>

</VimePlayer>

);

}

Vue

example.vue

<template>

<VimePlayer>

<!-- ... -->

<VimeUi>

<!-- ... -->

<VimePoster />

</VimeUi>

</VimePlayer>

</template>

<script>

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

export default {

components: {

VimePlayer,

VimeUi,

VimePoster,

},

};

</script>

Svelte

example.svelte

<VimePlayer>

<!-- ... -->

<VimeUi>

<!-- ... -->

<VimePoster />

</VimeUi>

</VimePlayer>

<script lang="ts">

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

</script>

Stencil

class Example {

render() {

return (

<vime-player>

{/* ... */}

<vime-ui>

{/* ... */}

<vime-poster />

</vime-ui>

</vime-player>

);

}

}

Angular

example.html

<vime-player>

<!-- ... -->

<vime-ui>

<!-- ... -->

<vime-poster></vime-poster>

</vime-ui>

</vime-player>

Properties

Property	Attribute	Description	Type	Default
fit	fit	How the poster image should be resized to fit the container (sets the object-fit property).	"contain" ∣ "cover" ∣ "fill" ∣ "none" ∣ "scale-down" ∣ undefined	'cover'

Events

Event	Description	Type
vLoaded	Emitted when the poster has loaded.	CustomEvent<void>
vWillHide	Emitted when the poster will be hidden.	CustomEvent<void>
vWillShow	Emitted when the poster will be shown.	CustomEvent<void>

CSS Custom Properties

Name	Description
--vm-poster-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-poster

style vime-poster fill:#f9f,stroke:#333,stroke-width:4px

---

Built with StencilJS