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

Core utilities built for AppBuckets React UI Framework

'use strict';

var React = require('react');

function _interopNamespace(e) {
  if (e && e.__esModule) return e;
  var n = Object.create(null);
  if (e) {
    Object.keys(e).forEach(function (k) {
      if (k !== 'default') {
        var d = Object.getOwnPropertyDescriptor(e, k);
        Object.defineProperty(
          n,
          k,
          d.get
            ? d
            : {
                enumerable: true,
                get: function () {
                  return e[k];
                },
              }
        );
      }
    });
  }
  n['default'] = e;
  return Object.freeze(n);
}

var React__namespace = /*#__PURE__*/ _interopNamespace(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__namespace.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]
  );
}

module.exports = useDOMElementEvent;