FrameworkStyle

PiPButton

A button component for entering and exiting picture-in-picture mode

Anatomy 

<PiPButton />

Behavior

Toggles picture-in-picture (PiP) mode. Detects platform support through availability — when PiP is "unsupported", the toggle does nothing.

Styling

You can style the button based on PiP state: 

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

Consider hiding the button when unsupported: 

media-pip-button[data-availability="unsupported"] {
  display: none;
}

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 { createPlayer, features, PiPButton, Video } from '@videojs/react';

import './BasicUsage.css';

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

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

API Reference

Props

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

State

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

Property Type
availability 'available' | 'unavailable' | 'unsupported'
pip boolean

Data attributes

Attribute Description
data-pip Present when picture-in-picture mode is active.
data-availability Indicates picture-in-picture availability (available or unsupported).
VideoJS