primereact 8.7.3 → 9.0.0-rc.1

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,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:a,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)};
+"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);function u(e){if(Array.isArray(e))return e}function o(e,t){var r=null==e?null:"undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(null!=r){var n,u,o,c,i=[],f=!0,a=!1;try{if(o=(r=r.call(e)).next,0===t){if(Object(r)!==r)return;f=!1}else for(;!(f=(n=o.call(r)).done)&&(i.push(n.value),i.length!==t);f=!0);}catch(e){a=!0,u=e}finally{try{if(!f&&null!=r.return&&(c=r.return(),Object(c)!==c))return}finally{if(a)throw u}}return i}}function c(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 i(e,t){if(e){if("string"==typeof e)return c(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)?c(e,t):void 0}}function f(){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 a(e,t){return u(e)||o(e,t)||i(e,t)||f()}var l=function(e){var t=n.useRef(void 0);return n.useEffect((function(){t.current=e})),t.current},s=function(e){return n.useEffect((function(){return e}),[])},p=function(e){var r=e.target,u=void 0===r?"document":r,o=e.type,c=e.listener,i=e.options,f=e.when,a=void 0===f||f,p=n.useRef(null),v=n.useRef(null),d=l(i),g=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{};t.ObjectUtils.isNotEmpty(e.target)&&(m(),(e.when||a)&&(p.current=t.DomHandler.getTargetElement(e.target))),!v.current&&p.current&&(v.current=function(e){return c&&c(e)},p.current.addEventListener(o,v.current,i))},m=function(){v.current&&(p.current.removeEventListener(o,v.current,i),v.current=null)};return n.useEffect((function(){a?p.current=t.DomHandler.getTargetElement(u):(m(),p.current=null)}),[u,a]),n.useEffect((function(){!v.current||v.current===c&&d===i||(m(),a&&g())}),[c,i]),s((function(){m()})),[g,m]},v=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),o=n.useRef(null),c=n.useCallback((function(){return clearTimeout(u.current)}),[u.current]);return n.useEffect((function(){o.current=e})),n.useEffect((function(){if(r)return u.current=setTimeout((function(){o.current()}),t),c;c()}),[t,r]),s((function(){c()})),[c]},d={ico:"image/x-icon",png:"image/png",svg:"image/svg+xml",gif:"image/gif"};function g(e){return g="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},g(e)}function m(e,t){if("object"!==g(e)||null===e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var n=r.call(e,t||"default");if("object"!==g(n))return n;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}function y(e){var t=m(e,"string");return"symbol"===g(t)?t:String(t)}function b(e,t,r){return(t=y(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function h(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function w(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?h(Object(r),!0).forEach((function(t){b(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):h(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function O(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function E(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?O(Object(r),!0).forEach((function(t){b(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):O(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}var S=function(e){var r=e.target,u=e.listener,o=e.options,c=e.when,i=void 0===c||c,f=n.useRef(null),a=n.useRef(null),p=n.useRef([]),v=l(o),d=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{};if(t.ObjectUtils.isNotEmpty(e.target)&&(g(),(e.when||i)&&(f.current=t.DomHandler.getTargetElement(e.target))),!a.current&&f.current){var r=p.current=t.DomHandler.getScrollableParents(f.current);a.current=function(e){return u&&u(e)},r.forEach((function(e){return e.addEventListener("scroll",a.current,o)}))}},g=function(){a.current&&(p.current.forEach((function(e){return e.removeEventListener("scroll",a.current,o)})),a.current=null)};return n.useEffect((function(){i?f.current=t.DomHandler.getTargetElement(r):(g(),f.current=null)}),[r,i]),n.useEffect((function(){!a.current||a.current===u&&v===o||(g(),i&&d())}),[u,o]),s((function(){g()})),[d,g]},x=function(e){return p({target:"window",type:"resize",listener:e.listener})},j=function(e,t){var r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:"local",u="undefined"!=typeof window,o=p({target:"window",type:"storage",listener:function(e){var n="local"===r?window.localStorage:window.sessionStorage;e.storageArea===n&&e.key===t&&d(e.newValue||void 0)}}),c=a(o,2),i=c[0],f=c[1],l=n.useState(void 0),s=a(l,2),v=s[0],d=s[1],g=function(e){try{var n=e instanceof Function?e(v):e;if(d(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(){u||d(e);try{var n="local"===r?window.localStorage.getItem(t):window.sessionStorage.getItem(t);d(n?JSON.parse(n):e)}catch(t){d(e)}return i(),function(){return f()}}),[]),[v,g]};exports.useClickOutside=function(e,t){var r=function(r){e.current&&!e.current.contains(r.target)&&t(r)},u=a(p({type:"mousedown",listener:r}),2),o=u[0],c=u[1],i=a(p({type:"touchstart",listener:r}),2),f=i[0],l=i[1];return n.useEffect((function(){if(e.current)return o(),f(),function(){c(),l()}})),[e,t]},exports.useCounter=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:0,t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{step:1},r=n.useState(e),u=a(r,2),o=u[0],c=u[1],i=function(){t.max&&o>=t.max||c(o+t.step)},f=function(){if(t.min||0===t.min&&o<=t.min)return null;c(o-t.step)},l=function(){c(0)};return{count:o,increment:i,decrement:f,reset:l}},exports.useDebounce=function(e,t){var r=a(n.useState(e),2),u=r[0],o=r[1],c=a(n.useState(e),2),i=c[0],f=c[1];return v((function(){f(u)}),t,u!==i),[u,i,o]},exports.useEventListener=p,exports.useFavicon=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:"",t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:"shortcut icon";n.useLayoutEffect((function(){if(e){document.querySelectorAll("link[rel*='icon']").forEach((function(e){document.head.removeChild(e)}));var r=document.createElement("link");r.setAttribute("type",d[e.split(".").pop()]),r.setAttribute("rel",t),r.setAttribute("href",e),document.head.appendChild(r)}}),[e,t])},exports.useIntersectionObserver=function(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},r=n.useState(!1),u=a(r,2),o=u[0],c=u[1];return n.useEffect((function(){if(e.current){var r=new IntersectionObserver((function(e){var t=a(e,1);c(t[0].isIntersecting)}),t);return r.observe(e.current),function(){r.disconnect()}}}),[t,e]),o},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),o=n.useRef(null),c=n.useCallback((function(){return clearInterval(u.current)}),[u.current]);return n.useEffect((function(){o.current=e})),n.useEffect((function(){if(r)return u.current=setInterval((function(){o.current()}),t),c;c()}),[t,r]),s((function(){c()})),[c]},exports.useLocalStorage=function(e,t){return j(e,t,"local")},exports.useMountEffect=function(e){return n.useEffect(e,[])},exports.useMouse=function(){var e=a(n.useState({x:0,y:0}),2),t=e[0],r=e[1],u=n.useRef(null),o=n.useCallback((function(e){var t,n;if(u.current){var o=e.currentTarget.getBoundingClientRect();t=e.pageX-o.left-(window.pageXOffset||window.scrollX),n=e.pageY-o.top-(window.pageYOffset||window.scrollY)}else t=e.clientX,n=e.clientY;r({x:Math.max(0,Math.round(t)),y:Math.max(0,Math.round(n))})}),[]),c=a(p({target:u,type:"mousemove",listener:o}),2),i=c[0],f=c[1],l=a(p({type:"mousemove",listener:o}),2),s=l[0],v=l[1];return n.useEffect((function(){return i(),u.current||s(),function(){f(),u.current||v()}}),[s,i,v,f]),w(w({ref:u},t),{},{reset:function(){return r({x:0,y:0})}})},exports.useMove=function(e){var t=e.mode,r=void 0===t?"both":t,u=e.initialValue,o=void 0===u?{x:0,y:0}:u,c=a(n.useState(o),2),i=c[0],f=c[1],l=a(n.useState(!1),2),s=l[0],v=l[1],d=n.useRef(!1),g=n.useRef(!1),m=n.useRef(null),y=function(e){return F({x:e.clientX,y:e.clientY})},b=function(e){var t=e.clampedX,n=e.clampedY;"vertical"===r?f({y:1-n}):"horizontal"===r?f({x:t}):"both"===r&&f({x:t,y:n})},h=function(){g.current&&d.current&&(g.current=!1,v(!1),_())},w=function(e){e.cancelable&&e.preventDefault(),F({x:e.changedTouches[0].clientX,y:e.changedTouches[0].clientY})},O=a(p({type:"mousemove",listener:y}),2),S=O[0],x=O[1],j=a(p({type:"mouseup",listener:h}),2),P=j[0],D=j[1],R=a(p({type:"touchmove",listener:w}),2),T=R[0],I=R[1],k=a(p({type:"touchend",listener:h}),2),M=k[0],A=k[1],C=a(p({target:m,type:"mousedown",listener:function(e){q(),e.preventDefault(),y(e)}}),2),L=C[0],X=C[1],Y=a(p({target:m,type:"touchstart",listener:function(e){e.cancelable&&e.preventDefault(),q(),w(e)},options:{passive:!1}}),2),H=Y[0],z=Y[1],N=function(e,t,r){return Math.min(Math.max(e,t),r)},U=function(e){var t=e.y;return{clampedX:N(e.x,0,1),clampedY:N(t,0,1)}},_=function(){x(),D(),I(),A()};n.useEffect((function(){d.current=!0}),[]);var q=function(){!g.current&&d.current&&(g.current=!0,v(!0),S(),P(),T(),M())},F=function(e){var t=e.x,r=e.y;if(g.current){var n=m.current.getBoundingClientRect(),u=U({x:(t-n.left)/n.width,y:(r-n.top)/n.height});b({clampedX:u.clampedX,clampedY:u.clampedY})}};return n.useEffect((function(){return m.current&&(L(),H()),function(){m.current&&(X(),z())}}),[L,H,i,X,z]),E(E({ref:m},i),{},{active:s,reset:function(){f(o)}})},exports.useOverlayListener=function(e){var r=e.target,u=e.overlay,o=e.listener,c=e.when,i=void 0===c||c,f=n.useRef(null),l=n.useRef(null),v=a(p({type:"click",listener:function(e){o&&o(e,{type:"outside",valid:3!==e.which&&E(e)})}}),2),d=v[0],g=v[1],m=a(x({listener:function(e){o&&o(e,{type:"resize",valid:!t.DomHandler.isTouchDevice()})}}),2),y=m[0],b=m[1],h=a(S({target:r,listener:function(e){o&&o(e,{type:"scroll",valid:!0})}}),2),w=h[0],O=h[1],E=function(e){return f.current&&!(f.current.isSameNode(e.target)||f.current.contains(e.target)||l.current&&l.current.contains(e.target))},j=function(){g(),b(),O()};return n.useEffect((function(){i?(f.current=t.DomHandler.getTargetElement(r),l.current=t.DomHandler.getTargetElement(u)):(j(),f.current=l.current=null)}),[r,u,i]),n.useEffect((function(){j()}),[i]),s((function(){j()})),[function(){d(),y(),w()},j]},exports.useOverlayScrollListener=S,exports.usePrevious=l,exports.useResizeListener=x,exports.useSessionStorage=function(e,t){return j(e,t,"session")},exports.useStorage=j,exports.useTimeout=v,exports.useUnmountEffect=s,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,225 @@
+/**
+ *
+ * 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 MousePositionOptions
+ * @group Misc
+ */
+interface MousePositionOptions {
+    /**
+     * Position of the mouse for the x-axis.
+     */
+    x: number;
+    /**
+     * Position of the mouse for the y-axis.
+     */
+    y: number;
+}
+
+/**
+ * Custom MouseDataOptions
+ * @group Misc
+ */
+declare interface MouseDataOptions extends MousePositionOptions {
+    /**
+     * Used to reset the mouse position data.
+     */
+    reset: () => void;
+    /**
+     * The ref of the element to position.
+     */
+    ref: React.RefObject<HTMLElement>;
+}
+
+/**
+ * Custom MouseMoveOptions
+ * @group Misc
+ */
+declare interface MouseMoveOptions extends MouseDataOptions {
+    /**
+     * Whether the mouse is touching the element or not.
+     */
+    active: boolean;
+}
 
+/**
+ * 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>>];
+/**
+ * @todo
+ * @param {number} initialValue - The value to counter. @defaultValue 0
+ * @param {{ min: number; max: number; step: number }} options - The options of the counter. @defaultValue &#123; step: 1 &#125;
+ */
+export declare function useCounter(initialValue: number, options: { min: number; max: number; step: number }): any;
+/**
+ * Custom hook to use a debounced value.
+ * @param {*} initialValue - The initial value for debounce.
+ * @param {number} delay - The delay in milliseconds.
+ */
+export declare function useDebounce(initialValue: any, delay: number): any[];
+/**
+ * Custom hook to use to get the current mouse position.
+ */
+export declare function useMouse(): MouseDataOptions;
+/**
+ * Custom hook to handles move behavior over any element.
+ * @param {'horizontal' | 'vertical' | 'both'} mode - The mode of the move. Valid values are 'horizontal', 'vertical' and 'both'.
+ * @param {MousePositionOptions} initialValue - The initial value.
+ */
+export declare function useMove(mode: 'horizontal' | 'vertical' | 'both', initialValue: MousePositionOptions): MouseMoveOptions;
+/**
+ * Custom hook to use change the current favicon.
+ * @param {string} newIcon - The new favicon url to set.
+ * @param {string} rel - The rel attribute of the link element. @defaultValue 'shortcut icon'
+ */
+export declare function useFavicon(newIcon: string, rel: string): void;
+/**
+ * Custom hook to use change the current favicon.
+ * @param {React.RefObject<Element>} ref - The ref of the element to observe.
+ * @param {IntersectionObserver} options - The options of the intersection observer.
+ */
+export declare function useIntersectionObserver(ref: React.RefObject<Element>, options: IntersectionObserver): void;
+/**
+ * Custom hook to use detect click outside.
+ * @param {React.RefObject<Element>} ref - The ref of the element to detect click outside.
+ * @param {*} callback - The callback to run when click outside.
+ */
+export declare function useClickOutside(ref: React.RefObject<Element>, callback: any): void;