primereact 8.7.3 → 9.0.0-beta.1

package/gmap/gmap.d.ts

@@ -1,26 +1,112 @@
+/**
+ *
+ * GMap component provides integration with Google Maps API. This sample demontrates various uses cases like binding, overlays and events. Click the map to add a new item.
+ *
+ * [Live Demo](https://www.primefaces.org/primereact/gmap/)
+ *
+ * @module gmap
+ *
+ */
 import * as React from 'react';
 
-interface GMapEventParams {
+/**
+ * Custom click event.
+ * @see {@link GMapProps.onOverlayClick}
+ * @event
+ */
+interface GMapEvent {
+    /**
+     * Google Maps mouse event
+     */
     originalEvent: React.SyntheticEvent;
+    /**
+     * Clicked overlay
+     */
     overlay: any;
+    /**
+     * Map instance
+     */
     map: any;
 }
 
+/**
+ * Defines valid properties in GMap component. In addition to these, all properties of HTMLDivElement can be used in this component.
+ * @group Properties
+ */
 export interface GMapProps extends Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, 'ref'> {
-    options?: object;
-    overlays?: any[];
+    /**
+     * Google Maps API configuration object.
+     */
+    options?: object | undefined;
+    /**
+     * An array of overlays to display.
+     */
+    overlays?: any[] | undefined;
+    /**
+     * Callback to invoke when the map is ready to be used.
+     * @param {*} map - Google Maps instance
+     */
     onMapReady?(map: any): void;
+    /**
+     * Callback to invoke when map is clicked except markers.
+     * @param {React.SyntheticEvent} event - Mouse event.
+     */
     onMapClick?(event: React.SyntheticEvent): void;
+    /**
+     * Callback to invoke when the map is ready to be used.
+     */
     onMapDragEnd?(): void;
+    /**
+     * Callback to invoke when zoom level has changed.
+     */
     onZoomChanged?(): void;
+    /**
+     * Callback to invoke when an overlay drag starts.
+     * @param {React.SyntheticEvent} event - Google Maps mouse event.
+     */
     onOverlayDragStart?(event: React.SyntheticEvent): void;
+    /**
+     * Callback to invoke when an overlay is being dragged.
+     * @param {React.SyntheticEvent} event - Google Maps mouse event.
+     */
     onOverlayDrag?(event: React.SyntheticEvent): void;
+    /**
+     * Callback to invoke when an overlay drag ends.
+     * @param {React.SyntheticEvent} event - Google Maps mouse event.
+     */
     onOverlayDragEnd?(event: React.SyntheticEvent): void;
-    onOverlayClick?(e: GMapEventParams): void;
-    children?: React.ReactNode;
+    /**
+     * Callback to invoke when an overlay is clicked.
+     * @param {GMapEvent} event - Custom click event.
+     */
+    onOverlayClick?(event: GMapEvent): void;
+    /**
+     * Used to get the child elements of the component.
+     * @readonly
+     */
+    children?: React.ReactNode | undefined;
 }
 
+/**
+ * **PrimeReact - GMap**
+ *
+ * _GMap component provides integration with Google Maps API. This sample demontrates various uses cases like binding, overlays and events. Click the map to add a new item._
+ *
+ * [Live Demo](https://www.primefaces.org/primereact/gmap/)
+ * --- ---
+ * ![PrimeReact](https://www.primefaces.org/primereact/images/logo-100.png)
+ *
+ * @group Component
+ */
 export declare class GMap extends React.Component<GMapProps, any> {
+    /**
+     * Used to get map instance
+     * @return {*} Map instance
+     */
     public getMap(): any;
+    /**
+     * Used to get container element.
+     * @return {HTMLDivElement} Container element
+     */
     public getElement(): HTMLDivElement;
 }

package/hooks/hooks.cjs.js

@@ -276,7 +276,7 @@ var useOverlayListener = function useOverlayListener(_ref) {
     bindWindowResizeListener = _useResizeListener2[0],
     unbindWindowResizeListener = _useResizeListener2[1];
   var _useOverlayScrollList = useOverlayScrollListener({
-      target: targetRef,
+      target: target,
       listener: function listener(event) {
         _listener && _listener(event, {
           type: 'scroll',
@@ -311,7 +311,6 @@ var useOverlayListener = function useOverlayListener(_ref) {
   }, [target, overlay, when]);
   React__namespace.useEffect(function () {
     unbind();
-    // when && bind();
   }, [when]);
   useUnmountEffect(function () {
     unbind();

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),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>>];

package/hooks/hooks.esm.js

@@ -252,7 +252,7 @@ var useOverlayListener = function useOverlayListener(_ref) {
     bindWindowResizeListener = _useResizeListener2[0],
     unbindWindowResizeListener = _useResizeListener2[1];
   var _useOverlayScrollList = useOverlayScrollListener({
-      target: targetRef,
+      target: target,
       listener: function listener(event) {
         _listener && _listener(event, {
           type: 'scroll',
@@ -287,7 +287,6 @@ var useOverlayListener = function useOverlayListener(_ref) {
   }, [target, overlay, when]);
   React.useEffect(function () {
     unbind();
-    // when && bind();
   }, [when]);
   useUnmountEffect(function () {
     unbind();

package/hooks/hooks.esm.min.js

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

package/hooks/hooks.js

@@ -273,7 +273,7 @@ this.primereact.hooks = (function (exports, React, utils) {
         bindWindowResizeListener = _useResizeListener2[0],
         unbindWindowResizeListener = _useResizeListener2[1];
       var _useOverlayScrollList = useOverlayScrollListener({
-          target: targetRef,
+          target: target,
           listener: function listener(event) {
             _listener && _listener(event, {
               type: 'scroll',
@@ -308,7 +308,6 @@ this.primereact.hooks = (function (exports, React, utils) {
       }, [target, overlay, when]);
       React__namespace.useEffect(function () {
         unbind();
-        // when && bind();
       }, [when]);
       useUnmountEffect(function () {
         unbind();

package/hooks/hooks.min.js

@@ -1 +1 @@
-this.primereact=this.primereact||{},this.primereact.hooks=function(e,t,r){"use strict";function n(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 u=n(t),c=function(e){var t=u.useRef(void 0);return u.useEffect((function(){t.current=e})),t.current},o=function(e){return u.useEffect((function(){return e}),[])},i=function(e){var t=e.target,n=void 0===t?"document":t,i=e.type,l=e.listener,f=e.options,a=e.when,s=void 0===a||a,v=u.useRef(null),d=u.useRef(null),g=c(f),m=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{};r.ObjectUtils.isNotEmpty(e.target)&&(y(),(e.when||s)&&(v.current=r.DomHandler.getTargetElement(e.target))),!d.current&&v.current&&(d.current=function(e){return l&&l(e)},v.current.addEventListener(i,d.current,f))},y=function(){d.current&&(v.current.removeEventListener(i,d.current,f),d.current=null)};return u.useEffect((function(){s?v.current=r.DomHandler.getTargetElement(n):(y(),v.current=null)}),[n,s]),u.useEffect((function(){!d.current||d.current===l&&g===f||(y(),s&&m())}),[l,f]),o((function(){y()})),[m,y]};function l(e){if(Array.isArray(e))return e}function f(e,t){var r=null==e?null:"undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(null!=r){var n,u,c,o,i=[],l=!0,f=!1;try{if(c=(r=r.call(e)).next,0===t){if(Object(r)!==r)return;l=!1}else for(;!(l=(n=c.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&&(o=r.return(),Object(o)!==o))return}finally{if(f)throw u}}return i}}function a(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 s(e,t){if(e){if("string"==typeof e)return a(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)?a(e,t):void 0}}function v(){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 d(e,t){return l(e)||f(e,t)||s(e,t)||v()}var g=function(e){var t=e.target,n=e.listener,i=e.options,l=e.when,f=void 0===l||l,a=u.useRef(null),s=u.useRef(null),v=u.useRef([]),d=c(i),g=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{};if(r.ObjectUtils.isNotEmpty(e.target)&&(m(),(e.when||f)&&(a.current=r.DomHandler.getTargetElement(e.target))),!s.current&&a.current){var t=v.current=r.DomHandler.getScrollableParents(a.current);s.current=function(e){return n&&n(e)},t.forEach((function(e){return e.addEventListener("scroll",s.current,i)}))}},m=function(){s.current&&(v.current.forEach((function(e){return e.removeEventListener("scroll",s.current,i)})),s.current=null)};return u.useEffect((function(){f?a.current=r.DomHandler.getTargetElement(t):(m(),a.current=null)}),[t,f]),u.useEffect((function(){!s.current||s.current===n&&d===i||(m(),f&&g())}),[n,i]),o((function(){m()})),[g,m]},m=function(e){return i({target:"window",type:"resize",listener:e.listener})},y=function(e,t){var r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:"local",n="undefined"!=typeof window,c=i({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)}}),o=d(c,2),l=o[0],f=o[1],a=u.useState((function(){if(!n)return e;try{var u="local"===r?window.localStorage.getItem(t):window.sessionStorage.getItem(t);return u?JSON.parse(u):e}catch(t){return e}})),s=d(a,2),v=s[0],g=s[1],m=function(e){try{var u=e instanceof Function?e(v):e;if(g(u),n){var c=JSON.stringify(u);"local"===r?window.localStorage.setItem(t,c):window.sessionStorage.setItem(t,c)}}catch(e){throw new Error("PrimeReact useStorage: Failed to serialize the value at key: ".concat(t))}};return u.useEffect((function(){return l(),function(){return f()}}),[]),[v,m]};return e.useEventListener=i,e.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],n=u.useRef(null),c=u.useRef(null),i=u.useCallback((function(){return clearInterval(n.current)}),[n.current]);return u.useEffect((function(){c.current=e})),u.useEffect((function(){if(r)return n.current=setInterval((function(){c.current()}),t),i;i()}),[t,r]),o((function(){i()})),[i]},e.useLocalStorage=function(e,t){return y(e,t,"local")},e.useMountEffect=function(e){return u.useEffect(e,[])},e.useOverlayListener=function(e){var t=e.target,n=e.overlay,c=e.listener,l=e.when,f=void 0===l||l,a=u.useRef(null),s=u.useRef(null),v=d(i({type:"click",listener:function(e){c&&c(e,{type:"outside",valid:3!==e.which&&R(e)})}}),2),y=v[0],E=v[1],h=d(m({listener:function(e){c&&c(e,{type:"resize",valid:!r.DomHandler.isTouchDevice()})}}),2),w=h[0],p=h[1],b=d(g({target:a,listener:function(e){c&&c(e,{type:"scroll",valid:!0})}}),2),S=b[0],O=b[1],R=function(e){return a.current&&!(a.current.isSameNode(e.target)||a.current.contains(e.target)||s.current&&s.current.contains(e.target))},j=function(){E(),p(),O()};return u.useEffect((function(){f?(a.current=r.DomHandler.getTargetElement(t),s.current=r.DomHandler.getTargetElement(n)):(j(),a.current=s.current=null)}),[t,n,f]),u.useEffect((function(){j()}),[f]),o((function(){j()})),[function(){y(),w(),S()},j]},e.useOverlayScrollListener=g,e.usePrevious=c,e.useResizeListener=m,e.useSessionStorage=function(e,t){return y(e,t,"session")},e.useStorage=y,e.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],n=u.useRef(null),c=u.useRef(null),i=u.useCallback((function(){return clearTimeout(n.current)}),[n.current]);return u.useEffect((function(){c.current=e})),u.useEffect((function(){if(r)return n.current=setTimeout((function(){c.current()}),t),i;i()}),[t,r]),o((function(){i()})),[i]},e.useUnmountEffect=o,e.useUpdateEffect=function(e,t){var r=u.useRef(!1);return u.useEffect((function(){if(r.current)return e&&e();r.current=!0}),t)},Object.defineProperty(e,"__esModule",{value:!0}),e}({},React,primereact.utils);
+this.primereact=this.primereact||{},this.primereact.hooks=function(e,t,r){"use strict";function n(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 u=n(t),c=function(e){var t=u.useRef(void 0);return u.useEffect((function(){t.current=e})),t.current},o=function(e){return u.useEffect((function(){return e}),[])},i=function(e){var t=e.target,n=void 0===t?"document":t,i=e.type,l=e.listener,f=e.options,a=e.when,s=void 0===a||a,v=u.useRef(null),d=u.useRef(null),g=c(f),m=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{};r.ObjectUtils.isNotEmpty(e.target)&&(y(),(e.when||s)&&(v.current=r.DomHandler.getTargetElement(e.target))),!d.current&&v.current&&(d.current=function(e){return l&&l(e)},v.current.addEventListener(i,d.current,f))},y=function(){d.current&&(v.current.removeEventListener(i,d.current,f),d.current=null)};return u.useEffect((function(){s?v.current=r.DomHandler.getTargetElement(n):(y(),v.current=null)}),[n,s]),u.useEffect((function(){!d.current||d.current===l&&g===f||(y(),s&&m())}),[l,f]),o((function(){y()})),[m,y]};function l(e){if(Array.isArray(e))return e}function f(e,t){var r=null==e?null:"undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(null!=r){var n,u,c,o,i=[],l=!0,f=!1;try{if(c=(r=r.call(e)).next,0===t){if(Object(r)!==r)return;l=!1}else for(;!(l=(n=c.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&&(o=r.return(),Object(o)!==o))return}finally{if(f)throw u}}return i}}function a(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 s(e,t){if(e){if("string"==typeof e)return a(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)?a(e,t):void 0}}function v(){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 d(e,t){return l(e)||f(e,t)||s(e,t)||v()}var g=function(e){var t=e.target,n=e.listener,i=e.options,l=e.when,f=void 0===l||l,a=u.useRef(null),s=u.useRef(null),v=u.useRef([]),d=c(i),g=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{};if(r.ObjectUtils.isNotEmpty(e.target)&&(m(),(e.when||f)&&(a.current=r.DomHandler.getTargetElement(e.target))),!s.current&&a.current){var t=v.current=r.DomHandler.getScrollableParents(a.current);s.current=function(e){return n&&n(e)},t.forEach((function(e){return e.addEventListener("scroll",s.current,i)}))}},m=function(){s.current&&(v.current.forEach((function(e){return e.removeEventListener("scroll",s.current,i)})),s.current=null)};return u.useEffect((function(){f?a.current=r.DomHandler.getTargetElement(t):(m(),a.current=null)}),[t,f]),u.useEffect((function(){!s.current||s.current===n&&d===i||(m(),f&&g())}),[n,i]),o((function(){m()})),[g,m]},m=function(e){return i({target:"window",type:"resize",listener:e.listener})},y=function(e,t){var r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:"local",n="undefined"!=typeof window,c=i({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)}}),o=d(c,2),l=o[0],f=o[1],a=u.useState((function(){if(!n)return e;try{var u="local"===r?window.localStorage.getItem(t):window.sessionStorage.getItem(t);return u?JSON.parse(u):e}catch(t){return e}})),s=d(a,2),v=s[0],g=s[1],m=function(e){try{var u=e instanceof Function?e(v):e;if(g(u),n){var c=JSON.stringify(u);"local"===r?window.localStorage.setItem(t,c):window.sessionStorage.setItem(t,c)}}catch(e){throw new Error("PrimeReact useStorage: Failed to serialize the value at key: ".concat(t))}};return u.useEffect((function(){return l(),function(){return f()}}),[]),[v,m]};return e.useEventListener=i,e.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],n=u.useRef(null),c=u.useRef(null),i=u.useCallback((function(){return clearInterval(n.current)}),[n.current]);return u.useEffect((function(){c.current=e})),u.useEffect((function(){if(r)return n.current=setInterval((function(){c.current()}),t),i;i()}),[t,r]),o((function(){i()})),[i]},e.useLocalStorage=function(e,t){return y(e,t,"local")},e.useMountEffect=function(e){return u.useEffect(e,[])},e.useOverlayListener=function(e){var t=e.target,n=e.overlay,c=e.listener,l=e.when,f=void 0===l||l,a=u.useRef(null),s=u.useRef(null),v=d(i({type:"click",listener:function(e){c&&c(e,{type:"outside",valid:3!==e.which&&R(e)})}}),2),y=v[0],E=v[1],h=d(m({listener:function(e){c&&c(e,{type:"resize",valid:!r.DomHandler.isTouchDevice()})}}),2),w=h[0],p=h[1],b=d(g({target:t,listener:function(e){c&&c(e,{type:"scroll",valid:!0})}}),2),S=b[0],O=b[1],R=function(e){return a.current&&!(a.current.isSameNode(e.target)||a.current.contains(e.target)||s.current&&s.current.contains(e.target))},j=function(){E(),p(),O()};return u.useEffect((function(){f?(a.current=r.DomHandler.getTargetElement(t),s.current=r.DomHandler.getTargetElement(n)):(j(),a.current=s.current=null)}),[t,n,f]),u.useEffect((function(){j()}),[f]),o((function(){j()})),[function(){y(),w(),S()},j]},e.useOverlayScrollListener=g,e.usePrevious=c,e.useResizeListener=m,e.useSessionStorage=function(e,t){return y(e,t,"session")},e.useStorage=y,e.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],n=u.useRef(null),c=u.useRef(null),i=u.useCallback((function(){return clearTimeout(n.current)}),[n.current]);return u.useEffect((function(){c.current=e})),u.useEffect((function(){if(r)return n.current=setTimeout((function(){c.current()}),t),i;i()}),[t,r]),o((function(){i()})),[i]},e.useUnmountEffect=o,e.useUpdateEffect=function(e,t){var r=u.useRef(!1);return u.useEffect((function(){if(r.current)return e&&e();r.current=!0}),t)},Object.defineProperty(e,"__esModule",{value:!0}),e}({},React,primereact.utils);

package/image/image.d.ts

@@ -1,24 +1,104 @@
+/**
+ *
+ * Displays a single image with preview and tranformation options.
+ *
+ * [Live Demo](https://www.primefaces.org/primereact/image/)
+ *
+ * @module image
+ *
+ */
 import * as React from 'react';
 
+/**
+ * Defines valid properties in Image component. In addition to these, all properties of HTMLSpanElement can be used in this component.
+ * @group Properties
+ */
 export interface ImageProps extends Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, 'ref'> {
-    alt?: string;
-    children?: React.ReactNode;
-    downloadable?: boolean;
-    height?: string;
-    imageClassName?: string;
-    imageStyle?: React.CSSProperties;
-    preview?: boolean;
-    src?: string;
-    template?: any;
-    width?: string;
-    zoomSrc?: string;
+    /**
+     * Specifies an alternate text for an area, if the image cannot be displayed.
+     */
+    alt?: string | undefined;
+    /**
+     * Used to get the child elements of the component.
+     * @readonly
+     */
+    children?: React.ReactNode | undefined;
+    /**
+     * Adds a download button to the preview control menu.
+     * @default false
+     */
+    downloadable?: boolean | undefined;
+    /**
+     * Height of the image element.
+     */
+    height?: string | undefined;
+    /**
+     * Style class of the image element.
+     */
+    imageClassName?: string | undefined;
+    /**
+     * Inline style of the image element.
+     */
+    imageStyle?: React.CSSProperties | undefined;
+    /**
+     * Controls the preview functionality.
+     * @default false
+     */
+    preview?: boolean | undefined;
+    /**
+     * Specifies the path to the image.
+     */
+    src?: string | undefined;
+    /**
+     * Changing the default icon when the image is hovered in preview mode.
+     */
+    template?: any | undefined;
+    /**
+     * Width of the image element.
+     */
+    width?: string | undefined;
+    /**
+     * Zoomed image that may be different than "src" image.
+     */
+    zoomSrc?: string | undefined;
+    /**
+     * Triggered when the preview overlay is hidden.
+     */
     onHide?(): void;
+    /**
+     * Triggered when the preview overlay is shown.
+     */
     onShow?(): void;
 }
 
+/**
+ * **PrimeReact - Image**
+ *
+ * _Displays a single image with preview and tranformation options._
+ *
+ * [Live Demo](https://www.primefaces.org/primereact/image/)
+ * --- ---
+ * ![PrimeReact](https://www.primefaces.org/primereact/images/logo-100.png)
+ *
+ * @group Component
+ */
 export declare class Image extends React.Component<ImageProps, any> {
+    /**
+     * Used to show the overlay.
+     */
     public show(): void;
+    /**
+     * Used to hide the overlay.
+     */
     public hide(): void;
+    /**
+     * Used to get container element.
+     * @return {HTMLSpanElement} Container element
+     */
     public getElement(): HTMLSpanElement;
+    /**
+     * Used to get image element
+     * @return {HTMLImageElement} Image element
+     */
     public getImage(): HTMLImageElement;
 }

package/inplace/inplace.d.ts

@@ -1,31 +1,123 @@
+/**
+ *
+ * Inplace provides an easy to do editing and display at the same time where clicking the output displays the actual content.
+ *
+ * [Live Demo](https://www.primefaces.org/primereact/inplace)
+ *
+ * Helper Components:
+ *
+ * - {@link InplaceDisplay}
+ *
+ * - {@link InplaceContent}
+ *
+ * @module inplace
+ *
+ */
 import * as React from 'react';
 
-interface InplaceToggleParams {
+/**
+ * Custom toggle event.
+ * @see {@link InplaceProps.onToggle}
+ * @event
+ */
+interface InplaceToggleEvent {
+    /**
+     * Browser event
+     */
     originalEvent: React.SyntheticEvent;
+    /**
+     * Current value
+     */
     value: boolean;
 }
 
+/**
+ * Defines valid properties in Inplace component. In addition to these, all properties of HTMLDivElement can be used in this component.
+ * @group Properties
+ */
 export interface InplaceProps extends Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, 'ref'> {
-    active?: boolean;
-    closable?: boolean;
-    disabled?: boolean;
-    ariaLabel?: string;
+    /**
+     * Whether the content is displayed or not.
+     * @defaultValue false
+     */
+    active?: boolean | undefined;
+    /**
+     * Displays a button to switch back to display mode.
+     * @defaultValue false
+     */
+    closable?: boolean | undefined;
+    /**
+     * When present, it specifies that the element should be disabled.
+     * @defaultValue false
+     */
+    disabled?: boolean | undefined;
+    /**
+     * Used to define a string that labels the component.
+     */
+    ariaLabel?: string | undefined;
+    /**
+     * Callback to invoke when inplace is opened.
+     * @param {React.MouseEvent}  event - Browser event.
+     */
     onOpen?(event: React.MouseEvent<HTMLElement>): void;
+    /**
+     * Callback to invoke when inplace is closed.
+     * @param {React.MouseEvent}  event - Browser event.
+     */
     onClose?(event: React.MouseEvent<HTMLElement>): void;
-    onToggle?(e: InplaceToggleParams): void;
-    children?: React.ReactNode;
+    /**
+     * Callback to invoke when inplace is opened or closed.
+     * @param {InplaceToggleEvent}  event - Custom toggle event.
+     */
+    onToggle?(event: InplaceToggleEvent): void;
+    /**
+     * Used to get the child elements of the component.
+     * @readonly
+     */
+    children?: React.ReactNode | undefined;
 }
 
+/**
+ * **PrimeReact - Inplace**
+ *
+ * _Inplace provides an easy to do editing and display at the same time where clicking the output displays the actual content._
+ *
+ * [Live Demo](https://www.primefaces.org/primereact/inplace/)
+ * --- ---
+ * ![PrimeReact](https://www.primefaces.org/primereact/images/logo-100.png)
+ *
+ * @group Component
+ */
 export declare class Inplace extends React.Component<InplaceProps, any> {
+    /**
+     * Used to get container element.
+     * @return {HTMLDivElement} Container element
+     */
     public getElement(): HTMLDivElement;
 }
 
+/**
+ * InplaceDisplay is a helper component for Inplace.
+ * @group Component
+ */
 // tslint:disable-next-line:max-classes-per-file
 export declare class InplaceDisplay extends React.Component {
-    children?: React.ReactNode;
+    /**
+     * Used to get the child elements of the component.
+     * @readonly
+     */
+    children?: React.ReactNode | undefined;
 }
 
+/**
+ * InplaceContent is a helper component for Inplace.
+ * @group Component
+ */
 // tslint:disable-next-line:max-classes-per-file
 export declare class InplaceContent extends React.Component {
-    children?: React.ReactNode;
+    /**
+     * Used to get the child elements of the component.
+     * @readonly
+     */
+    children?: React.ReactNode | undefined;
 }