rooks
Version:
Essential React custom hooks ⚓ to super charge your components!
22 lines (21 loc) • 1.09 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.useDocumentEventListener = void 0;
var useGlobalObjectEventListener_1 = require("./useGlobalObjectEventListener");
/**
* useDocumentEventListener hook
*
* @description A react hook to an event listener to the document
*
* @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
* @see https://react-hooks.org/docs/useDocumentEventListener
*/
function useDocumentEventListener(eventName, callback, listenerOptions, isLayoutEffect) {
if (listenerOptions === void 0) { listenerOptions = {}; }
if (isLayoutEffect === void 0) { isLayoutEffect = false; }
(0, useGlobalObjectEventListener_1.useGlobalObjectEventListener)(global.document, eventName, callback, listenerOptions, true, isLayoutEffect);
}
exports.useDocumentEventListener = useDocumentEventListener;