media-mute-button

A button component for muting and unmuting audio playback

Anatomy

<MuteButton />

<media-mute-button></media-mute-button>

Behavior

Toggles mute on and off, and exposes a derived volumeLevel based on the current volume and mute state.

Styling

Style the button based on muted state:

media-mute-button[data-muted] .icon-muted { display: inline; }
media-mute-button:not([data-muted]) .icon-unmuted { display: inline; }

Use data-volume-level for multi-level icon switching:

media-mute-button[data-volume-level="off"] .icon-off { display: inline; }
media-mute-button[data-volume-level="low"] .icon-low { display: inline; }
media-mute-button[data-volume-level="medium"] .icon-medium { display: inline; }
media-mute-button[data-volume-level="high"] .icon-high { display: inline; }

Accessibility

Renders a <button> with an automatic aria-label: “Unmute” when muted, “Mute” when unmuted. Override with the label prop. Keyboard activation: Enter / Space.

Examples

Basic Usage

import { createPlayer, features, MuteButton } from '@videojs/react';
import { Video } from '@videojs/react/video';

import './BasicUsage.css';

const Player = createPlayer({ features: [...features.video] });

export default function BasicUsage() {
  return (
    <Player.Provider>
      <Player.Container className="react-mute-button-basic">
        <Video
          src="https://stream.mux.com/lhnU49l1VGi3zrTAZhDm9LUUxSjpaPW9BL4jY25Kwo4/highest.mp4"
          autoPlay
          muted
          playsInline
          loop
        />
        <MuteButton
          className="react-mute-button-basic__button"
          render={(props, state) => <button {...props}>{state.muted ? 'Unmute' : 'Mute'}</button>}
        />
      </Player.Container>
    </Player.Provider>
  );
}

.react-mute-button-basic {
  position: relative;
}

.react-mute-button-basic video {
  width: 100%;
}

.react-mute-button-basic__button {
  padding-block: 8px;
  position: absolute;
  bottom: 10px;
  left: 10px;
  background: rgba(255, 255, 255, 0.7);
  backdrop-filter: blur(10px);
  color: black;
  border: 1px solid rgba(255, 255, 255, 0.3);
  border-radius: 9999px;
  padding-inline: 20px;
  cursor: pointer;
}

Unmute Mute

<video-player class="html-mute-button-basic">
    <video
        src="https://stream.mux.com/lhnU49l1VGi3zrTAZhDm9LUUxSjpaPW9BL4jY25Kwo4/highest.mp4"
        autoplay
        muted
        playsinline
        loop
    ></video>
    <media-mute-button class="html-mute-button-basic__button">
        <span class="show-when-muted">Unmute</span>
        <span class="show-when-unmuted">Mute</span>
    </media-mute-button>
</video-player>

.html-mute-button-basic {
  position: relative;
}

.html-mute-button-basic video {
  width: 100%;
}

.html-mute-button-basic__button {
  padding-block: 8px;
  position: absolute;
  bottom: 10px;
  left: 10px;
  background: rgba(255, 255, 255, 0.7);
  backdrop-filter: blur(10px);
  color: black;
  border: 1px solid rgba(255, 255, 255, 0.3);
  border-radius: 9999px;
  padding-inline: 20px;
  cursor: pointer;
}

.html-mute-button-basic__button .show-when-muted {
  display: none;
}
.html-mute-button-basic__button .show-when-unmuted {
  display: none;
}
.html-mute-button-basic__button[data-muted] .show-when-muted {
  display: inline;
}
.html-mute-button-basic__button:not([data-muted]) .show-when-unmuted {
  display: inline;
}

import '@videojs/html/video/player';
import '@videojs/html/ui/mute-button';

Volume Levels

import { createPlayer, features, MuteButton } from '@videojs/react';
import { Video } from '@videojs/react/video';

import './VolumeLevels.css';

const Player = createPlayer({ features: [...features.video] });

