useBeforeUnload

概要

リファレンスドキュメント ↗

Window の beforeunload イベントで発火するコールバックを設定します。

シグネチャ

function useBeforeUnload(
  callback: (event: BeforeUnloadEvent) => any,
  options?: {
    capture?: boolean;
  },
): void

パラメータ

callback

beforeunload イベントが発火したときに呼び出される callback です。

options.capture

true の場合、イベントはキャプチャフェーズ中に捕捉されます。デフォルトは false です。

戻り値

戻り値はありません。