primereact 8.7.2 → 9.0.0-beta.1

package/virtualscroller/virtualscroller.cjs.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("react"),t=require("primereact/hooks"),r=require("primereact/utils");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 o=n(e);function l(){return l=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var r=arguments[t];for(var n in r)Object.prototype.hasOwnProperty.call(r,n)&&(e[n]=r[n])}return e},l.apply(this,arguments)}function i(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function s(e){if(Array.isArray(e))return e}function c(e,t){var r=null==e?null:"undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(null!=r){var n,o,l=[],i=!0,s=!1;try{for(r=r.call(e);!(i=(n=r.next()).done)&&(l.push(n.value),!t||l.length!==t);i=!0);}catch(e){s=!0,o=e}finally{try{i||null==r.return||r.return()}finally{if(s)throw o}}return l}}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 u(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 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 m(e,t){return s(e)||c(e,t)||u(e,t)||f()}function d(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 p(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?d(Object(r),!0).forEach((function(t){i(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):d(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}var g=o.memo(o.forwardRef((function(e,n){var i="vertical"===e.orientation,s="horizontal"===e.orientation,c="both"===e.orientation,a=m(o.useState(c?{rows:0,cols:0}:0),2),u=a[0],f=a[1],d=m(o.useState(c?{rows:0,cols:0}:0),2),h=d[0],v=d[1],w=m(o.useState(c?{rows:0,cols:0}:0),2),y=w[0],S=w[1],b=m(o.useState(e.numToleratedItems),2),z=b[0],O=b[1],T=m(o.useState(e.loading||!1),2),I=T[0],j=T[1],E=m(o.useState([]),2),x=E[0],R=E[1],L=o.useRef(null),P=o.useRef(null),D=o.useRef(null),H=o.useRef(null),U=o.useRef(c?{top:0,left:0}:0),M=o.useRef(null),N=o.useRef(null),W=o.useRef(null),A=o.useRef(null),C=t.usePrevious(e.items),k=t.usePrevious(e.loading),V=m(t.useResizeListener({listener:function(e){return ne()}}),1)[0],_=m(t.useEventListener({target:"window",type:"orientationchange",listener:function(e){return ne()}}),1)[0],J=function(){return L},X=function(e){U.current=c?{top:0,left:0}:0,L.current&&L.current.scrollTo(e)},q=function(t){var r=arguments.length>1&&void 0!==arguments[1]?arguments[1]:"auto",n=K(),o=n.numToleratedItems,l=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:0,t=arguments.length>1?arguments[1]:void 0;return e<=t?0:e},i=function(e,t){return e*t},a=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:0,t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:0;return X({left:e,top:t,behavior:r})};if(c){var f={rows:l(t[0],o[0]),cols:l(t[1],o[1])};f.rows===u.rows&&f.cols===u.cols||a(i(f.cols,e.itemSize[1]),i(f.rows,e.itemSize[0]))}else{var m=l(t,o);m!==u&&(s?a(i(m,e.itemSize),0):a(0,i(m,e.itemSize)))}},F=function(t,r){var n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:"auto";if(r){var o=B(),l=o.first,i=o.viewport,a=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:0,t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:0;return X({left:e,top:t,behavior:n})},u="to-start"===r,f="to-end"===r;if(u){if(c)i.first.rows-l.rows>t[0]?a(i.first.cols*e.itemSize[1],(i.first.rows-1)*e.itemSize[0]):i.first.cols-l.cols>t[1]&&a((i.first.cols-1)*e.itemSize[1],i.first.rows*e.itemSize[0]);else if(i.first-l>t){var m=(i.first-1)*e.itemSize;s?a(m,0):a(0,m)}}else if(f)if(c)i.last.rows-l.rows<=t[0]+1?a(i.first.cols*e.itemSize[1],(i.first.rows+1)*e.itemSize[0]):i.last.cols-l.cols<=t[1]+1&&a((i.first.cols+1)*e.itemSize[1],i.first.rows*e.itemSize[0]);else if(i.last-l<=t+1){var d=(i.first+1)*e.itemSize;s?a(d,0):a(0,d)}}else q(t,n)},B=function(){var t=function(e,t){return Math.floor(e/(t||e))},r=u,n=0;if(L.current){var o=L.current,l=o.scrollTop,i=o.scrollLeft;if(c)n={rows:(r={rows:t(l,e.itemSize[0]),cols:t(i,e.itemSize[1])}).rows+y.rows,cols:r.cols+y.cols};else n=(r=t(s?i:l,e.itemSize))+y}return{first:u,last:h,viewport:{first:r,last:n}}},K=function(){var t=G(),r=L.current?L.current.offsetWidth-t.left:0,n=L.current?L.current.offsetHeight-t.top:0,o=function(e,t){return Math.ceil(e/(t||e))},l=function(e){return Math.ceil(e/2)},i=c?{rows:o(n,e.itemSize[0]),cols:o(r,e.itemSize[1])}:o(s?r:n,e.itemSize);return{numItemsInViewport:i,numToleratedItems:z||(c?[l(i.rows),l(i.cols)]:l(i))}},Y=function(t){e.autoSize&&!t&&Promise.resolve().then((function(){if(P.current){P.current.style.minHeight=P.current.style.minWidth="auto";var e=P.current,t=e.offsetWidth,r=e.offsetHeight;(c||s)&&(L.current.style.width=(t<W.current?t:W.current)+"px"),(c||i)&&(L.current.style.height=(r<A.current?r:A.current)+"px"),P.current.style.minHeight=P.current.style.minWidth=""}}))},$=function(){var t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:0,r=arguments.length>1?arguments[1]:void 0;return e.items?Math.min(r?(e.columns||e.items[0]).length:e.items.length,t):0},G=function(){if(P.current){var e=getComputedStyle(P.current),t=parseInt(e.paddingLeft,10)+Math.max(parseInt(e.left,10),0),r=parseInt(e.paddingRight,10)+Math.max(parseInt(e.right,10),0),n=parseInt(e.paddingTop,10)+Math.max(parseInt(e.top,10),0),o=parseInt(e.paddingBottom,10)+Math.max(parseInt(e.bottom,10),0);return{left:t,right:r,top:n,bottom:o,x:t+r,y:n+o}}return{left:0,right:0,top:0,bottom:0,x:0,y:0}},Q=function(){if(L.current){var t=L.current.parentElement,r=e.scrollWidth||"".concat(L.current.offsetWidth||t.offsetWidth,"px"),n=e.scrollHeight||"".concat(L.current.offsetHeight||t.offsetHeight,"px"),o=function(e,t){return L.current.style[e]=t};c||s?(o("height",n),o("width",r)):o("height",n)}},Z=function(){var t=e.items;if(D.current&&t){var r=G(),n=function(e,t,r){var n=arguments.length>3&&void 0!==arguments[3]?arguments[3]:0;return D.current.style[e]=(t||[]).length*r+n+"px"};c?(n("height",t,e.itemSize[0],r.y),n("width",e.columns||t[1],e.itemSize[1],r.x)):s?n("width",e.columns||t,e.itemSize,r.x):n("height",t,e.itemSize,r.y)}},ee=function(t){if(P.current){var r=t?t.first:u,n=function(e,t){return e*t},o=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:0,t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:0;H.current&&(H.current.style.top="-".concat(t,"px")),P.current.style.transform="translate3d(".concat(e,"px, ").concat(t,"px, 0)")};if(c)o(n(r.cols,e.itemSize[1]),n(r.rows,e.itemSize[0]));else{var l=n(r,e.itemSize);s?o(l,0):o(0,l)}}},te=function(t){var r=t.target,n=G(),o=function(e,t){return e?e>t?e-t:e:0},l=function(e,t){return Math.floor(e/(t||e))},i=function(e,t,r,n,o,l){return e<=o?o:l?r-n-o:t+o-1},a=function(e,t,r,n,o,l,i){return e<=l?0:Math.max(0,i?e<t?r:e-l:e>t?r:e-2*l)},f=function(e,t,r,n,o,l){var i=t+n+2*o;return e>=o&&(i+=o+1),$(i,l)},m=o(r.scrollTop,n.top),d=o(r.scrollLeft,n.left),p=c?{rows:0,cols:0}:0,g=h,v=!1,w=U.current;if(c){var S=U.current.top<=m,b=U.current.left<=d,O={rows:l(m,e.itemSize[0]),cols:l(d,e.itemSize[1])},T={rows:i(O.rows,u.rows,h.rows,y.rows,z[0],S),cols:i(O.cols,u.cols,h.cols,y.cols,z[1],b)};p={rows:a(O.rows,T.rows,u.rows,0,0,z[0],S),cols:a(O.cols,T.cols,u.cols,0,0,z[1],b)},g={rows:f(O.rows,p.rows,0,y.rows,z[0]),cols:f(O.cols,p.cols,0,y.cols,z[1],!0)},v=p.rows!==u.rows||g.rows!==h.rows||p.cols!==u.cols||g.cols!==h.cols,w={top:m,left:d}}else{var I=s?d:m,j=U.current<=I,E=l(I,e.itemSize);g=f(E,p=a(E,i(E,u,h,y,z,j),u,0,0,z,j),0,y,z),v=p!==u||g!==h,w=I}return{first:p,last:g,isRangeChanged:v,scrollPos:w}},re=function(t){var r=te(t),n=r.first,o=r.last,l=r.scrollPos;if(r.isRangeChanged){var i={first:n,last:o};ee(i),f(n),v(o),U.current=l,e.onScrollIndexChange&&e.onScrollIndexChange(i),e.lazy&&e.onLazyLoad&&e.onLazyLoad(i)}},ne=function(){N.current&&clearTimeout(N.current),N.current=setTimeout((function(){if(L.current){var t=[r.DomHandler.getWidth(L.current),r.DomHandler.getHeight(L.current)],n=t[0],o=t[1],l=n!==W.current,a=o!==A.current;(c?l||a:s?l:!!i&&a)&&(O(e.numToleratedItems),W.current=n,A.current=o)}}),e.resizeDelay)},oe=function(t){var r=(e.items||[]).length,n=c?u.rows+t:u+t;return{index:n,count:r,first:0===n,last:n===r-1,even:n%2==0,odd:n%2!=0,props:e}},le=function(t,r){var n=x.length;return p({index:t,count:n,first:0===t,last:t===n-1,even:t%2==0,odd:t%2!=0,props:e},r)},ie=function(){var t=e.items;return t&&!I?c?t.slice(u.rows,h.rows).map((function(t){return e.columns?t:t.slice(u.cols,h.cols)})):s&&e.columns?t:t.slice(u,h):[]},se=function(){var t,r,n,o,l;e.disabled||(Q(),t=K(),r=t.numItemsInViewport,n=t.numToleratedItems,o=function(e,t,r,n){return $(e+t+(e<r?2:3)*r,n)},l=c?{rows:o(u.rows,r.rows,n[0]),cols:o(u.cols,r.cols,n[1],!0)}:o(u,r,n),S(r),O(n),v(l),e.showLoader&&R(c?Array.from({length:r.rows}).map((function(){return Array.from({length:r.cols})})):Array.from({length:r})),e.lazy&&e.onLazyLoad&&e.onLazyLoad({first:u,last:l}),Z())};t.useMountEffect((function(){e.disabled||(se(),V(),_(),W.current=r.DomHandler.getWidth(L.current),A.current=r.DomHandler.getHeight(L.current))})),t.useUpdateEffect((function(){se()}),[e.itemSize,e.scrollHeight]),t.useUpdateEffect((function(){e.numToleratedItems!==z&&O(e.numToleratedItems)}),[e.numToleratedItems]),t.useUpdateEffect((function(){e.numToleratedItems===z&&se()}),[z]),t.useUpdateEffect((function(){C&&C.length===(e.items||[]).length||se();var t=I;e.lazy&&k!==e.loading&&e.loading!==I&&(j(e.loading),t=e.loading),Y(t)})),t.useUpdateEffect((function(){U.current=c?{top:0,left:0}:0}),[e.orientation]),o.useImperativeHandle(n,(function(){return{props:e,getElementRef:J,scrollTo:X,scrollToIndex:q,scrollInView:F,getRenderedRange:B}}));var ce=function(t){var n=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},l=le(t,n),i=r.ObjectUtils.getJSXElement(e.loadingTemplate,l);return o.createElement(o.Fragment,{key:t},i)},ae=function(t,n){var l=oe(n),i=r.ObjectUtils.getJSXElement(e.itemTemplate,t,l);return o.createElement(o.Fragment,{key:l.index},i)};if(e.disabled){var ue=r.ObjectUtils.getJSXElement(e.contentTemplate,{items:e.items,rows:e.items,columns:e.columns});return o.createElement(o.Fragment,null,e.children,ue)}var fe=r.ObjectUtils.findDiffKeys(e,g.defaultProps),me=r.classNames("p-virtualscroller",{"p-both-scroll":c,"p-horizontal-scroll":s},e.className),de=function(){if(!e.loaderDisabled&&e.showLoader&&I){var t=r.classNames("p-virtualscroller-loader",{"p-component-overlay":!e.loadingTemplate}),n=o.createElement("i",{className:"p-virtualscroller-loading-icon pi pi-spinner pi-spin"});return e.loadingTemplate?n=x.map((function(e,t){return ce(t,c&&{numCols:y.cols})})):e.loaderIconTemplate&&(n=r.ObjectUtils.getJSXElement(e.loaderIconTemplate,{className:"p-virtualscroller-loading-icon",element:n,props:e})),o.createElement("div",{className:t},n)}return null}(),pe=function(){var t=ie().map(ae),n=r.classNames("p-virtualscroller-content",{"p-virtualscroller-loading":I}),l=o.createElement("div",{ref:P,className:n},t);if(e.contentTemplate){var a={className:n,contentRef:function(e){return P.current=r.ObjectUtils.getRefElement(e)},spacerRef:function(e){return D.current=r.ObjectUtils.getRefElement(e)},stickyRef:function(e){return H.current=r.ObjectUtils.getRefElement(e)},items:ie(),getItemOptions:function(e){return oe(e)},children:t,element:l,props:e,loading:I,getLoaderOptions:function(e,t){return le(e,t)},loadingTemplate:e.loadingTemplate,itemSize:e.itemSize,rows:I?e.loaderDisabled?x:[]:ie(),columns:e.columns&&c||s?I&&e.loaderDisabled?c?x[0]:x:e.columns.slice(c?u.cols:u,c?h.cols:h):e.columns,vertical:i,horizontal:s,both:c};return r.ObjectUtils.getJSXElement(e.contentTemplate,a)}return l}(),ge=e.showSpacer?o.createElement("div",{ref:D,className:"p-virtualscroller-spacer"}):null;return o.createElement("div",l({ref:L,className:me,tabIndex:0,style:e.style},fe,{onScroll:function(t){e.onScroll&&e.onScroll(t),e.delay?(M.current&&clearTimeout(M.current),!I&&e.showLoader&&te(t).isRangeChanged&&j(!0),M.current=setTimeout((function(){re(t),!I||!e.showLoader||e.lazy&&void 0!==e.loading||j(!1)}),e.delay)):re(t)}}),pe,ge,de)})));g.displayName="VirtualScroller",g.defaultProps={__TYPE:"VirtualScroller",id:null,style:null,className:null,items:null,itemSize:0,scrollHeight:null,scrollWidth:null,orientation:"vertical",numToleratedItems:null,delay:0,resizeDelay:10,lazy:!1,disabled:!1,loaderDisabled:!1,columns:null,loading:void 0,autoSize:!1,showSpacer:!0,showLoader:!1,loadingTemplate:null,loaderIconTemplate:null,itemTemplate:null,contentTemplate:null,onScroll:null,onScrollIndexChange:null,onLazyLoad:null},exports.VirtualScroller=g;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("react"),t=require("primereact/hooks"),r=require("primereact/utils");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 o=n(e);function l(){return l=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var r=arguments[t];for(var n in r)Object.prototype.hasOwnProperty.call(r,n)&&(e[n]=r[n])}return e},l.apply(this,arguments)}function i(e){return i="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},i(e)}function s(e,t){if("object"!==i(e)||null===e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var n=r.call(e,t||"default");if("object"!==i(n))return n;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}function c(e){var t=s(e,"string");return"symbol"===i(t)?t:String(t)}function a(e,t,r){return(t=c(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function u(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,o,l,i,s=[],c=!0,a=!1;try{if(l=(r=r.call(e)).next,0===t){if(Object(r)!==r)return;c=!1}else for(;!(c=(n=l.call(r)).done)&&(s.push(n.value),s.length!==t);c=!0);}catch(e){a=!0,o=e}finally{try{if(!c&&null!=r.return&&(i=r.return(),Object(i)!==i))return}finally{if(a)throw o}}return s}}function m(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 d(e,t){if(e){if("string"==typeof e)return m(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)?m(e,t):void 0}}function p(){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 u(e)||f(e,t)||d(e,t)||p()}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 v(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){a(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}var y=o.memo(o.forwardRef((function(e,n){var i="vertical"===e.orientation,s="horizontal"===e.orientation,c="both"===e.orientation,a=g(o.useState(c?{rows:0,cols:0}:0),2),u=a[0],f=a[1],m=g(o.useState(c?{rows:0,cols:0}:0),2),d=m[0],p=m[1],h=g(o.useState(c?{rows:0,cols:0}:0),2),w=h[0],b=h[1],S=g(o.useState(e.numToleratedItems),2),z=S[0],O=S[1],T=g(o.useState(e.loading||!1),2),j=T[0],I=T[1],E=g(o.useState([]),2),x=E[0],R=E[1],P=o.useRef(null),L=o.useRef(null),D=o.useRef(null),H=o.useRef(null),U=o.useRef(c?{top:0,left:0}:0),M=o.useRef(null),N=o.useRef(null),W=o.useRef(null),A=o.useRef(null),C=t.usePrevious(e.items),k=t.usePrevious(e.loading),V=g(t.useResizeListener({listener:function(e){return ne()}}),1)[0],_=g(t.useEventListener({target:"window",type:"orientationchange",listener:function(e){return ne()}}),1)[0],J=function(){return P},X=function(e){U.current=c?{top:0,left:0}:0,P.current&&P.current.scrollTo(e)},q=function(t){var r=arguments.length>1&&void 0!==arguments[1]?arguments[1]:"auto",n=K(),o=n.numToleratedItems,l=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:0,t=arguments.length>1?arguments[1]:void 0;return e<=t?0:e},i=function(e,t){return e*t},a=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:0,t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:0;return X({left:e,top:t,behavior:r})};if(c){var f={rows:l(t[0],o[0]),cols:l(t[1],o[1])};f.rows===u.rows&&f.cols===u.cols||a(i(f.cols,e.itemSize[1]),i(f.rows,e.itemSize[0]))}else{var m=l(t,o);m!==u&&(s?a(i(m,e.itemSize),0):a(0,i(m,e.itemSize)))}},F=function(t,r){var n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:"auto";if(r){var o=B(),l=o.first,i=o.viewport,a=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:0,t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:0;return X({left:e,top:t,behavior:n})},u="to-start"===r,f="to-end"===r;if(u){if(c)i.first.rows-l.rows>t[0]?a(i.first.cols*e.itemSize[1],(i.first.rows-1)*e.itemSize[0]):i.first.cols-l.cols>t[1]&&a((i.first.cols-1)*e.itemSize[1],i.first.rows*e.itemSize[0]);else if(i.first-l>t){var m=(i.first-1)*e.itemSize;s?a(m,0):a(0,m)}}else if(f)if(c)i.last.rows-l.rows<=t[0]+1?a(i.first.cols*e.itemSize[1],(i.first.rows+1)*e.itemSize[0]):i.last.cols-l.cols<=t[1]+1&&a((i.first.cols+1)*e.itemSize[1],i.first.rows*e.itemSize[0]);else if(i.last-l<=t+1){var d=(i.first+1)*e.itemSize;s?a(d,0):a(0,d)}}else q(t,n)},B=function(){var t=function(e,t){return Math.floor(e/(t||e))},r=u,n=0;if(P.current){var o=P.current,l=o.scrollTop,i=o.scrollLeft;if(c)n={rows:(r={rows:t(l,e.itemSize[0]),cols:t(i,e.itemSize[1])}).rows+w.rows,cols:r.cols+w.cols};else n=(r=t(s?i:l,e.itemSize))+w}return{first:u,last:d,viewport:{first:r,last:n}}},K=function(){var t=G(),r=P.current?P.current.offsetWidth-t.left:0,n=P.current?P.current.offsetHeight-t.top:0,o=function(e,t){return Math.ceil(e/(t||e))},l=function(e){return Math.ceil(e/2)},i=c?{rows:o(n,e.itemSize[0]),cols:o(r,e.itemSize[1])}:o(s?r:n,e.itemSize);return{numItemsInViewport:i,numToleratedItems:z||(c?[l(i.rows),l(i.cols)]:l(i))}},Y=function(t){e.autoSize&&!t&&Promise.resolve().then((function(){if(L.current){L.current.style.minHeight=L.current.style.minWidth="auto";var e=L.current,t=e.offsetWidth,r=e.offsetHeight;(c||s)&&(P.current.style.width=(t<W.current?t:W.current)+"px"),(c||i)&&(P.current.style.height=(r<A.current?r:A.current)+"px"),L.current.style.minHeight=L.current.style.minWidth=""}}))},$=function(){var t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:0,r=arguments.length>1?arguments[1]:void 0;return e.items?Math.min(r?(e.columns||e.items[0]).length:e.items.length,t):0},G=function(){if(L.current){var e=getComputedStyle(L.current),t=parseInt(e.paddingLeft,10)+Math.max(parseInt(e.left,10),0),r=parseInt(e.paddingRight,10)+Math.max(parseInt(e.right,10),0),n=parseInt(e.paddingTop,10)+Math.max(parseInt(e.top,10),0),o=parseInt(e.paddingBottom,10)+Math.max(parseInt(e.bottom,10),0);return{left:t,right:r,top:n,bottom:o,x:t+r,y:n+o}}return{left:0,right:0,top:0,bottom:0,x:0,y:0}},Q=function(){if(P.current){var t=P.current.parentElement,r=e.scrollWidth||"".concat(P.current.offsetWidth||t.offsetWidth,"px"),n=e.scrollHeight||"".concat(P.current.offsetHeight||t.offsetHeight,"px"),o=function(e,t){return P.current.style[e]=t};c||s?(o("height",n),o("width",r)):o("height",n)}},Z=function(){var t=e.items;if(D.current&&t){var r=G(),n=function(e,t,r){var n=arguments.length>3&&void 0!==arguments[3]?arguments[3]:0;return D.current.style[e]=(t||[]).length*r+n+"px"};c?(n("height",t,e.itemSize[0],r.y),n("width",e.columns||t[1],e.itemSize[1],r.x)):s?n("width",e.columns||t,e.itemSize,r.x):n("height",t,e.itemSize,r.y)}},ee=function(t){if(L.current){var r=t?t.first:u,n=function(e,t){return e*t},o=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:0,t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:0;H.current&&(H.current.style.top="-".concat(t,"px")),L.current.style.transform="translate3d(".concat(e,"px, ").concat(t,"px, 0)")};if(c)o(n(r.cols,e.itemSize[1]),n(r.rows,e.itemSize[0]));else{var l=n(r,e.itemSize);s?o(l,0):o(0,l)}}},te=function(t){var r=t.target,n=G(),o=function(e,t){return e?e>t?e-t:e:0},l=function(e,t){return Math.floor(e/(t||e))},i=function(e,t,r,n,o,l){return e<=o?o:l?r-n-o:t+o-1},a=function(e,t,r,n,o,l,i){return e<=l?0:Math.max(0,i?e<t?r:e-l:e>t?r:e-2*l)},f=function(e,t,r,n,o,l){var i=t+n+2*o;return e>=o&&(i+=o+1),$(i,l)},m=o(r.scrollTop,n.top),p=o(r.scrollLeft,n.left),g=c?{rows:0,cols:0}:0,h=d,v=!1,y=U.current;if(c){var b=U.current.top<=m,S=U.current.left<=p,O={rows:l(m,e.itemSize[0]),cols:l(p,e.itemSize[1])},T={rows:i(O.rows,u.rows,d.rows,w.rows,z[0],b),cols:i(O.cols,u.cols,d.cols,w.cols,z[1],S)};g={rows:a(O.rows,T.rows,u.rows,0,0,z[0],b),cols:a(O.cols,T.cols,u.cols,0,0,z[1],S)},h={rows:f(O.rows,g.rows,0,w.rows,z[0]),cols:f(O.cols,g.cols,0,w.cols,z[1],!0)},v=g.rows!==u.rows||h.rows!==d.rows||g.cols!==u.cols||h.cols!==d.cols,y={top:m,left:p}}else{var j=s?p:m,I=U.current<=j,E=l(j,e.itemSize);h=f(E,g=a(E,i(E,u,d,w,z,I),u,0,0,z,I),0,w,z),v=g!==u||h!==d,y=j}return{first:g,last:h,isRangeChanged:v,scrollPos:y}},re=function(t){var r=te(t),n=r.first,o=r.last,l=r.scrollPos;if(r.isRangeChanged){var i={first:n,last:o};ee(i),f(n),p(o),U.current=l,e.onScrollIndexChange&&e.onScrollIndexChange(i),e.lazy&&e.onLazyLoad&&e.onLazyLoad(i)}},ne=function(){N.current&&clearTimeout(N.current),N.current=setTimeout((function(){if(P.current){var t=[r.DomHandler.getWidth(P.current),r.DomHandler.getHeight(P.current)],n=t[0],o=t[1],l=n!==W.current,a=o!==A.current;(c?l||a:s?l:!!i&&a)&&(O(e.numToleratedItems),W.current=n,A.current=o)}}),e.resizeDelay)},oe=function(t){var r=(e.items||[]).length,n=c?u.rows+t:u+t;return{index:n,count:r,first:0===n,last:n===r-1,even:n%2==0,odd:n%2!=0,props:e}},le=function(t,r){var n=x.length;return v({index:t,count:n,first:0===t,last:t===n-1,even:t%2==0,odd:t%2!=0,props:e},r)},ie=function(){var t=e.items;return t&&!j?c?t.slice(u.rows,d.rows).map((function(t){return e.columns?t:t.slice(u.cols,d.cols)})):s&&e.columns?t:t.slice(u,d):[]},se=function(){var t,r,n,o,l;e.disabled||(Q(),t=K(),r=t.numItemsInViewport,n=t.numToleratedItems,o=function(e,t,r,n){return $(e+t+(e<r?2:3)*r,n)},l=c?{rows:o(u.rows,r.rows,n[0]),cols:o(u.cols,r.cols,n[1],!0)}:o(u,r,n),b(r),O(n),p(l),e.showLoader&&R(c?Array.from({length:r.rows}).map((function(){return Array.from({length:r.cols})})):Array.from({length:r})),e.lazy&&e.onLazyLoad&&e.onLazyLoad({first:u,last:l}),Z())};t.useMountEffect((function(){e.disabled||(se(),V(),_(),W.current=r.DomHandler.getWidth(P.current),A.current=r.DomHandler.getHeight(P.current))})),t.useUpdateEffect((function(){se()}),[e.itemSize,e.scrollHeight]),t.useUpdateEffect((function(){e.numToleratedItems!==z&&O(e.numToleratedItems)}),[e.numToleratedItems]),t.useUpdateEffect((function(){e.numToleratedItems===z&&se()}),[z]),t.useUpdateEffect((function(){C&&C.length===(e.items||[]).length||se();var t=j;e.lazy&&k!==e.loading&&e.loading!==j&&(I(e.loading),t=e.loading),Y(t)})),t.useUpdateEffect((function(){U.current=c?{top:0,left:0}:0}),[e.orientation]),o.useImperativeHandle(n,(function(){return{props:e,getElementRef:J,scrollTo:X,scrollToIndex:q,scrollInView:F,getRenderedRange:B}}));var ce=function(t){var n=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},l=le(t,n),i=r.ObjectUtils.getJSXElement(e.loadingTemplate,l);return o.createElement(o.Fragment,{key:t},i)},ae=function(t,n){var l=oe(n),i=r.ObjectUtils.getJSXElement(e.itemTemplate,t,l);return o.createElement(o.Fragment,{key:l.index},i)};if(e.disabled){var ue=r.ObjectUtils.getJSXElement(e.contentTemplate,{items:e.items,rows:e.items,columns:e.columns});return o.createElement(o.Fragment,null,e.children,ue)}var fe=r.ObjectUtils.findDiffKeys(e,y.defaultProps),me=r.classNames("p-virtualscroller",{"p-both-scroll":c,"p-horizontal-scroll":s},e.className),de=function(){if(!e.loaderDisabled&&e.showLoader&&j){var t=r.classNames("p-virtualscroller-loader",{"p-component-overlay":!e.loadingTemplate}),n=o.createElement("i",{className:"p-virtualscroller-loading-icon pi pi-spinner pi-spin"});return e.loadingTemplate?n=x.map((function(e,t){return ce(t,c&&{numCols:w.cols})})):e.loaderIconTemplate&&(n=r.ObjectUtils.getJSXElement(e.loaderIconTemplate,{className:"p-virtualscroller-loading-icon",element:n,props:e})),o.createElement("div",{className:t},n)}return null}(),pe=function(){var t=ie().map(ae),n=r.classNames("p-virtualscroller-content",{"p-virtualscroller-loading":j}),l=o.createElement("div",{ref:L,className:n},t);if(e.contentTemplate){var a={className:n,contentRef:function(e){return L.current=r.ObjectUtils.getRefElement(e)},spacerRef:function(e){return D.current=r.ObjectUtils.getRefElement(e)},stickyRef:function(e){return H.current=r.ObjectUtils.getRefElement(e)},items:ie(),getItemOptions:function(e){return oe(e)},children:t,element:l,props:e,loading:j,getLoaderOptions:function(e,t){return le(e,t)},loadingTemplate:e.loadingTemplate,itemSize:e.itemSize,rows:j?e.loaderDisabled?x:[]:ie(),columns:e.columns&&c||s?j&&e.loaderDisabled?c?x[0]:x:e.columns.slice(c?u.cols:u,c?d.cols:d):e.columns,vertical:i,horizontal:s,both:c};return r.ObjectUtils.getJSXElement(e.contentTemplate,a)}return l}(),ge=e.showSpacer?o.createElement("div",{ref:D,className:"p-virtualscroller-spacer"}):null;return o.createElement("div",l({ref:P,className:me,tabIndex:0,style:e.style},fe,{onScroll:function(t){e.onScroll&&e.onScroll(t),e.delay?(M.current&&clearTimeout(M.current),!j&&e.showLoader&&te(t).isRangeChanged&&I(!0),M.current=setTimeout((function(){re(t),!j||!e.showLoader||e.lazy&&void 0!==e.loading||I(!1)}),e.delay)):re(t)}}),pe,ge,de)})));y.displayName="VirtualScroller",y.defaultProps={__TYPE:"VirtualScroller",id:null,style:null,className:null,items:null,itemSize:0,scrollHeight:null,scrollWidth:null,orientation:"vertical",numToleratedItems:null,delay:0,resizeDelay:10,lazy:!1,disabled:!1,loaderDisabled:!1,columns:null,loading:void 0,autoSize:!1,showSpacer:!0,showLoader:!1,loadingTemplate:null,loaderIconTemplate:null,itemTemplate:null,contentTemplate:null,onScroll:null,onScrollIndexChange:null,onLazyLoad:null},exports.VirtualScroller=y;

