Use <Vimeo> to embed a Vimeo video in your documentation. Pass the numeric video ID from the Vimeo URL; the component renders a responsive iframe pointed at player.vimeo.com.
<Vimeo id="22439234" />Copy the numeric ID from the end of the Vimeo URL. For example, https://vimeo.com/22439234 has ID 22439234.
<Vimeo id="22439234" />The numeric ID of the Vimeo video to embed. This is the number at the end of the video URL, for example 22439234 from https://vimeo.com/22439234.
The component loads the player from https://player.vimeo.com/video/{id}.
<Vimeo id="22439234" />Legacy alias for id. Use id in new content; video is supported for backward compatibility with older pages.
When both are set, id is used.
<Vimeo video="22439234" />| Condition | Result |
|---|---|
id or video set | Renders a responsive <iframe> at https://player.vimeo.com/video/{id} |
Both id and video set | id wins |
Neither id nor video set | Renders an empty <div> |
The iframe uses a 16:9 aspect ratio, fills the content width, and has rounded corners. Full-screen viewing is enabled via allowFullScreen.
Vimeo embeds may fail silently when the video owner restricts playback to specific domains. Check the video's privacy settings on Vimeo if readers report a blank player.
- YouTube: embed YouTube videos
- Video: self-hosted or generic embedded video
- Components overview: when to use embeds, callouts, and media components