# `<twitch-video>`

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

A [custom element](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) 
for the Twitch 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

<!-- prettier-ignore -->
```html
<script type="module" src="https://cdn.jsdelivr.net/npm/twitch-video-element@0.1/+esm"></script>
<twitch-video controls src="https://www.twitch.tv/videos/106400740"></twitch-video>
```

## Install

First install the NPM package:

```bash
npm install twitch-video-element
```

Import in your app javascript (e.g. src/App.js):

```js
import 'twitch-video-element';
```

Optionally, you can load the script directly from a CDN using [JSDelivr](https://www.jsdelivr.com/):

<!-- prettier-ignore -->
```html
<script type="module" src="https://cdn.jsdelivr.net/npm/twitch-video-element@0.1/+esm"></script>
```

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. 🕺
- [`<youtube-video>`](https://github.com/muxinc/media-elements/tree/main/packages/youtube-video-element) A custom element for the YouTube player.
- [`<spotify-audio>`](https://github.com/muxinc/media-elements/tree/main/packages/spotify-audio-element) A custom element for the Spotify player.
- [`<jwplayer-video>`](https://github.com/muxinc/media-elements/tree/main/packages/jwplayer-video-element) A custom element for the JW player.
- [`<videojs-video>`](https://github.com/muxinc/media-elements/tree/main/packages/videojs-video-element) A custom element for Video.js.
- [`<wistia-video>`](https://github.com/muxinc/media-elements/tree/main/packages/wistia-video-element) A custom element for the Wistia player.
- [`<cloudflare-video>`](https://github.com/muxinc/media-elements/tree/main/packages/cloudflare-video-element) A custom element for the Cloudflare player.
- [`<hls-video>`](https://github.com/muxinc/media-elements/tree/main/packages/hls-video-element) A custom element 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!
- [`<mux-player>`](https://github.com/muxinc/elements/tree/main/packages/mux-player) The official Mux-flavored video player custom element.
- [`<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.