package/virtualscroller/virtualscroller.d.ts

@@ -1,132 +1,424 @@
-import * as React from 'react';
-
-type VirtualScrollerItemsType = any[] | any[][] | undefined | null;
-
-type VirtualScrollerItemSizeType = number | number[];
-
-type VirtualScrollerOrientationType = 'vertical' | 'horizontal' | 'both';
-
-type VirtualScrollerScrollBehavior = 'auto' | 'smooth';
-
-type VirtualScrollerToType = 'to-start' | 'to-end';
+/**
+ *
+ * VirtualScroller is a performant approach to handle huge data efficiently.
+ *
+ * [Live Demo](https://www.primefaces.org/primereact/virtualscroller/)
+ *
+ * @module virtualscroller
+ *
+ */
 
-type VirtualScrollerLoadingTemplateType = React.ReactNode | ((options: VirtualScrollerLoadingTemplateOptions) => React.ReactNode);
-
-type VirtualScrollerLoaderIconTemplateType = React.ReactNode | ((options: VirtualScrollerLoaderIconTemplateOptions) => React.ReactNode);
-
-type VirtualScrollerItemTemplateType = React.ReactNode | ((item: any, options: VirtualScrollerTemplateOptions) => React.ReactNode);
-
-type VirtualScrollerContentTemplateType = React.ReactNode | ((options: VirtualScrollerContentTemplateOptions) => React.ReactNode);
-
-type VirtualScrollerStateType = number | VirtualScrollerState;
-
-type VirtualScrollerToIndexType = number | number[];
+import * as React from 'react';
 
