rooks/dist/cjs/hooks/useWindowEventListener.js

Essential React custom hooks ⚓ to super charge your components!

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.useWindowEventListener = void 0;
var useGlobalObjectEventListener_1 = require("./useGlobalObjectEventListener");
/**
 *  useWindowEventListener hook
 *
 *  A react hook to an event listener to the window
 *
 * @param {string} eventName The event to track
 * @param {Function} callback The callback to be called on event
 * @param {ListenerOptions} listenerOptions The options to be passed to the event listener
 * @param {boolean} isLayoutEffect Should it use layout effect. Defaults to false
 * @returns {undefined}
 * @see https://react-hooks.org/docs/useWindowEventListener
 */
function useWindowEventListener(eventName, callback, listenerOptions, isLayoutEffect) {
    if (listenerOptions === void 0) { listenerOptions = {}; }
    if (isLayoutEffect === void 0) { isLayoutEffect = false; }
    (0, useGlobalObjectEventListener_1.useGlobalObjectEventListener)(global.window, eventName, callback, listenerOptions, true, isLayoutEffect);
}
exports.useWindowEventListener = useWindowEventListener;