Skip to content
aq-ui
Back to HooksHook

Use Fullscreen

Open-code aq-ui React hook for Use Fullscreen.

Installation

pnpm dlx aq-ui@alpha add use-fullscreen

API reference

Client module

Import the parts you need, then jump to an export for its contract.

View full source

Quick start

"use client"

import { useFullscreen } from "@/hooks/use-fullscreen"

const result = useFullscreen()

FullscreenControls

interfaceSource L7

Type contract for FullscreenControls.

interface FullscreenControls

Members

NameType
activeboolean
supportedboolean
errorunknown
enter() => Promise<boolean>
exit() => Promise<boolean>
toggle() => Promise<boolean>

useFullscreen

functionSource L16

Open-code aq-ui React hook for Use Fullscreen.

function useFullscreen(target?: Target<Element>): FullscreenControls
Returns
FullscreenControls

Parameters

NameType
target?Target<Element>
const result = useFullscreen()

Registry dependencies

hook-target

Files

  • hooks/use-fullscreen.ts

Source