@appbuckets/react-ui-core/esm/useDOMElementEvent/index.js

Core utilities built for AppBuckets React UI Framework

import * as React from 'react';

/* --------
 * Hook Definition
 * -------- */
function useDOMElementEvent(config) {
  var callback = config.callback,
    disabled = config.disabled,
    event = config.event,
    target = config.target;
  // ----
  // Hook is limited to a useEffect with event listener attached
  // ----
  React.useEffect(
    function () {
      /** If hook is disabled return */
      if (disabled) {
        return;
      }
      var elementTarget = target || document.documentElement;
      /** Attach the event */
      elementTarget.addEventListener(event, callback);
      /** On component unmount, detach the event */
      return function () {
        return elementTarget.removeEventListener(event, callback);
      };
    },
    [disabled, event, target, callback]
  );
}

export { useDOMElementEvent as default };