useFullscreen

v0.0.15testeddemo

Reactive Fullscreen API for an element (or the document element). Handles vendor-prefixed fallbacks for request/exit/state detection and syncs `isFullscreen` from `fullscreenchange` events. SSR-safe.

Source Tests

Examples

const el = useTemplateRef('el');
const { isFullscreen, enter, exit, toggle } = useFullscreen(el);

// Fullscreen the whole page
const { toggle } = useFullscreen();

Demo

Loading demo…

Signature

export function useFullscreen(
  target?: MaybeComputedElementRef,
  options: UseFullscreenOptions ={ ... }

Parameters

Parameter	Type	Default	Description
`target`?	`any`	—	Element to display fullscreen (ref, getter, or component instance). Defaults to `document.documentElement`
`options`?	`UseFullscreenOptions`	`{}`	Options (`document`, `autoExit`)

Returns

UseFullscreenReturn`{ isSupported, isFullscreen, enter, exit, toggle }`