primereact 8.7.2 → 9.0.0-beta.1

package/hooks/hooks.cjs.js

@@ -47,7 +47,6 @@ var useUpdateEffect = function useUpdateEffect(fn, deps) {
       mounted.current = true;
       return;
     }
-
     return fn && fn();
   }, deps);
 };
@@ -64,40 +63,34 @@ var useUnmountEffect = function useUnmountEffect(fn) {
 /* eslint-disable */
 var useEventListener = function useEventListener(_ref) {
   var _ref$target = _ref.target,
-      target = _ref$target === void 0 ? 'document' : _ref$target,
-      type = _ref.type,
-      listener = _ref.listener,
-      options = _ref.options,
-      _ref$when = _ref.when,
-      when = _ref$when === void 0 ? true : _ref$when;
+    target = _ref$target === void 0 ? 'document' : _ref$target,
+    type = _ref.type,
+    listener = _ref.listener,
+    options = _ref.options,
+    _ref$when = _ref.when,
+    when = _ref$when === void 0 ? true : _ref$when;
   var targetRef = React__namespace.useRef(null);
   var listenerRef = React__namespace.useRef(null);
   var prevOptions = usePrevious(options);
-
   var bind = function bind() {
     var bindOptions = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-
     if (utils.ObjectUtils.isNotEmpty(bindOptions.target)) {
       unbind();
       (bindOptions.when || when) && (targetRef.current = utils.DomHandler.getTargetElement(bindOptions.target));
     }
-
     if (!listenerRef.current && targetRef.current) {
       listenerRef.current = function (event) {
         return listener && listener(event);
       };
-
       targetRef.current.addEventListener(type, listenerRef.current, options);
     }
   };
-
   var unbind = function unbind() {
     if (listenerRef.current) {
       targetRef.current.removeEventListener(type, listenerRef.current, options);
       listenerRef.current = null;
     }
   };
-
   React__namespace.useEffect(function () {
     if (when) {
       targetRef.current = utils.DomHandler.getTargetElement(target);
@@ -124,42 +117,40 @@ function _arrayWithHoles(arr) {
 }
 
 function _iterableToArrayLimit(arr, i) {
-  var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"];
-
-  if (_i == null) return;
-  var _arr = [];
-  var _n = true;
-  var _d = false;
-
-  var _s, _e;
-
-  try {
-    for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) {
-      _arr.push(_s.value);
-
-      if (i && _arr.length === i) break;
-    }
-  } catch (err) {
-    _d = true;
-    _e = err;
-  } finally {
+  var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"];
+  if (null != _i) {
+    var _s,
+      _e,
+      _x,
+      _r,
+      _arr = [],
+      _n = !0,
+      _d = !1;
     try {
-      if (!_n && _i["return"] != null) _i["return"]();
+      if (_x = (_i = _i.call(arr)).next, 0 === i) {
+        if (Object(_i) !== _i) return;
+        _n = !1;
+      } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0) {
+        ;
+      }
+    } catch (err) {
+      _d = !0, _e = err;
     } finally {
-      if (_d) throw _e;
+      try {
+        if (!_n && null != _i["return"] && (_r = _i["return"](), Object(_r) !== _r)) return;
+      } finally {
+        if (_d) throw _e;
+      }
     }
+    return _arr;
   }
-
-  return _arr;
 }
 
 function _arrayLikeToArray(arr, len) {
   if (len == null || len > arr.length) len = arr.length;
-
   for (var i = 0, arr2 = new Array(len); i < len; i++) {
     arr2[i] = arr[i];
   }
-
   return arr2;
 }
 
@@ -183,36 +174,30 @@ function _slicedToArray(arr, i) {
 /* eslint-disable */
 var useOverlayScrollListener = function useOverlayScrollListener(_ref) {
   var target = _ref.target,
-      listener = _ref.listener,
-      options = _ref.options,
-      _ref$when = _ref.when,
-      when = _ref$when === void 0 ? true : _ref$when;
+    listener = _ref.listener,
+    options = _ref.options,
+    _ref$when = _ref.when,
+    when = _ref$when === void 0 ? true : _ref$when;
   var targetRef = React__namespace.useRef(null);
   var listenerRef = React__namespace.useRef(null);
   var scrollableParents = React__namespace.useRef([]);
   var prevOptions = usePrevious(options);
-
   var bind = function bind() {
     var bindOptions = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-
     if (utils.ObjectUtils.isNotEmpty(bindOptions.target)) {
       unbind();
       (bindOptions.when || when) && (targetRef.current = utils.DomHandler.getTargetElement(bindOptions.target));
     }
-
     if (!listenerRef.current && targetRef.current) {
       var nodes = scrollableParents.current = utils.DomHandler.getScrollableParents(targetRef.current);
-
       listenerRef.current = function (event) {
         return listener && listener(event);
       };
-
       nodes.forEach(function (node) {
         return node.addEventListener('scroll', listenerRef.current, options);
       });
     }
   };
-
   var unbind = function unbind() {
     if (listenerRef.current) {
       var nodes = scrollableParents.current;
@@ -222,7 +207,6 @@ var useOverlayScrollListener = function useOverlayScrollListener(_ref) {
       listenerRef.current = null;
     }
   };
-
   React__namespace.useEffect(function () {
     if (when) {
       targetRef.current = utils.DomHandler.getTargetElement(target);
@@ -255,73 +239,67 @@ var useResizeListener = function useResizeListener(_ref) {
 
 var useOverlayListener = function useOverlayListener(_ref) {
   var target = _ref.target,
-      overlay = _ref.overlay,
-      _listener = _ref.listener,
-      _ref$when = _ref.when,
-      when = _ref$when === void 0 ? true : _ref$when;
+    overlay = _ref.overlay,
+    _listener = _ref.listener,
+    _ref$when = _ref.when,
+    when = _ref$when === void 0 ? true : _ref$when;
   var targetRef = React__namespace.useRef(null);
   var overlayRef = React__namespace.useRef(null);
+
   /**
    * The parameters of the 'listener' method in the following event handlers;
    * @param {Event} event A click event of the document.
    * @param {string} options.type The custom type to detect event.
    * @param {boolean} options.valid It is controlled by PrimeReact. It is determined whether it is valid or not according to some custom validation.
    */
-
   var _useEventListener = useEventListener({
-    type: 'click',
-    listener: function listener(event) {
-      _listener && _listener(event, {
-        type: 'outside',
-        valid: event.which !== 3 && isOutsideClicked(event)
-      });
-    }
-  }),
-      _useEventListener2 = _slicedToArray(_useEventListener, 2),
-      bindDocumentClickListener = _useEventListener2[0],
-      unbindDocumentClickListener = _useEventListener2[1];
-
+      type: 'click',
+      listener: function listener(event) {
+        _listener && _listener(event, {
+          type: 'outside',
+          valid: event.which !== 3 && isOutsideClicked(event)
+        });
+      }
+    }),
+    _useEventListener2 = _slicedToArray(_useEventListener, 2),
+    bindDocumentClickListener = _useEventListener2[0],
+    unbindDocumentClickListener = _useEventListener2[1];
   var _useResizeListener = useResizeListener({
-    listener: function listener(event) {
-      _listener && _listener(event, {
-        type: 'resize',
-        valid: !utils.DomHandler.isTouchDevice()
-      });
-    }
-  }),
-      _useResizeListener2 = _slicedToArray(_useResizeListener, 2),
-      bindWindowResizeListener = _useResizeListener2[0],
-      unbindWindowResizeListener = _useResizeListener2[1];
-
+      listener: function listener(event) {
+        _listener && _listener(event, {
+          type: 'resize',
+          valid: !utils.DomHandler.isTouchDevice()
+        });
+      }
+    }),
+    _useResizeListener2 = _slicedToArray(_useResizeListener, 2),
+    bindWindowResizeListener = _useResizeListener2[0],
+    unbindWindowResizeListener = _useResizeListener2[1];
   var _useOverlayScrollList = useOverlayScrollListener({
-    target: targetRef,
-    listener: function listener(event) {
-      _listener && _listener(event, {
-        type: 'scroll',
-        valid: true
-      });
-    }
-  }),
-      _useOverlayScrollList2 = _slicedToArray(_useOverlayScrollList, 2),
-      bindOverlayScrollListener = _useOverlayScrollList2[0],
-      unbindOverlayScrollListener = _useOverlayScrollList2[1];
-
+      target: target,
+      listener: function listener(event) {
+        _listener && _listener(event, {
+          type: 'scroll',
+          valid: true
+        });
+      }
+    }),
+    _useOverlayScrollList2 = _slicedToArray(_useOverlayScrollList, 2),
+    bindOverlayScrollListener = _useOverlayScrollList2[0],
+    unbindOverlayScrollListener = _useOverlayScrollList2[1];
   var isOutsideClicked = function isOutsideClicked(event) {
     return targetRef.current && !(targetRef.current.isSameNode(event.target) || targetRef.current.contains(event.target) || overlayRef.current && overlayRef.current.contains(event.target));
   };
-
   var bind = function bind() {
     bindDocumentClickListener();
     bindWindowResizeListener();
     bindOverlayScrollListener();
   };
-
   var unbind = function unbind() {
     unbindDocumentClickListener();
     unbindWindowResizeListener();
     unbindOverlayScrollListener();
   };
-
   React__namespace.useEffect(function () {
     if (when) {
       targetRef.current = utils.DomHandler.getTargetElement(target);
@@ -332,7 +310,7 @@ var useOverlayListener = function useOverlayListener(_ref) {
     }
   }, [target, overlay, when]);
   React__namespace.useEffect(function () {
-    unbind(); // when && bind();
+    unbind();
   }, [when]);
   useUnmountEffect(function () {
     unbind();
@@ -357,7 +335,6 @@ var useInterval = function useInterval(fn) {
     function callback() {
       savedCallback.current();
     }
-
     if (when) {
       timeout.current = setInterval(callback, delay);
       return clear;
@@ -380,52 +357,47 @@ var useInterval = function useInterval(fn) {
  * @param {string} storage either 'local' or 'session' for what type of storage
  * @returns a stateful value, and a function to update it.
  */
-
 var useStorage = function useStorage(initialValue, key) {
   var storage = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 'local';
   // Since the local storage API isn't available in server-rendering environments,
   // we check that typeof window !== 'undefined' to make SSR and SSG work properly.
-  var storageAvailable = typeof window !== 'undefined'; // subscribe to window storage event so changes in one tab to a stored value
-  // are properly reflected in all tabs
+  var storageAvailable = typeof window !== 'undefined';
 
+  // subscribe to window storage event so changes in one tab to a stored value
+  // are properly reflected in all tabs
   var _useEventListener = useEventListener({
-    target: 'window',
-    type: 'storage',
-    listener: function listener(event) {
-      var area = storage === 'local' ? window.localStorage : window.sessionStorage;
-
-      if (event.storageArea === area && event.key === key) {
-        setStoredValue(event.newValue || undefined);
+      target: 'window',
+      type: 'storage',
+      listener: function listener(event) {
+        var area = storage === 'local' ? window.localStorage : window.sessionStorage;
+        if (event.storageArea === area && event.key === key) {
+          setStoredValue(event.newValue || undefined);
+        }
       }
-    }
-  }),
-      _useEventListener2 = _slicedToArray(_useEventListener, 2),
-      bindWindowStorageListener = _useEventListener2[0],
-      unbindWindowStorageListener = _useEventListener2[1];
-
+    }),
+    _useEventListener2 = _slicedToArray(_useEventListener, 2),
+    bindWindowStorageListener = _useEventListener2[0],
+    unbindWindowStorageListener = _useEventListener2[1];
   var _React$useState = React__namespace.useState(function () {
-    if (!storageAvailable) {
-      return initialValue;
-    }
-
-    try {
-      var item = storage === 'local' ? window.localStorage.getItem(key) : window.sessionStorage.getItem(key);
-      return item ? JSON.parse(item) : initialValue;
-    } catch (error) {
-      // If error also return initialValue
-      return initialValue;
-    }
-  }),
-      _React$useState2 = _slicedToArray(_React$useState, 2),
-      storedValue = _React$useState2[0],
-      setStoredValue = _React$useState2[1];
-
+      if (!storageAvailable) {
+        return initialValue;
+      }
+      try {
+        var item = storage === 'local' ? window.localStorage.getItem(key) : window.sessionStorage.getItem(key);
+        return item ? JSON.parse(item) : initialValue;
+      } catch (error) {
+        // If error also return initialValue
+        return initialValue;
+      }
+    }),
+    _React$useState2 = _slicedToArray(_React$useState, 2),
+    storedValue = _React$useState2[0],
+    setStoredValue = _React$useState2[1];
   var setValue = function setValue(value) {
     try {
       // Allow value to be a function so we have same API as useState
       var valueToStore = value instanceof Function ? value(storedValue) : value;
       setStoredValue(valueToStore);
-
       if (storageAvailable) {
         var serializedValue = JSON.stringify(valueToStore);
         storage === 'local' ? window.localStorage.setItem(key, serializedValue) : window.sessionStorage.setItem(key, serializedValue);
@@ -434,7 +406,6 @@ var useStorage = function useStorage(initialValue, key) {
       throw new Error("PrimeReact useStorage: Failed to serialize the value at key: ".concat(key));
     }
   };
-
   React__namespace.useEffect(function () {
     bindWindowStorageListener();
     return function () {
@@ -443,6 +414,7 @@ var useStorage = function useStorage(initialValue, key) {
   }, []);
   return [storedValue, setValue];
 };
+
 /**
  * Hook to wrap around useState that stores the value in the browser local storage.
  *
@@ -450,10 +422,10 @@ var useStorage = function useStorage(initialValue, key) {
  * @param {string} key the key to store the value in local storage
  * @returns a stateful value, and a function to update it.
  */
-
 var useLocalStorage = function useLocalStorage(initialValue, key) {
   return useStorage(initialValue, key, 'local');
 };
+
 /**
  * Hook to wrap around useState that stores the value in the browser session storage.
  *
@@ -461,7 +433,6 @@ var useLocalStorage = function useLocalStorage(initialValue, key) {
  * @param {string} key the key to store the value in session storage
  * @returns a stateful value, and a function to update it.
  */
-
 var useSessionStorage = function useSessionStorage(initialValue, key) {
   return useStorage(initialValue, key, 'session');
 };
@@ -483,7 +454,6 @@ var useTimeout = function useTimeout(fn) {
     function callback() {
       savedCallback.current();
     }
-
     if (when) {
       timeout.current = setTimeout(callback, delay);
       return clear;

package/hooks/hooks.cjs.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("react"),t=require("primereact/utils");function r(e){if(e&&e.__esModule)return e;var t=Object.create(null);return e&&Object.keys(e).forEach((function(r){if("default"!==r){var n=Object.getOwnPropertyDescriptor(e,r);Object.defineProperty(t,r,n.get?n:{enumerable:!0,get:function(){return e[r]}})}})),t.default=e,Object.freeze(t)}var n=r(e),u=function(e){var t=n.useRef(void 0);return n.useEffect((function(){t.current=e})),t.current},o=function(e){return n.useEffect((function(){return e}),[])},c=function(e){var r=e.target,c=void 0===r?"document":r,i=e.type,l=e.listener,f=e.options,a=e.when,s=void 0===a||a,v=n.useRef(null),d=n.useRef(null),g=u(f),p=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{};t.ObjectUtils.isNotEmpty(e.target)&&(m(),(e.when||s)&&(v.current=t.DomHandler.getTargetElement(e.target))),!d.current&&v.current&&(d.current=function(e){return l&&l(e)},v.current.addEventListener(i,d.current,f))},m=function(){d.current&&(v.current.removeEventListener(i,d.current,f),d.current=null)};return n.useEffect((function(){s?v.current=t.DomHandler.getTargetElement(c):(m(),v.current=null)}),[c,s]),n.useEffect((function(){!d.current||d.current===l&&g===f||(m(),s&&p())}),[l,f]),o((function(){m()})),[p,m]};function i(e){if(Array.isArray(e))return e}function l(e,t){var r=null==e?null:"undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(null!=r){var n,u,o=[],c=!0,i=!1;try{for(r=r.call(e);!(c=(n=r.next()).done)&&(o.push(n.value),!t||o.length!==t);c=!0);}catch(e){i=!0,u=e}finally{try{c||null==r.return||r.return()}finally{if(i)throw u}}return o}}function f(e,t){(null==t||t>e.length)&&(t=e.length);for(var r=0,n=new Array(t);r<t;r++)n[r]=e[r];return n}function a(e,t){if(e){if("string"==typeof e)return f(e,t);var r=Object.prototype.toString.call(e).slice(8,-1);return"Object"===r&&e.constructor&&(r=e.constructor.name),"Map"===r||"Set"===r?Array.from(e):"Arguments"===r||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(r)?f(e,t):void 0}}function s(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}function v(e,t){return i(e)||l(e,t)||a(e,t)||s()}var d=function(e){var r=e.target,c=e.listener,i=e.options,l=e.when,f=void 0===l||l,a=n.useRef(null),s=n.useRef(null),v=n.useRef([]),d=u(i),g=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{};if(t.ObjectUtils.isNotEmpty(e.target)&&(p(),(e.when||f)&&(a.current=t.DomHandler.getTargetElement(e.target))),!s.current&&a.current){var r=v.current=t.DomHandler.getScrollableParents(a.current);s.current=function(e){return c&&c(e)},r.forEach((function(e){return e.addEventListener("scroll",s.current,i)}))}},p=function(){s.current&&(v.current.forEach((function(e){return e.removeEventListener("scroll",s.current,i)})),s.current=null)};return n.useEffect((function(){f?a.current=t.DomHandler.getTargetElement(r):(p(),a.current=null)}),[r,f]),n.useEffect((function(){!s.current||s.current===c&&d===i||(p(),f&&g())}),[c,i]),o((function(){p()})),[g,p]},g=function(e){return c({target:"window",type:"resize",listener:e.listener})},p=function(e,t){var r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:"local",u="undefined"!=typeof window,o=c({target:"window",type:"storage",listener:function(e){var n="local"===r?window.localStorage:window.sessionStorage;e.storageArea===n&&e.key===t&&g(e.newValue||void 0)}}),i=v(o,2),l=i[0],f=i[1],a=n.useState((function(){if(!u)return e;try{var n="local"===r?window.localStorage.getItem(t):window.sessionStorage.getItem(t);return n?JSON.parse(n):e}catch(t){return e}})),s=v(a,2),d=s[0],g=s[1],p=function(e){try{var n=e instanceof Function?e(d):e;if(g(n),u){var o=JSON.stringify(n);"local"===r?window.localStorage.setItem(t,o):window.sessionStorage.setItem(t,o)}}catch(e){throw new Error("PrimeReact useStorage: Failed to serialize the value at key: ".concat(t))}};return n.useEffect((function(){return l(),function(){return f()}}),[]),[d,p]};exports.useEventListener=c,exports.useInterval=function(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:0,r=!(arguments.length>2&&void 0!==arguments[2])||arguments[2],u=n.useRef(null),c=n.useRef(null),i=n.useCallback((function(){return clearInterval(u.current)}),[u.current]);return n.useEffect((function(){c.current=e})),n.useEffect((function(){if(r)return u.current=setInterval((function(){c.current()}),t),i;i()}),[t,r]),o((function(){i()})),[i]},exports.useLocalStorage=function(e,t){return p(e,t,"local")},exports.useMountEffect=function(e){return n.useEffect(e,[])},exports.useOverlayListener=function(e){var r=e.target,u=e.overlay,i=e.listener,l=e.when,f=void 0===l||l,a=n.useRef(null),s=n.useRef(null),p=v(c({type:"click",listener:function(e){i&&i(e,{type:"outside",valid:3!==e.which&&O(e)})}}),2),m=p[0],y=p[1],E=v(g({listener:function(e){i&&i(e,{type:"resize",valid:!t.DomHandler.isTouchDevice()})}}),2),w=E[0],h=E[1],S=v(d({target:a,listener:function(e){i&&i(e,{type:"scroll",valid:!0})}}),2),b=S[0],x=S[1],O=function(e){return a.current&&!(a.current.isSameNode(e.target)||a.current.contains(e.target)||s.current&&s.current.contains(e.target))},R=function(){y(),h(),x()};return n.useEffect((function(){f?(a.current=t.DomHandler.getTargetElement(r),s.current=t.DomHandler.getTargetElement(u)):(R(),a.current=s.current=null)}),[r,u,f]),n.useEffect((function(){R()}),[f]),o((function(){R()})),[function(){m(),w(),b()},R]},exports.useOverlayScrollListener=d,exports.usePrevious=u,exports.useResizeListener=g,exports.useSessionStorage=function(e,t){return p(e,t,"session")},exports.useStorage=p,exports.useTimeout=function(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:0,r=!(arguments.length>2&&void 0!==arguments[2])||arguments[2],u=n.useRef(null),c=n.useRef(null),i=n.useCallback((function(){return clearTimeout(u.current)}),[u.current]);return n.useEffect((function(){c.current=e})),n.useEffect((function(){if(r)return u.current=setTimeout((function(){c.current()}),t),i;i()}),[t,r]),o((function(){i()})),[i]},exports.useUnmountEffect=o,exports.useUpdateEffect=function(e,t){var r=n.useRef(!1);return n.useEffect((function(){if(r.current)return e&&e();r.current=!0}),t)};
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("react"),t=require("primereact/utils");function r(e){if(e&&e.__esModule)return e;var t=Object.create(null);return e&&Object.keys(e).forEach((function(r){if("default"!==r){var n=Object.getOwnPropertyDescriptor(e,r);Object.defineProperty(t,r,n.get?n:{enumerable:!0,get:function(){return e[r]}})}})),t.default=e,Object.freeze(t)}var n=r(e),u=function(e){var t=n.useRef(void 0);return n.useEffect((function(){t.current=e})),t.current},o=function(e){return n.useEffect((function(){return e}),[])},c=function(e){var r=e.target,c=void 0===r?"document":r,i=e.type,l=e.listener,f=e.options,a=e.when,s=void 0===a||a,v=n.useRef(null),d=n.useRef(null),g=u(f),p=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{};t.ObjectUtils.isNotEmpty(e.target)&&(m(),(e.when||s)&&(v.current=t.DomHandler.getTargetElement(e.target))),!d.current&&v.current&&(d.current=function(e){return l&&l(e)},v.current.addEventListener(i,d.current,f))},m=function(){d.current&&(v.current.removeEventListener(i,d.current,f),d.current=null)};return n.useEffect((function(){s?v.current=t.DomHandler.getTargetElement(c):(m(),v.current=null)}),[c,s]),n.useEffect((function(){!d.current||d.current===l&&g===f||(m(),s&&p())}),[l,f]),o((function(){m()})),[p,m]};function i(e){if(Array.isArray(e))return e}function l(e,t){var r=null==e?null:"undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(null!=r){var n,u,o,c,i=[],l=!0,f=!1;try{if(o=(r=r.call(e)).next,0===t){if(Object(r)!==r)return;l=!1}else for(;!(l=(n=o.call(r)).done)&&(i.push(n.value),i.length!==t);l=!0);}catch(e){f=!0,u=e}finally{try{if(!l&&null!=r.return&&(c=r.return(),Object(c)!==c))return}finally{if(f)throw u}}return i}}function f(e,t){(null==t||t>e.length)&&(t=e.length);for(var r=0,n=new Array(t);r<t;r++)n[r]=e[r];return n}function a(e,t){if(e){if("string"==typeof e)return f(e,t);var r=Object.prototype.toString.call(e).slice(8,-1);return"Object"===r&&e.constructor&&(r=e.constructor.name),"Map"===r||"Set"===r?Array.from(e):"Arguments"===r||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(r)?f(e,t):void 0}}function s(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}function v(e,t){return i(e)||l(e,t)||a(e,t)||s()}var d=function(e){var r=e.target,c=e.listener,i=e.options,l=e.when,f=void 0===l||l,a=n.useRef(null),s=n.useRef(null),v=n.useRef([]),d=u(i),g=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{};if(t.ObjectUtils.isNotEmpty(e.target)&&(p(),(e.when||f)&&(a.current=t.DomHandler.getTargetElement(e.target))),!s.current&&a.current){var r=v.current=t.DomHandler.getScrollableParents(a.current);s.current=function(e){return c&&c(e)},r.forEach((function(e){return e.addEventListener("scroll",s.current,i)}))}},p=function(){s.current&&(v.current.forEach((function(e){return e.removeEventListener("scroll",s.current,i)})),s.current=null)};return n.useEffect((function(){f?a.current=t.DomHandler.getTargetElement(r):(p(),a.current=null)}),[r,f]),n.useEffect((function(){!s.current||s.current===c&&d===i||(p(),f&&g())}),[c,i]),o((function(){p()})),[g,p]},g=function(e){return c({target:"window",type:"resize",listener:e.listener})},p=function(e,t){var r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:"local",u="undefined"!=typeof window,o=c({target:"window",type:"storage",listener:function(e){var n="local"===r?window.localStorage:window.sessionStorage;e.storageArea===n&&e.key===t&&g(e.newValue||void 0)}}),i=v(o,2),l=i[0],f=i[1],a=n.useState((function(){if(!u)return e;try{var n="local"===r?window.localStorage.getItem(t):window.sessionStorage.getItem(t);return n?JSON.parse(n):e}catch(t){return e}})),s=v(a,2),d=s[0],g=s[1],p=function(e){try{var n=e instanceof Function?e(d):e;if(g(n),u){var o=JSON.stringify(n);"local"===r?window.localStorage.setItem(t,o):window.sessionStorage.setItem(t,o)}}catch(e){throw new Error("PrimeReact useStorage: Failed to serialize the value at key: ".concat(t))}};return n.useEffect((function(){return l(),function(){return f()}}),[]),[d,p]};exports.useEventListener=c,exports.useInterval=function(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:0,r=!(arguments.length>2&&void 0!==arguments[2])||arguments[2],u=n.useRef(null),c=n.useRef(null),i=n.useCallback((function(){return clearInterval(u.current)}),[u.current]);return n.useEffect((function(){c.current=e})),n.useEffect((function(){if(r)return u.current=setInterval((function(){c.current()}),t),i;i()}),[t,r]),o((function(){i()})),[i]},exports.useLocalStorage=function(e,t){return p(e,t,"local")},exports.useMountEffect=function(e){return n.useEffect(e,[])},exports.useOverlayListener=function(e){var r=e.target,u=e.overlay,i=e.listener,l=e.when,f=void 0===l||l,a=n.useRef(null),s=n.useRef(null),p=v(c({type:"click",listener:function(e){i&&i(e,{type:"outside",valid:3!==e.which&&x(e)})}}),2),m=p[0],y=p[1],E=v(g({listener:function(e){i&&i(e,{type:"resize",valid:!t.DomHandler.isTouchDevice()})}}),2),w=E[0],h=E[1],b=v(d({target:r,listener:function(e){i&&i(e,{type:"scroll",valid:!0})}}),2),S=b[0],O=b[1],x=function(e){return a.current&&!(a.current.isSameNode(e.target)||a.current.contains(e.target)||s.current&&s.current.contains(e.target))},R=function(){y(),h(),O()};return n.useEffect((function(){f?(a.current=t.DomHandler.getTargetElement(r),s.current=t.DomHandler.getTargetElement(u)):(R(),a.current=s.current=null)}),[r,u,f]),n.useEffect((function(){R()}),[f]),o((function(){R()})),[function(){m(),w(),S()},R]},exports.useOverlayScrollListener=d,exports.usePrevious=u,exports.useResizeListener=g,exports.useSessionStorage=function(e,t){return p(e,t,"session")},exports.useStorage=p,exports.useTimeout=function(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:0,r=!(arguments.length>2&&void 0!==arguments[2])||arguments[2],u=n.useRef(null),c=n.useRef(null),i=n.useCallback((function(){return clearTimeout(u.current)}),[u.current]);return n.useEffect((function(){c.current=e})),n.useEffect((function(){if(r)return u.current=setTimeout((function(){c.current()}),t),i;i()}),[t,r]),o((function(){i()})),[i]},exports.useUnmountEffect=o,exports.useUpdateEffect=function(e,t){var r=n.useRef(!1);return n.useEffect((function(){if(r.current)return e&&e();r.current=!0}),t)};

package/hooks/hooks.d.ts

@@ -1,37 +1,144 @@
+/**
+ *
+ * The module includes custom hook methods to create shorthands for users.
+ *
+ * @module hooks
+ *
+ */
 import * as React from 'react';
 
-export type TargetType = 'document' | 'window' | React.Ref<HTMLElement> | undefined;
-export type StorageType = 'local' | 'session';
-
+/**
+ * Custom event options.
+ * @group Misc
+ */
 interface EventOptions {
-    target?: TargetType;
+    /**
+     * The target element to listen to.
+     */
+    target?: 'document' | 'window' | React.Ref<HTMLElement>;
+    /**
+     * The event type to listen to.
+     */
     type?: string;
+    /**
+     * The event listener.
+     */
     listener?(event: Event): void;
+    /**
+     * The event options.
+     */
     options?: any;
+    /**
+     * Whether to listen to the event or not.
+     */
     when?: boolean;
 }
 
+/**
+ * Custom overlay event options.
+ * @group Misc
+ */
 interface OverlayEventOptions {
-    target?: TargetType;
-    overlay?: TargetType;
+    /**
+     * The target element to listen to.
+     */
+    target?: 'document' | 'window' | React.Ref<HTMLElement> | undefined;
+    /**
+     * The overlay element to listen to.
+     */
+    overlay?: 'document' | 'window' | React.Ref<HTMLElement> | undefined;
+    /**
+     * The event listener.
+     */
     listener?(event: Event, type?: string): void;
+    /**
+     * Whether to listen to the event or not.
+     */
     when?: boolean;
 }
 
+/**
+ * Custom resize event options.
+ * @group Misc
+ */
 interface ResizeEventOptions {
+    /**
+     * The event listener.
+     * @param {Event} event - The browser event object.
+     */
     listener?(event: Event): void;
 }
 
+/**
+ * Custom hook to get the previous value of a property.
+ * @param {*} value - The value to compare.
+ */
 export declare function usePrevious(value: any): any;
+/**
+ * Custom hook to run a mount effect only once.
+ * @param {React.EffectCallback} effect - The effect to run.
+ */
 export declare function useMountEffect(effect: React.EffectCallback): void;
+/**
+ * Custom hook to run an update effect.
+ * @param {React.EffectCallback} effect - The effect to run.
+ * @param {React.DependencyList} deps - The dependencies.
+ */
 export declare function useUpdateEffect(effect: React.EffectCallback, deps?: React.DependencyList): void;
+/**
+ * Custom hook to run an unmount effect.
+ * @param {React.EffectCallback} effect - The effect to run.
+ */
 export declare function useUnmountEffect(effect: React.EffectCallback): void;
+/**
+ * Custom hook to listen to an event.
+ * @param {EventOptions} options - The event options.
+ */
 export declare function useEventListener(options: EventOptions): any[];
+/**
+ * Custom hook to listen to overlay event. It can be used when an overlay is desired to behave like the overlays in PrimeReact.
+ * @param {OverlayEventOptions} options - The event options.
+ */
 export declare function useOverlayListener(options: OverlayEventOptions): any[];
+/**
+ * Custom hook to listen to overlay scroll. It can be used when an overlay is desired to behave like the overlays in PrimeReact.
+ * @param {EventOptions} options - The event options.
+ */
 export declare function useOverlayScrollListener(options: EventOptions): any[];
+/**
+ * Custom hook to listen to a resize event.
+ * @param {ResizeEventOptions} options - The event options.
+ */
 export declare function useResizeListener(options: ResizeEventOptions): any[];
+/**
+ * Custom hook to use an interval.
+ * @param {*} fn - The function that will be executed after the delay.
+ * @param {number} delay - Delay in milliseconds.
+ * @param {boolean} when - Whether to listen to the event or not.
+ */
 export declare function useInterval(fn: any, delay?: number, when?: boolean): any[];
+/**
+ * Custom hook to use a timeout.
+ * @param {*} fn - The function that will be executed after the delay.
+ * @param {number} delay - Delay in milliseconds.
+ * @param {boolean} when - Whether to listen to the event or not.
+ */
 export declare function useTimeout(fn: any, delay?: number, when?: boolean): any[];
-export declare function useStorage<S, K extends string = string>(initialValue: S, key: K, storage?: StorageType): [S, React.Dispatch<React.SetStateAction<S>>];
+/**
+ * Custom hook to use storage such as local and session storage.
+ * @param {*} initialValue - The initial value.
+ * @param {string} key - The key to store the value.
+ * @param {string} storage - The storage type. Valid values are 'local' and 'session'.
+ */
+export declare function useStorage<S, K extends string = string>(initialValue: S, key: K, storage?: 'local' | 'session'): [S, React.Dispatch<React.SetStateAction<S>>];
+/**
+ * Custom hook to use local storage.
+ * @param {*} initialValue - The initial value.
+ * @param {string} key - The key to store the value in local storage.
+ */
 export declare function useLocalStorage<S, K extends string = string>(initialValue: S, key: K): [S, React.Dispatch<React.SetStateAction<S>>];
+/**
+ * Custom hook to use session storage.
+ * @param {*} initialValue - The initial value.
+ * @param {string} key - The key to store the value in session storage. */
 export declare function useSessionStorage<S, K extends string = string>(initialValue: S, key: K): [S, React.Dispatch<React.SetStateAction<S>>];