+/**
+ * Custom virtual scroller options type.
+ * @group Misc
+ */
 interface VirtualScrollerOptionsType {
+    /**
+     * Left position of scroll.
+     */
     left: number;
+    /**
+     * Top position of scroll
+     */
     top: number;
-    behavior: VirtualScrollerScrollBehavior;
+    /**
+     * Behavior of scroll, valid values are 'auto' and 'smooth'
+     */
+    behavior: 'auto' | 'smooth';
 }
 
+/**
+ * Viewport rendered range.
+ * @group Misc
+ */
 interface VirtualScrollerViewportRenderedRange {
+    /**
+     * The first number of the current viewport.
+     */
     first: number;
+    /**
+     * The last number of the current viewport.
+     */
     last: number;
 }
 
+/**
+ * Virtual scroller rendered range.
+ * @group Misc
+ */
 interface VirtualScrollerRenderedRange {
+    /**
+     * First index of the new data range to be rendered.
+     */
     first: number;
+    /**
+     * Last index of the new data range to be rendered.
+     */
     last: number;
+    /**
+     * Viewport of the rendered range.
+     */
     viewport: VirtualScrollerViewportRenderedRange;
 }
 
+/**
+ * Custom virtual scroller state.
+ * @group Misc
+ */
 interface VirtualScrollerState {
+    /**
+     * Number of rows to be rendered.
+     */
     rows: number;
+    /**
+     * Number of columns to be rendered.
+     */
     cols: number;
 }
 
