astro-embeds-vimeo v1.0.0-beta.1

astro-embeds-vimeo

This package contains a component for embedding Vimeo videos in Astro projects.

Install

pnpm i astro-embeds-vimeo

Usage

<Vimeo id={video_id_or_url} />

The Vimeo component generates an embed using a lite-vimeo custom element. Vimeo embeds will always require some JavaScript, but this is one of the most minimal and performant ways to embed a Vimeo video.

---
import { Vimeo } from 'astro-embeds-vimeo';
---

<Vimeo id="32001208" />

You can also pass in the full URL for the video:

<Vimeo id="https://vimeo.com/32001208" />

Optional props

poster

You can provide an alternative poster image by passing in a URL to the poster prop.

<Vimeo
  id="32001208"
  poster="https://images-assets.nasa.gov/image/0302063/0302063~orig.jpg"
/>

params

You can pass a params prop to set the player parameters supported by Vimeo. This looks like a series of URL search params.

<!-- Example: Set the UI color to red and mute by default. -->
<Vimeo id="32001208" params="color=ff0000&muted=1" />

playlabel

By default, the play button in the embed has an accessible label set to “Play”. If you want to customize this, you can set the playlabel prop.

<Vimeo id="32001208" playlabel="Play the video" />