media-mute-button

Accessible mute/unmute button with keyboard support and volume state reflection

Anatomy

<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; }

.mute-button[data-volume-level="off"] .icon-off { display: inline; }
.mute-button[data-volume-level="low"] .icon-low { display: inline; }
.mute-button[data-volume-level="medium"] .icon-medium { display: inline; }
.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, MuteButton } from '@videojs/react';
import { Video, videoFeatures } from '@videojs/react/video';

const Player = createPlayer({ features: videoFeatures });

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

.media-container {
  position: relative;
}

.media-container video {
  width: 100%;
}

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

Unmute Mute

<video-player class="video-player">
    <media-container>
        <video
            src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/highest.mp4"
            autoplay
            muted
            playsinline
            loop
        ></video>
        <media-mute-button class="media-mute-button">
            <span class="muted">Unmute</span>
            <span class="unmuted">Mute</span>
        </media-mute-button>
    </media-container>
</video-player>

.video-player {
  position: relative;
}

.video-player video {
  width: 100%;
}

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

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

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

Volume Levels

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

const Player = createPlayer({ features: videoFeatures });

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

.media-container {
  position: relative;
}

.media-container video {
  width: 100%;
}

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

Off Low Medium High

<video-player class="video-player">
    <media-container>
        <video
            src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/highest.mp4"
            autoplay
            muted
            playsinline
            loop
        ></video>
        <media-mute-button class="media-mute-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>
    </media-container>
</video-player>

.video-player {
  position: relative;
}

.video-player video {
  width: 100%;
}

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

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

.media-mute-button[data-volume-level="off"] .level-off {
  display: inline;
}
.media-mute-button[data-volume-level="low"] .level-low {
  display: inline;
}
.media-mute-button[data-volume-level="medium"] .level-medium {
  display: inline;
}
.media-mute-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`
Attribute `disabled` Description Whether the button is disabled.
`label`	'play' \| 'pause' \| 'replay' \| 'mute' \| 'unmute' \| 'seekForward' \| 'seekBackward' \| 'enterFullscreen' \| 'exitFullscreen' \| 'enableCaptions' \| 'disableCaptions' \| 'enterPictureInPicture' \| 'exitPictureInPicture' \| 'playingLive' \| 'seekToLiveEdge' \| 'liveBadge' \| 'startCasting' \| 'stopCasting' \| 'connectingCast' \| 'seek' \| 'volume' \| 'timeCurrent' \| 'timeDuration' \| 'timeRemaining' \| 'timeRemainingPhrase' \| 'playbackRateAria' \| 'timeSliderValueTextRange' \| 'volumeSliderValueTextMuted' \| 'indicatorMuted' \| 'indicatorVolume' \| 'indicatorVolumeWithValue' \| 'indicatorCaptionsOn' \| 'indicatorCaptionsOff' \| 'indicatorPaused' \| 'indicatorPlaying' \| 'indicatorFullscreen' \| 'indicatorExitFullscreen' \| 'indicatorPictureInPicture' \| 'indicatorExitPictureInPicture' \| 'mediaErrorAborted' \| 'mediaErrorNetwork' \| 'mediaErrorDecode' \| 'mediaErrorSrcNotSupported' \| 'mediaErrorEncrypted' \| 'mediaErrorCustom' \| 'errorDialogTitle' \| 'errorDialogDismiss' \| 'mediaErrorFallback' \| string & object \| function	`''`
Attribute `label` Description Custom label for the button. Type 'play' \| 'pause' \| 'replay' \| 'mute' \| 'unmute' \| 'seekForward' \| 'seekBackward' \| 'enterFullscreen' \| 'exitFullscreen' \| 'enableCaptions' \| 'disableCaptions' \| 'enterPictureInPicture' \| 'exitPictureInPicture' \| 'playingLive' \| 'seekToLiveEdge' \| 'liveBadge' \| 'startCasting' \| 'stopCasting' \| 'connectingCast' \| 'seek' \| 'volume' \| 'timeCurrent' \| 'timeDuration' \| 'timeRemaining' \| 'timeRemainingPhrase' \| 'playbackRateAria' \| 'timeSliderValueTextRange' \| 'volumeSliderValueTextMuted' \| 'indicatorMuted' \| 'indicatorVolume' \| 'indicatorVolumeWithValue' \| 'indicatorCaptionsOn' \| 'indicatorCaptionsOff' \| 'indicatorPaused' \| 'indicatorPlaying' \| 'indicatorFullscreen' \| 'indicatorExitFullscreen' \| 'indicatorPictureInPicture' \| 'indicatorExitPictureInPicture' \| 'mediaErrorAborted' \| 'mediaErrorNetwork' \| 'mediaErrorDecode' \| 'mediaErrorSrcNotSupported' \| 'mediaErrorEncrypted' \| 'mediaErrorCustom' \| 'errorDialogTitle' \| 'errorDialogDismiss' \| 'mediaErrorFallback' \| string & object \| ((state: MuteButtonState) => TranslationKeyOrString)

State

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

State is reflected as data attributes for CSS styling.

Property	Type	Details
`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
`muted`	`boolean`
Description Whether audio is muted.
`label`	`'play' \| 'pause' \| 'replay' \| 'mute' ...`
Type 'play' \| 'pause' \| 'replay' \| 'mute' \| 'unmute' \| 'seekForward' \| 'seekBackward' \| 'enterFullscreen' \| 'exitFullscreen' \| 'enableCaptions' \| 'disableCaptions' \| 'enterPictureInPicture' \| 'exitPictureInPicture' \| 'playingLive' \| 'seekToLiveEdge' \| 'liveBadge' \| 'startCasting' \| 'stopCasting' \| 'connectingCast' \| 'seek' \| 'volume' \| 'timeCurrent' \| 'timeDuration' \| 'timeRemaining' \| 'timeRemainingPhrase' \| 'playbackRateAria' \| 'timeSliderValueTextRange' \| 'volumeSliderValueTextMuted' \| 'indicatorMuted' \| 'indicatorVolume' \| 'indicatorVolumeWithValue' \| 'indicatorCaptionsOn' \| 'indicatorCaptionsOff' \| 'indicatorPaused' \| 'indicatorPlaying' \| 'indicatorFullscreen' \| 'indicatorExitFullscreen' \| 'indicatorPictureInPicture' \| 'indicatorExitPictureInPicture' \| 'mediaErrorAborted' \| 'mediaErrorNetwork' \| 'mediaErrorDecode' \| 'mediaErrorSrcNotSupported' \| 'mediaErrorEncrypted' \| 'mediaErrorCustom' \| 'errorDialogTitle' \| 'errorDialogDismiss' \| 'mediaErrorFallback' \| string & object

Data attributes

Attribute	Type	Details
`data-muted`
Description Present when the media is muted.
`data-volume-level`	`'off' \| 'medium' \| 'low' \| 'high'`
Description Indicates the volume level.