UNPKG

@hypothesis/frontend-shared

Version:

Shared components, styles and utilities for Hypothesis projects

github.com/hypothesis/frontend-shared

hypothesis/frontend-shared

11 lines (10 loc) • 556 B
1
2
3
4
5
6
7
8
9
10
11
/** * Registers an event listener to window's 'beforeunload' if `hasUnsavedData` is true. * It also unregisters the event if `hasUnsavedData` is false or the component is unmounted. * * This event listener makes the browser warn the user about potential unsaved changes, * and gives the user the opportunity to cancel the page unload if desired. * * @link https://developer.mozilla.org/en-US/docs/Web/API/Window/beforeunload_event */ export declare function useWarnOnPageUnload(hasUnsavedData: boolean, window_?: Window & typeof globalThis): void;