useVisibilityEvent

useVisibilityEvent es un Hook de React que escucha los cambios en el estado de visibilidad del documento y ejecuta un callback.

Interfaz

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

Parámetros

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

  Una función que el Hook llama cuando cambia el estado de visibilidad. Recibe como argumento el estado de visibilidad actual ('visible' o 'hidden').

• optionsobject
  

  Configuración opcional del Hook.

  • options.immediateboolean · false
    

    Si es true, el Hook ejecuta el callback inmediatamente al montar el componente, con el estado de visibilidad actual.

Valor de retorno

Esta función no devuelve ningún valor.

Ejemplo

import { useVisibilityEvent } from 'react-simplikit';

function Component() {
  useVisibilityEvent(visibilityState => {
    console.log(`El estado del documento ahora es ${visibilityState}`);
  });

  return <p>Consulta los cambios de visibilidad en la consola.</p>;
}