# @mux/mux-player

> An open source Mux player web component that Just Works™

Latest version **3.13.3** (published 2026-09-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install @mux/mux-player
pnpm add @mux/mux-player
yarn add @mux/mux-player
bun add @mux/mux-player
```

## Health

**Score 55/100 (C)** — status: active.

Positive: no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 3.13.3 |
| Published | 2026-09-09 |
| First published | 2022-06-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 363 |
| Author | Mux, Inc. |
| Maintainers | jsanford8, dylanjha, phil-mux, mux-npmjs |
| Keywords | video, mux, player, hls, web-component |

## Links

- npm: https://www.npmjs.com/package/@mux/mux-player
- Repository: https://github.com/muxinc/elements
- Homepage: https://mux.com/player
- Issues: https://github.com/muxinc/elements/issues
- npm.io page: https://npm.io/package/@mux/mux-player

## 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

- 3.13.3 (latest) — 2026-09-09
- 3.13.4-canary.2 (canary) — 2026-09-15
- 3.13.4-canary.1 — 2026-09-15
- 3.13.4-canary.0 — 2026-09-14
- 3.13.3-canary.2 — 2026-09-09
- 3.13.3-canary.1 — 2026-09-09
- 3.13.3-canary.0 — 2026-09-09
- 3.13.2 — 2026-07-23
- 3.13.1-canary.3 — 2026-05-08
- 3.13.1-canary.2 — 2026-05-08
- 3.13.1-canary.1 — 2026-05-08
- 3.13.1-canary.0 — 2026-05-04
- 3.13.0 — 2026-04-28
- 3.12.1-canary.0 — 2026-04-28
- 3.12.0 — 2026-04-24
- … 739 more at https://npm.io/package/@mux/mux-player/versions

## README

<p align="center">
  <h1 align="center">&lt;mux-player&gt;</h1>
  <a href="https://npmcharts.com/compare/@mux/mux-player?interval=30"><img src="https://img.shields.io/npm/dm/@mux/mux-player.svg?sanitize=true" alt="Downloads"></a>
    <a href="https://www.npmjs.com/package/@mux/mux-player"><img src="https://img.shields.io/npm/v/@mux/mux-player.svg?sanitize=true" alt="Version"></a>
    <a href="https://www.npmjs.com/package/@mux/mux-player"><img src="https://img.shields.io/npm/l/@mux/mux-player.svg?sanitize=true" alt="License"></a>
</p>

# New release: 3.0

Mux Player recently released 3.0. The most visible change in this is new tooltips that are enabled by default, as well as [other fixes and changes](https://docs.mux.com/guides/player-releases-web#300).

## Previous version: 2.0

For changes relating to the previous major release, 2.0, see the [V1 to V2 upgrade guide](https://github.com/muxinc/elements/blob/main/packages/mux-player/UPGRADING_V1_to_V2.md) and the [blog post announcement](https://www.mux.com/blog/mux-player-2-0-for-web-and-coming-soon-for-ios-and-android).

# Introduction

`<mux-player>` is the official Mux-flavored video player web component.

The player UI is built on [Media Chrome](https://media-chrome.org) and [`<mux-video>`](../mux-video) drives the core video logic used to play Mux Video content.

# Installation

```shell
npm install @mux/mux-player
```

or

```shell
yarn add @mux/mux-player
```

# Usage

```html
<mux-player
  playback-id="DS00Spx1CV902MCtPj5WknGlR102V5HFkDe"
  metadata-video-title="Big Buck Bunny"
  metadata-viewer-user-id="user-id-1234"
></mux-player>
```

# Docs

Docs and guides live on [docs.mux.com](https://docs.mux.com/guides/video/mux-player?utm_source=github-mux-player).

API reference lives [on Github](./REFERENCE.md).

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