Docs
useFullscreen

Manage fullscreen mode for a specific element or the entire document with useFullscreen.

Loading...

Installation

pnpm dlx shadcn@latest add https://usekit.kiron.dev/k/use-fullscreen

Usage

"use client"
 
import { useFullscreen } from "@/hooks/use-fullscreen"
 
export function Component() {
  const {
    ref,
    isFullscreen,
    requestFullscreen,
    exitFullscreen,
    toggleFullscreen,
  } = useFullscreen()
 
  return (
    <div>
      <button onClick={toggleFullscreen}>
        {isFullscreen ? "Exit Fullscreen" : "Enter Fullscreen"}
      </button>
      <div
        ref={ref}
        style={{ width: "100%", height: "100vh", backgroundColor: "lightgray" }}
      >
        <h1>Toggle Fullscreen</h1>
      </div>
    </div>
  )
}

API Reference

Return Values

NameTypeDescription
refRefObjectRef to the element
isFullscreenbooleanWhether the element is in fullscreen mode
requestFullscreen() => voidFunction to request fullscreen mode
exitFullscreen() => voidFunction to exit fullscreen mode
toggleFullscreen() => voidFunction to toggle fullscreen mode