FrameworkStyle

FullscreenButton

A button component for entering and exiting fullscreen mode

Anatomy

<FullscreenButton />

Examples

Basic Usage

import { createPlayer, FullscreenButton, features, Video } from '@videojs/react';

import './BasicUsage.css';

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

export default function BasicUsage() {
  return (
    <Player.Provider>
      <Player.Container className="fullscreen-button-basic">
        <Video
          src="https://stream.mux.com/lhnU49l1VGi3zrTAZhDm9LUUxSjpaPW9BL4jY25Kwo4/highest.mp4"
          autoPlay
          muted
          playsInline
          loop
        />
        <FullscreenButton
          className="fullscreen-button-basic__button"
          render={(props, state) => <button {...props}>{state.fullscreen ? 'Exit Fullscreen' : 'Fullscreen'}</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'
fullscreen boolean

Data attributes

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