vm-vimeo

Enables loading, playing and controlling videos from Vimeo.

You don't interact with this component for passing player properties, controlling playback, listening to player events and so on, that is all done through the vime-player component.

Usage

HTML

<vm-player controls>

<vm-vimeo video-id="411652396"></vm-vimeo>

<!-- ... -->

</vm-player>

React

import React from 'react';

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

function Example() {

return (

<Player controls>

<Vimeo videoId="411652396" />

{/* ... */}

</Player>

);

}

Vue

example.vue

<template>

<Player controls>

<Vimeo videoId="411652396" />

<!-- ... -->

</Player>

</template>

<script>

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

export default {

components: {

Player,

Vimeo,

},

};

</script>

Svelte

example.svelte

<Player controls>

<Vimeo videoId="411652396" />

<!-- ... -->

</Player>

<script lang="ts">

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

</script>

Stencil

class Example {

render() {

return (

<vm-player controls>

<vm-vimeo videoId="411652396" />

{/* ... */}

</vm-player>

);

}

}

Angular

example.html

<vm-player controls>

<vm-vimeo cookies="true" video-id="411652396"></vm-vimeo>

<!-- ... -->

</vm-player>

Properties

Property	Description	Type	Default
byline	Whether to display the video owner's name.	boolean	true
color	The hexadecimal color value of the playback controls. The embed settings of the video might override this value.	string ∣ undefined	undefined
cookies	Whether cookies should be enabled on the embed.	boolean	true
noAutoAspectRatio	Turns off automatically determining the aspect ratio of the current video.	boolean	false
portrait	Whether to display the video owner's portrait.	boolean	true
poster	The absolute URL of a custom poster to be used for the current video.	string ∣ undefined	undefined
videoId (required)	The Vimeo resource ID of the video to load.	string	undefined

Events

Event	Description	Type
vmError	Emitted when an error has occurred.	CustomEvent<any>

Dependencies

Depends on

• vm-embed