+/**
+ * Custom template options.
+ * @group Misc
+ */
 interface VirtualScrollerTemplateOptions {
+    /**
+     * Index of the item.
+     */
     index: number;
+    /**
+     * Total numbers of items.
+     */
     count: number;
+    /**
+     * Whether this is the first item.
+     */
     first: boolean;
+    /**
+     * Whether this is the last item.
+     */
     last: boolean;
+    /**
+     * Whether the index is even.
+     */
     even: boolean;
+    /**
+     * Whether the index is odd.
+     */
     odd: boolean;
+    /**
+     * The props of the virtual scroller.
+     */
     props: VirtualScrollerProps;
 }
 
+/**
+ * Custom template options.
+ * @extends VirtualScrollerTemplateOptions
+ */
 interface VirtualScrollerLoadingTemplateOptions extends VirtualScrollerTemplateOptions {
+    /**
+     * Total number of columns in a row in 'both' orientation mode in view.
+     */
     numCols: number;
+    /**
+     * Extra options.
+     */
     [key: string]: any;
 }
 
+/**
+ * Custom loader icon template props.
+ * @group Misc
+ */
 interface VirtualScrollerLoaderIconTemplateOptions {
+    /**
+     * Style class of the loader icon.
+     */
     className: string;
+    /**
+     * The JSX element that represents the loader icon.
+     */
     element: JSX.Element;
+    /**
+     * The props of the VirtualScroller component.
+     */
     props: VirtualScrollerProps;
 }
 
