useVisibilityEvent

useVisibilityEvent は、ドキュメントの表示状態の変化を監視し、コールバックを呼び出す React フックです。

インターフェース

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

パラメータ

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

  表示状態が変わったときに呼び出す関数。現在の表示状態（'visible' または 'hidden'）を引数として受け取ります。

• optionsobject
  

  フックの省略可能な設定。

  • 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>;
}