useVisibilityEvent

useVisibilityEvent is a React hook that listens to changes in the document's visibility state and triggers a callback.

Interface

function useVisibilityEvent(
  callback: (visibilityState: 'visible' | 'hidden') => void,
  options?: object
): void;

Parameters

• callbackrequired · (visibilityState: 'visible' | 'hidden') => void
  

  A function to be called when the visibility state changes. It receives the current visibility state ('visible' or 'hidden') as an argument.

• optionsobject
  

  Optional configuration for the hook.

  • options.immediateboolean · false
    

    If true, the callback is invoked immediately upon mounting with the current visibility state.

Return Value

This function does not return anything.

Example

import { useVisibilityEvent } from 'react-simplikit';

function Component() {
  useVisibilityEvent(visibilityState => {
    console.log(`Document is now ${visibilityState}`);
  });

  return <p>Check the console for visibility changes.</p>;
}