+/**
+ * Custom content template options.
+ * @group Misc
+ */
 interface VirtualScrollerContentTemplateOptions {
+    /**
+     * Style class of the wrapper element.
+     */
     className: string;
+    /**
+     * Ref of wrapper element.
+     */
     contentRef: any;
+    /**
+     * Ref of spacer element.
+     */
     spacerRef: any;
+    /**
+     * Ref of sticky element in content.
+     */
     stickyRef: any;
-    items: VirtualScrollerItemsType;
+    /**
+     * Loaded data.
+     */
+    items: any[] | any[][] | undefined | null;
+    /**
+     * Information of any item.
+     * @param {number} index - Index of the template item.
+     */
     getItemOptions(index: number): VirtualScrollerTemplateOptions;
+    /**
+     * Items of wrapper element.
+     */
     children: any;
+    /**
+     * Default wrapper element.
+     */
     element: JSX.Element;
+    /**
+     * Props of VirtualScroller component.
+     */
     props: VirtualScrollerProps;
+    /**
+     * Whether the data is loaded.
+     */
     loading: boolean;
+    /**
+     * Information of any item during the loading.
+     * @param {number} index - Index of the item.
+     * @param {object} ext - The extra options to pass to the content.
+     */
     getLoaderOptions(index: number, ext?: object): VirtualScrollerLoadingTemplateOptions;
-    loadingTemplate: VirtualScrollerLoadingTemplateType;
-    itemSize: VirtualScrollerItemSizeType;
+    /**
+     * Template of loading item.
+     */
+    loadingTemplate: React.ReactNode | ((options: VirtualScrollerLoadingTemplateOptions) => React.ReactNode);
+    /**
+     * The height/width of item according to orientation.
+     */
+    itemSize: number | number[];
+    /**
+     * Rows of the virtual scroller.
+     */
     rows: any[];
+    /**
+     * Columns of the virtual scroller.
+     */
     columns: any[];
+    /**
+     * Whether the orientation is vertical.
+     */
     vertical: boolean;
+    /**
+     * Whether the orientation is horizontal.
+     */
     horizontal: boolean;
+    /**
+     * Whether the orientation is both.
+     */
     both: boolean;
 }
 
