primereact 8.7.3 → 9.0.0-beta.1

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;
 }

package/web-types.json

@@ -1,7 +1,7 @@
 {
     "framework": "React",
     "name": "PrimeReact",
-    "version": "8.7.3",
+    "version": "9.0.0-beta-1",
     "tags": [
         {
             "name": "Accordion",
@@ -172,7 +172,7 @@
                 "module": "PrimeReact",
                 "symbol": "AutoComplete"
             },
-            "description": "AutoComplete is an input component that provides real-time suggestions when being typed.",
+            "description": "AutoComplete is an input component that provides real-time suggestions while being typed.",
             "doc-url": "https://primefaces.org/primereact/showcase/#/autocomplete",
             "props": [
                 {
@@ -12102,13 +12102,31 @@
                     "name": "left",
                     "type": "any",
                     "default": "null",
-                    "description": "The template of left element."
+                    "description": "The template of left section."
                 },
                 {
                     "name": "right",
                     "type": "any",
                     "default": "null",
-                    "description": "The template of right element"
+                    "description": "The template of right section"
+                },
+                {
+                    "name": "start",
+                    "type": "any",
+                    "default": "null",
+                    "description": "The template of start section."
+                },
+                {
+                    "name": "center",
+                    "type": "any",
+                    "default": "null",
+                    "description": "The template of center section."
+                },
+                {
+                    "name": "end",
+                    "type": "any",
+                    "default": "null",
+                    "description": "The template of end section."
                 }
             ],
             "events": []