media-pip-button

Accessible picture-in-picture toggle button with keyboard support and state reflection

Import

import '@videojs/html/ui/pip-button';

Anatomy

<media-pip-button></media-pip-button>

Behavior

Toggles picture-in-picture (PiP) mode. The button derives two state hooks from availability:

disabled (true until PiP is available, or when the disabled prop is set) — sets aria-disabled="true" and data-disabled. A prop-disabled, available button stays focusable but does not activate.
hidden (true while PiP is "unavailable" or "unsupported") — applies the native HTML hidden attribute on the custom element; the React component returns null.

Styling

You can style the button based on PiP state:

/* In PiP mode */
media-pip-button[data-pip] {
  background: red;
}

/* Non-interactive (disabled prop) */
media-pip-button[data-disabled] {
  opacity: 0.5;
  cursor: not-allowed;
}

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

/* In PiP mode */
.pip-button[data-pip] {
  background: red;
}

/* Non-interactive (disabled prop) */
.pip-button[data-disabled] {
  opacity: 0.5;
  cursor: not-allowed;
}

The button remains hidden until picture-in-picture is available. The HTML element receives the native hidden attribute, and the React component returns null. No extra CSS is required.

Accessibility

Renders a <button> with an automatic aria-label: “Enter PiP” or “Exit PiP”. Override with the label prop. Keyboard activation: Enter / Space.

Examples

Basic Usage

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

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

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

.media-container {
  position: relative;
}

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

.media-pip-button {
  position: absolute;
  right: 10px;
  bottom: 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);
}

Exit PiP Enter PiP

<video-player class="video-player">
  <media-container>
    <video src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/highest.mp4" autoplay muted playsinline loop></video>
    <media-pip-button class="media-pip-button">
      <span class="pip">Exit PiP</span>
      <span class="not-pip">Enter PiP</span>
    </media-pip-button>
  </media-container>
</video-player>

.video-player media-container {
  position: relative;
  display: block;
}

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

.media-pip-button {
  position: absolute;
  right: 10px;
  bottom: 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-pip-button .pip {
  display: none;
}
.media-pip-button .not-pip {
  display: none;
}
.media-pip-button[data-pip] .pip {
  display: inline;
}
.media-pip-button:not([data-pip]) .not-pip {
  display: inline;
}

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

API Reference

Props

Prop	Type	Default
`disabled`	`boolean`	`false`
Attribute `disabled` Description Whether the button is disabled.
`label`	`object`	`''`
Attribute `label` Description Custom label for the button. Type `{ key: string; text: string } \| string \| ((state: PiPButtonState) => Text \| string)`

State

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

State is reflected as data attributes for CSS styling.

Property	Type	Details
`pip`	`boolean`
Description Whether picture-in-picture mode is currently active.
`label`	`{ key: string; text: string } \| string`
`availability`	`MediaPictureInPictureState['pipAvailability']`
Description Whether picture-in-picture can be requested on this platform.
`disabled`	`boolean`
Description Non-interactive but still focusable (mirrors `aria-disabled`).
`hidden`	`boolean`
Description Whether the button is hidden until picture-in-picture is available.

Data attributes

Attribute	Type	Details
`data-pip`
Description Present when picture-in-picture mode is active.
`data-availability`	`MediaPictureInPictureState['pipAvailability']`
Description Indicates picture-in-picture availability (`available`, `unavailable`, `unsupported`).
`data-disabled`
Description Present when the button is non-interactive (mirrors `aria-disabled`).
`data-hidden`
Description Present when the button is hidden because picture-in-picture is not available.