media-captions-button

Accessible captions toggle button with availability detection and state reflection

Anatomy

<media-captions-button></media-captions-button>

Behavior

Toggles captions and subtitles on and off. The button checks the media’s text track list for tracks with kind="captions" or kind="subtitles" and reflects availability via data-availability.

When no caption or subtitle tracks are present, data-availability="unavailable" is set. Use this to hide the button when there are no tracks to toggle.

Styling

Style the button based on active state:

media-captions-button[data-active] .icon-on { display: inline; }
media-captions-button:not([data-active]) .icon-off { display: inline; }

Hide when no caption tracks are available:

media-captions-button[data-availability="unavailable"] {
  display: none;
}

Accessibility

Renders a <button> with an automatic aria-label: “Disable captions” when active, “Enable captions” when inactive. Override with the label prop. Keyboard activation: Enter / Space.

Examples

Basic Usage

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

import './BasicUsage.css';

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

export default function BasicUsage() {
  return (
    <Player.Provider>
      <Player.Container className="react-captions-button-basic">
        <Video
          src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/highest.mp4"
          autoPlay
          muted
          playsInline
          loop
        >
          <track kind="captions" src="/docs/demos/captions-button/captions.vtt" srcLang="en" label="English" />
        </Video>
        <CaptionsButton
          className="react-captions-button-basic__button"
          render={(props, state) => (
            <button {...props}>{state.subtitlesShowing ? 'Captions Off' : 'Captions On'}</button>
          )}
        />
      </Player.Container>
    </Player.Provider>
  );
}

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

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

.react-captions-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;
}

<video-player class="html-captions-button-basic">
    <media-container>
        <video
            src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/highest.mp4"
            autoplay
            muted
            playsinline
            loop
        >
            <track kind="captions" src="/docs/demos/captions-button/captions.vtt" srclang="en" label="English" />
        </video>
        <media-captions-button class="html-captions-button-basic__button">
            <span class="show-when-active">Captions Off</span>
            <span class="show-when-inactive">Captions On</span>
        </media-captions-button>
    </media-container>
</video-player>

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

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

.html-captions-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-captions-button-basic__button .show-when-active {
  display: none;
}
.html-captions-button-basic__button .show-when-inactive {
  display: none;
}
.html-captions-button-basic__button[data-active] .show-when-active {
  display: inline;
}
.html-captions-button-basic__button:not([data-active]) .show-when-inactive {
  display: inline;
}

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

API Reference

Props

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

State

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

State is reflected as data attributes for CSS styling.

Property	Type
`availability`	`'available' \| 'unavailable'`
`subtitlesShowing`	`boolean`
Description Whether captions/subtitles are currently enabled.

Data attributes

Attribute	Type
`data-active`
Description Present when captions are enabled.
`data-availability`	`'available' \| 'unavailable'`
Description Indicates captions availability (`available` or `unavailable`).