# hls-video-element

> Custom element (web component) for playing video using the HTTP Live Streaming (HLS) format. Uses HLS.js.

Latest version **1.5.12** (published 2026-10-22) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 75/100 (B)** — status: active.

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

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.5.12 |
| Published | 2026-10-22 |
| First published | 2020-03-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 40.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 266 |
| Author | @muxinc |
| Maintainers | heff, mmcc, jsanford8, mux-npmjs |
| Keywords | HLS, video, player |

## Links

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

## Dependencies (3)

- [hls.js](https://npm.io/package/hls.js.md) ^1.6.5
- [media-tracks](https://npm.io/package/media-tracks.md) ^0.3.5
- [custom-media-element](https://npm.io/package/custom-media-element.md) ^1.4.7

## 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.5.12 (latest) — 2026-10-22
- 1.5.11 — 2026-03-19
- 1.5.10 — 2025-11-25
- 1.5.9 — 2025-11-10
- 1.5.8 — 2025-09-19
- 1.5.7 — 2025-08-08
- 1.5.6 — 2025-07-15
- 1.5.5 — 2025-06-26
- 1.5.4 — 2025-06-09
- 1.5.3 — 2025-06-07
- 1.5.2 — 2025-05-23
- 1.5.1 — 2025-04-29
- 1.5.0 — 2025-03-12
- 1.4.1 — 2024-12-20
- 1.4.0 — 2024-12-19
- … 33 more at https://npm.io/package/hls-video-element/versions

## README

# `<hls-video>`

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

A [custom element](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) 
for [hls.js](https://github.com/video-dev/hls.js) 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/hls-video-element@1.1/+esm"></script>
<hls-video controls src="https://stream.mux.com/r4rOE02cc95tbe3I00302nlrHfT023Q3IedFJW029w018KxZA.m3u8"></hls-video>
```

## Install

First install the NPM package:

```bash
npm install hls-video-element
```

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

```js
import 'hls-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/hls-video-element@1.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.
- [`<vimeo-video>`](https://github.com/muxinc/media-elements/tree/main/packages/vimeo-video-element) A custom element for the Vimeo 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.
- [`<jwplayer-video>`](https://github.com/muxinc/media-elements/tree/main/packages/jwplayer-video-element) A custom element for the JW player.
- [`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.

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