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
Name | Type | Description |
---|---|---|
ref | RefObject | Ref to the element |
isFullscreen | boolean | Whether the element is in fullscreen mode |
requestFullscreen | () => void | Function to request fullscreen mode |
exitFullscreen | () => void | Function to exit fullscreen mode |
toggleFullscreen | () => void | Function to toggle fullscreen mode |