Skip to content

useFullscreen

Toggle fullscreen mode. Uses fullscreenContainerRef from the provider and supports cross-browser vendor prefixes (webkit, ms).

const { isFullscreen, toggle, enter, exit, containerRef } = useFullscreen();
Field/MethodTypeDescription
isFullscreenbooleanCurrent fullscreen state
toggle()() => voidToggle
enter()() => voidEnter fullscreen
exit()() => voidExit fullscreen
containerRefRefObject<HTMLElement | null>The same ref from the provider
const { containerRef, toggle, isFullscreen } = useFullscreen();
<div ref={containerRef as React.RefObject<HTMLDivElement>}>
<button onClick={toggle}>{isFullscreen ? "Exit" : "Fullscreen"}</button>
<ChartView />
</div>;

Fullscreen relies on the browser Fullscreen API, which requires a user gesture — call toggle/enter from a click handler.