export default function VolumeLevels() {
  return (
    <Player.Provider>
      <Player.Container className="react-mute-button-volume-levels">
        <Video
          src="https://stream.mux.com/lhnU49l1VGi3zrTAZhDm9LUUxSjpaPW9BL4jY25Kwo4/highest.mp4"
          autoPlay
          muted
          playsInline
          loop
        />
        <MuteButton
          className="react-mute-button-volume-levels__button"
          render={(props, state) => (
            <button {...props}>
              {state.volumeLevel === 'off'
                ? 'Off'
                : state.volumeLevel === 'low'
                  ? 'Low'
                  : state.volumeLevel === 'medium'
                    ? 'Medium'
                    : 'High'}
            </button>
          )}
        />
      </Player.Container>
    </Player.Provider>
  );
}

.react-mute-button-volume-levels {
  position: relative;
}

.react-mute-button-volume-levels video {
  width: 100%;
}

.react-mute-button-volume-levels__button {
  padding-block: 8px;
  position: absolute;
  bottom: 10px;
  left: 10px;
  background: rgba(255, 255, 255, 0.7);
  backdrop-filter: blur(10px);
  color: black;
  border: 1px solid rgba(255, 255, 255, 0.3);
  border-radius: 9999px;
  padding-inline: 20px;
  cursor: pointer;
}

Off Low Medium High

<video-player class="html-mute-button-volume-levels">
    <video
        src="https://stream.mux.com/lhnU49l1VGi3zrTAZhDm9LUUxSjpaPW9BL4jY25Kwo4/highest.mp4"
        autoplay
        muted
        playsinline
        loop
    ></video>
    <media-mute-button class="html-mute-button-volume-levels__button">
        <span class="level-off">Off</span>
        <span class="level-low">Low</span>
        <span class="level-medium">Medium</span>
        <span class="level-high">High</span>
    </media-mute-button>
</video-player>

.html-mute-button-volume-levels {
  position: relative;
}

.html-mute-button-volume-levels video {
  width: 100%;
}

.html-mute-button-volume-levels__button {
  padding-block: 8px;
  position: absolute;
  bottom: 10px;
  left: 10px;
  background: rgba(255, 255, 255, 0.7);
  backdrop-filter: blur(10px);
  color: black;
  border: 1px solid rgba(255, 255, 255, 0.3);
  border-radius: 9999px;
  padding-inline: 20px;
  cursor: pointer;
}

.html-mute-button-volume-levels__button .level-off,
.html-mute-button-volume-levels__button .level-low,
.html-mute-button-volume-levels__button .level-medium,
.html-mute-button-volume-levels__button .level-high {
  display: none;
}

.html-mute-button-volume-levels__button[data-volume-level="off"] .level-off {
  display: inline;
}
.html-mute-button-volume-levels__button[data-volume-level="low"] .level-low {
  display: inline;
}
.html-mute-button-volume-levels__button[data-volume-level="medium"] .level-medium {
  display: inline;
}
.html-mute-button-volume-levels__button[data-volume-level="high"] .level-high {
  display: inline;
}

import '@videojs/html/video/player';
import '@videojs/html/ui/mute-button';

API Reference

Props

Prop	Type	Default
`disabled`	`boolean`	`false`
Description Whether the button is disabled. Type `boolean`
`label`	`string \| function`	`''`
Description Custom label for the button. Type `string \| ((state: MuteButtonState) => string)`

State

State is accessible via the render, className, and style props.

State is reflected as data attributes for CSS styling.

Property	Type
`volumeLevel`	`'off' \| 'low' \| 'medium' \| 'high'`
Description Derived volume level: `off`: muted or volume is 0 `low`: volume < 0.5 `medium`: volume < 0.75 `high`: volume >= 0.75 Type `'off' \| 'low' \| 'medium' \| 'high'`
`muted`	`boolean`
Description Whether audio is muted. Type `boolean`

Data attributes

Attribute	Description
`data-muted`	Present when the media is muted.
`data-volume-level`	Indicates the volume level.