# youtube-video-element

> Custom element (web component) for the YouTube player.

Latest version **1.9.0** (published 2026-02-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install youtube-video-element
pnpm add youtube-video-element
yarn add youtube-video-element
bun add youtube-video-element
```

## Health

**Score 70/100 (B)** — status: stable.

Positive: has types; esm support; no vulnerabilities; has provenance; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.9.0 |
| Published | 2026-02-18 |
| First published | 2020-04-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 56 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 264 |
| Author | @muxinc |
| Maintainers | luwes, heff, mmcc, mux-npmjs |
| Keywords | youtube, video, player, web component, custom element |

## Links

- npm: https://www.npmjs.com/package/youtube-video-element
- Repository: https://github.com/muxinc/media-elements
- Homepage: https://github.com/muxinc/youtube-video-element#readme
- Issues: https://github.com/muxinc/youtube-video-element/issues
- npm.io page: https://npm.io/package/youtube-video-element

## Dependencies (1)

- [media-played-ranges-mixin](https://npm.io/package/media-played-ranges-mixin.md) ^0.1.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.9.0 (latest) — 2026-02-18
- 1.8.1 — 2025-11-25
- 1.8.0 — 2025-11-13
- 1.7.0 — 2025-11-10
- 1.6.2 — 2025-08-08
- 1.6.1 — 2025-07-15
- 1.6.0 — 2025-07-02
- 1.5.3 — 2025-06-26
- 1.5.2 — 2025-06-26
- 1.5.1 — 2025-03-14
- 1.5.0 — 2025-03-12
- 1.4.0 — 2025-02-20
- 1.3.0 — 2024-12-19
- 1.2.0 — 2024-12-19
- 1.1.6 — 2024-06-14
- … 19 more at https://npm.io/package/youtube-video-element/versions

## README

# `<youtube-video>`

[![NPM Version](https://img.shields.io/npm/v/youtube-video-element?style=flat-square&color=informational)](https://www.npmjs.com/package/youtube-video-element) 
[![NPM Downloads](https://img.shields.io/npm/dm/youtube-video-element?style=flat-square&color=informational&label=npm)](https://www.npmjs.com/package/youtube-video-element) 
[![jsDelivr hits (npm)](https://img.shields.io/jsdelivr/npm/hm/youtube-video-element?style=flat-square&color=%23FF5627)](https://www.jsdelivr.com/package/npm/youtube-video-element)
[![npm bundle size](https://img.shields.io/bundlephobia/minzip/youtube-video-element?style=flat-square&color=success&label=gzip)](https://bundlephobia.com/result?p=youtube-video-element) 

A [custom element](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements)
for the YouTube player with an API that matches the 
[`<video>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video) API.

- 🏄‍♂️ Compatible [`HTMLMediaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement) API
- 🕺 Seamlessly integrates with [Media Chrome](https://github.com/muxinc/media-chrome)

## Example

```html
<script type="module" src="https://cdn.jsdelivr.net/npm/youtube-video-element@1"></script>
<youtube-video controls src="https://www.youtube.com/watch?v=rubNgGj3pYo"></youtube-video>
```

## Installing

`<youtube-video>` is packaged as a javascript module (es6) only, which is supported by all evergreen browsers and Node v12+.

### Loading into your HTML using `<script>`

Note the `type="module"`, that's important.

> Modules are always loaded asynchronously by the browser, so it's ok to load them in the head :thumbsup:, and best for registering web components quickly.

```html
<head>
  <script type="module" src="https://cdn.jsdelivr.net/npm/youtube-video-element@1"></script>
</head>
```

### Adding to your app via `npm`

```bash
npm install youtube-video-element --save
```
Or yarn
```bash
yarn add youtube-video-element
```

Include in your app javascript (e.g. src/App.js)
```js
import 'youtube-video-element';
```
This will register the custom elements with the browser so they can be used as HTML.


## Related

- [Media Chrome](https://github.com/muxinc/media-chrome) Your media player's dancing suit. 🕺
- [`<mux-video>`](https://github.com/muxinc/elements/tree/main/packages/mux-video) A Mux-flavored HTML5 video element w/ hls.js and Mux data builtin.
- [`<mux-player>`](https://github.com/muxinc/elements/tree/main/packages/mux-player) The official Mux-flavored video player web component.
- [`<vimeo-video>`](https://github.com/muxinc/media-elements/tree/main/packages/vimeo-video-element) A web component for the Vimeo player.
- [`<videojs-video>`](https://github.com/muxinc/media-elements/tree/main/packages/videojs-video-element) A web component for Video.js.
- [`<wistia-video>`](https://github.com/muxinc/media-elements/tree/main/packages/wistia-video-element) A web component for the Wistia player.
- [`<jwplayer-video>`](https://github.com/muxinc/media-elements/tree/main/packages/jwplayer-video-element) A web component for the JW player.
- [`<hls-video>`](https://github.com/muxinc/media-elements/tree/main/packages/hls-video-element) A web component for playing HTTP Live Streaming (HLS) videos.
- [`castable-video`](https://github.com/muxinc/media-elements/tree/main/packages/castable-video) Cast your video element to the big screen with ease!

---
_Source: https://npm.io/package/youtube-video-element · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._