-interface VirtualScrollerChangeParams {
-    first: VirtualScrollerStateType;
-    last: VirtualScrollerStateType;
+/**
+ * Custom change event.
+ * @see {@link VirtualScrollerProps.onScrollIndexChange}
+ * @event
+ */
+interface VirtualScrollerChangeEvent {
+    /**
+     * First index of the new data range to be loaded.
+     */
+    first: number | VirtualScrollerState;
+    /**
+     * Last index of the new data range to be loaded.
+     */
+    last: number | VirtualScrollerState;
 }
 
-interface VirtualScrollerLazyParams extends VirtualScrollerChangeParams {}
+/**
+ * Custom lazy load event.
+ * @see {@link VirtualScrollerProps.onLazyLoad}
+ * @extends {VirtualScrollerChangeEvent}
+ * @event
+ */
+interface VirtualScrollerLazyEvent extends VirtualScrollerChangeEvent {}
 
+/**
+ * Defines valid properties in VirtualScroller component.
+ * @group Properties
+ */
 export interface VirtualScrollerProps {
-    id?: string;
-    style?: React.CSSProperties;
-    className?: string;
-    items?: VirtualScrollerItemsType;
-    itemSize?: VirtualScrollerItemSizeType;
-    scrollHeight?: string;
-    scrollWidth?: string;
-    orientation?: VirtualScrollerOrientationType;
-    numToleratedItems?: number;
-    delay?: number;
-    resizeDelay?: number;
-    lazy?: boolean;
-    disabled?: boolean;
-    loaderDisabled?: boolean;
-    columns?: any;
-    loading?: boolean;
-    autoSize?: boolean;
-    showSpacer?: boolean;
-    showLoader?: boolean;
-    loadingTemplate?: VirtualScrollerLoadingTemplateType;
-    loaderIconTemplate?: VirtualScrollerLoaderIconTemplateType;
-    itemTemplate?: VirtualScrollerItemTemplateType;
-    contentTemplate?: VirtualScrollerContentTemplateType;
-    onScroll?(e: React.UIEvent<HTMLElement>): void;
-    onScrollIndexChange?(e: VirtualScrollerChangeParams): void;
-    onLazyLoad?(e: VirtualScrollerLazyParams): void;
-    children?: React.ReactNode;
+    /**
+     * Unique identifier of the element.
+     */
+    id?: string | undefined;
+    /**
+     * Inline style of the component.
+     */
+    style?: React.CSSProperties | undefined;
+    /**
+     * Style class of the component.
+     */
+    className?: string | undefined;
+    /**
+     * An array of objects to display.
+     */
+    items?: any[] | any[][] | undefined | null;
+    /**
+     * The height/width of item according to orientation.
+     */
+    itemSize?: number | number[] | undefined;
+    /**
+     * Height of the scroll viewport.
+     */
+    scrollHeight?: string | undefined;
+    /**
+     * Width of the scroll viewport.
+     */
+    scrollWidth?: string | undefined;
+    /**
+     * The orientation of scrollbar, valid values are 'vertical', 'horizontal' and 'both'.
+     * @defaultValue 'vertical'
+     */
+    orientation?: 'vertical' | 'horizontal' | 'both' | undefined;
+    /**
+     * Determines how many additional elements to add to the DOM outside of the view. According to the scrolls made up and down, extra items are added in a certain algorithm in the form of multiples of this number. Default value is half the number of items shown in the view.
+     */
+    numToleratedItems?: number | undefined;
+    /**
+     * Delay in scroll before new data is loaded.
+     * @defaultValue 0
+     */
+    delay?: number | undefined;
+    /**
+     * Delay after window's resize finishes.
+     * @defaultValue 10
+     */
+    resizeDelay?: number | undefined;
+    /**
+     * Defines if data is loaded and interacted with in lazy manner.
+     * @defaultValue false
+     */
+    lazy?: boolean | undefined;
+    /**
+     * If disabled, the VirtualScroller feature is eliminated and the content is displayed directly.
+     * @defaultValue false
+     */
+    disabled?: boolean | undefined;
+    /**
+     * Used to implement a custom loader instead of using the loader feature in the VirtualScroller.
+     * @defaultValue false
+     */
+    loaderDisabled?: boolean | undefined;
+    /**
+     * Columns of the virtual scroller for vertical option.
+     */
+    columns?: any | undefined;
+    /**
+     * Whether the data is loaded.
+     * @defaultValue false
+     */
+    loading?: boolean | undefined;
+    /**
+     * Whether to dynamically change the height or width of scrollable container.
+     * @defaultValue false
+     */
+    autoSize?: boolean | undefined;
+    /**
+     * Used to implement a custom spacer instead of using the spacer feature in the VirtualScroller.
+     * @defaultValue true
+     */
+    showSpacer?: boolean | undefined;
+    /**
+     * Whether to show loader.
+     * @defaultValue false
+     */
+    showLoader?: boolean | undefined;
+    /**
+     * The template of loader.
+     */
+    loadingTemplate?: React.ReactNode | ((options: VirtualScrollerLoadingTemplateOptions) => React.ReactNode);
+    /**
+     * The template of loader's icon.
+     */
+    loaderIconTemplate?: React.ReactNode | ((options: VirtualScrollerLoaderIconTemplateOptions) => React.ReactNode);
+    /**
+     * The template of item.
+     */
+    itemTemplate?: React.ReactNode | ((item: any, options: VirtualScrollerTemplateOptions) => React.ReactNode);
+    /**
+     * The template of item's wrapper element.
+     */
+    contentTemplate?: React.ReactNode | ((options: VirtualScrollerContentTemplateOptions) => React.ReactNode);
+    /**
+     * Callback to invoke when scroll position changes.
+     * @param {React.UIEvent<HTMLElement>} event - Browser event
+     */
+    onScroll?(event: React.UIEvent<HTMLElement>): void;
+    /**
+     * Callback to invoke when scroll position and item's range in view changes.
+     * @param {VirtualScrollerChangeEvent} event - Custom change event
+     */
+    onScrollIndexChange?(event: VirtualScrollerChangeEvent): void;
+    /**
+     * Callback to invoke in lazy mode to load new data.
+     * @param {VirtualScrollerLazyEvent} event - Custom lazy load event.
+     */
+    onLazyLoad?(event: VirtualScrollerLazyEvent): void;
+    /**
+     * Used to get the child elements of the component.
+     * @readonly
+     */
+    children?: React.ReactNode | undefined;
 }
 
+/**
+ * **PrimeReact - VirtualScroller**
+ *
+ * _VirtualScroller is a performant approach to handle huge data efficiently._
+ *
+ * [Live Demo](https://www.primefaces.org/primereact/virtualscroller/)
+ * --- ---
+ * ![PrimeReact](https://www.primefaces.org/primereact/images/logo-100.png)
+ *
+ * @group Component
+ */
 export declare class VirtualScroller extends React.Component<VirtualScrollerProps, any> {
+    /**
+     * Returns the reference of virtualScroller's container.
+     * @return {React.Ref<HTMLDivElement>} Ref Div element
+     */
     public getElementRef(): React.Ref<HTMLDivElement>;
+    /**
+     * Scroll to move to a specific position.
+     * @param {VirtualScrollerOptionsType} options - Custom virtual scroller options.
+     */
     public scrollTo(options: VirtualScrollerOptionsType): void;
-    public scrollToIndex(index: VirtualScrollerToIndexType, behavior?: VirtualScrollerScrollBehavior): void;
-    public scrollInView(index: VirtualScrollerToIndexType, to: VirtualScrollerToType, behavior?: VirtualScrollerScrollBehavior): void;
+    /**
+     * Scroll to move to a specific item.
+     * @param {number} index - Index of item according to orientation mode.
+     * @param {'auto' | 'smooth'} behavior - Behavior of scroll, valid values are 'auto' and 'smooth'
+     */
+    public scrollToIndex(index: number | number[], behavior?: 'auto' | 'smooth'): void;
+    /**
+     * It is used to move the specified index into the view. It is a method that will usually be needed when keyboard support is added to the virtualScroller component.
+     * @param {number} index - Index of item according to orientation mode.
+     * @param {'to-start' | 'to-end'} to - Defines the location of the item in view, valid values are 'to-start' and 'to-end'.
+     * @param {'auto' | 'smooth'} behavior - Behavior of scroll, valid values are 'auto' and 'smooth'
+     */
+    public scrollInView(index: number | number[], to: 'to-start' | 'to-end', behavior?: 'auto' | 'smooth'): void;
+    /**
+     * Returns the range of items added to the DOM.
+     */
     public getRenderedRange(): VirtualScrollerRenderedRange;
 }