useFullscreen

browser

test coverage

Last changed: 24 days ago

Hook to handle fullscreen events

typescript

import { useFullscreen } from '@siberiacancode/reactuse';

Usage

typescript

const { enter, exit, toggle, value } = useFullscreen(ref);
// or
const { ref, enter, exit, toggle, value } = useFullscreen();

Name	Type	Default	Note
target	HookTarget	-	The target element for fullscreen
options.initialValue?	boolean	false	initial value of fullscreen
options.onEnter?	() => void	-	on enter fullscreen
options.onExit?	() => void	-	on exit fullscreen

Name	Type	Default	Note
options.initialValue?	boolean	false	initial value of fullscreen
options.onEnter?	() => void	-	on enter fullscreen
options.onExit?	() => void	-	on exit fullscreen

debabin

hywax