react-use-pip
TypeScript icon, indicating that this package has built-in type declarations

1.5.0 • Public • Published

react-use-pip

npm semantic-release Package size License npm downloads

react-use-pip

React Hook for Picture in Picture.

Picture in Picture is a on going W3C draft so that websites to create a floating window to continue playing media while users interact with other content or sites. Before shipping your application with the feature, please be aware that the feature API is not widely supported yet across browsers and the implementation status can be found here. Please also see Can I Use for more information.

Features

  • Lightweight and easy to use.
  • Picture in picture browser support detection.
  • TypeScript friendly. react-use-pip hook is written in TypeScript.
  • Picture in Picture mode control with your own custom Event handlers.

Support

  • react-use-pip supports React versions from 16.9.0 up. It also supports React 17 and React 18.

Install

In your project directory, run

npm install --save react-use-pip

Or with Yarn

yarn add react-use-pip

Quick Start

import usePictureInPicture from 'react-use-pip'

function VideoPlayer() {
  const videoRef = useRef(null)
  const {
    isPictureInPictureActive,
    isPictureInPictureAvailable,
    togglePictureInPicture,
  } = usePictureInPicture(videoRef)

  return (
    <div className="App">
      <video ref={videoRef} autoPlay muted controls loop width="100%">
        <source src="video-sample.mp4" />
      </video>
      {isPictureInPictureAvailable && (
        <button
          onClick={() => togglePictureInPicture(!isPictureInPictureActive)}
        >
          {isPictureInPictureActive ? 'Disable' : 'Enable'} Picture in Picture
        </button>
      )}
    </div>
  )
}

API

const {
  isPictureInPictureActive,
  isPictureInPictureAvailable,
  togglePictureInPicture,
} = usePictureInPicture(videoRef, options)

Parameters

  • videoRef: Ref to pass in to video element as a prop
  • options: (optional) an object that provides the hook a set of callback functions.

Return Values

  • isPictureInPictureActive = false: boolean that signals whether picture in picture mode is active or inactive
  • isPictureInPictureAvailable: boolean that signals whether picture in picture mode is supported and enabled
  • togglePictureInPicture(isActive: boolean) => void: function that provide you toggle picture in picture mode

Options (Optional)

  • onEnterPictureInPicture(event: Event) => void: (optional) callback function when entering picture in picture mode
  • onLeavePictureInPicture(event: Event) => void: (optional) callback function when leaving picture in picture mode
  • onRequestPictureInPictureError(error: any) => void: (optional) callback function when there is an error requesting picture in picture
  • onExitPictureInPictureError(error: any) => void: (optional) callback function when there is an error exiting picture in picture

License

MIT © DawChihLiou

Package Sidebar

Install

npm i react-use-pip

Weekly Downloads

406

Version

1.5.0

License

MIT

Unpacked Size

94.3 kB

Total Files

14

Last publish

Collaborators

  • dawchihliou