vime-poster

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

Visual

Vime poster component

Usage

<vime-player>
<!-- ... -->
<vime-ui>
<!-- ... -->
<vime-poster></vime-poster>
</vime-ui>
</vime-player>

Properties

PropertyAttributeDescriptionTypeDefault
fitfitHow the poster image should be resized to fit the container (sets the object-fit property)."contain" ∣ "cover" ∣ "fill" ∣ "none" ∣ "scale-down" ∣ undefined'cover'

Events

EventDescriptionType
vLoadedEmitted when the poster has loaded.CustomEvent<void>
vWillHideEmitted when the poster will be hidden.CustomEvent<void>
vWillShowEmitted when the poster will be shown.CustomEvent<void>

CSS Custom Properties

NameDescription
--vm-poster-z-indexThe position in the UI z-axis stack inside the player.

Dependencies

Used by

Graph

graph TD;
vime-default-ui --> vime-poster
style vime-poster fill:#f9f,stroke:#333,stroke-width:4px

Built with StencilJS