useDocumentVisibility

Hook that provides the current visibility state of the document

browser

low

test coverage

Last changed: 20 days ago

Installation

Library

CLI

Manual

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

Usage

const visibilityState = useDocumentVisibility();
// or
const visibilityState = useDocumentVisibility((state) => { if (state === 'hidden') console.log('user left the tab'); });

Demo

source

Api

Parameters

Name	Type	Default	Note
callback?	(state: DocumentVisibilityState) => void	-	The callback to execute when the visibility state changes

Returns

DocumentVisibilityState

Source

Source • Demo

Contributors

D

debabin

H

hywax

W

wmoooid