FrameworkStyle

PlayButton

Accessible play/pause button with keyboard support and customizable rendering

Anatomy 

<PlayButton />

Behavior

PlayButton is a three-state button: play , pause , and replay . When media reaches the end (ended state), clicking restarts playback from the beginning.

Styling

Style with the [data-paused] and [data-ended] attributes to show/hide play/pause/replay icons based on state. For example:

React renders a <button> element. Add a className to style it: 

/* Paused (but not ended) */
.play-button[data-paused]:not([data-ended]) .play-icon { display: inline; }

/* Playing */
.play-button:not([data-paused]) .pause-icon { display: inline; }

/* Ended */
.play-button[data-ended] .replay-icon { display: inline; }

After first play, the data-started attribute is added and remains present until a new source is loaded. Use this to hide the play button when media hasn’t started yet: 

/* Hide play button before first play */
.play-button:not([data-started]) .play-icon { display: none; }

Accessibility

Renders a <button> element with an automatic aria-label that updates based on state: “Play”, “Pause”, or “Replay”. Override with the label prop (accepts a string or function). Keyboard activation: Enter / Space.

Examples

Basic Usage 

import { createPlayer, PlayButton } 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-play-button-basic">
        <Video
          src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/highest.mp4"
          autoPlay
          muted
          playsInline
        />
        <PlayButton
          className="react-play-button-basic__button"
          render={(props, state) => (
            <button {...props}>{state.ended ? 'Replay' : state.paused ? 'Play' : 'Pause'}</button>
          )}
        />
      </Player.Container>
    </Player.Provider>
  );
}

API Reference

Props

Prop Type Default Details
disabled boolean false
label string | function ''

State

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

Property Type Details
paused boolean
ended boolean
started boolean
label string

Data attributes

Attribute Type Details
data-paused
data-ended
data-started