useFullscreen

Category

Browser

Hook to handle fullscreen events

import { useFullscreen } from '@elysiumorg/solid-use';

Usage

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

Demo

source

Api

Parameters

Name	Type	Default	Note
target	Target	-	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

Returns

UseFullScreenReturn

Parameters

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

Returns

UseFullScreenReturn & { ref: RefObject<Target> }