useVisibilityEvent

useVisibilityEvent 是一个监听文档可见性状态变化并触发回调的 React Hook。

接口

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

参数

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

  当可见性状态变化时被调用的函数。它接收当前的可见性状态（'visible' 或 'hidden'）作为参数。

• optionsobject
  

  Hook 的可选配置。

  • options.immediateboolean · false
    

    如果为 true，回调会在挂载时立即以当前的可见性状态被调用。

返回值

此函数不返回任何内容。

示例

import { useVisibilityEvent } from 'react-simplikit';

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

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