react-window 2.2.2 → 2.2.4

package/dist/react-window.d.ts

@@ -35,28 +35,70 @@ declare type ForbiddenKeys_2 = "ariaAttributes" | "index" | "style";
 
 export declare function getScrollbarSize(recalculate?: boolean): number;
 
+/**
+ * Renders data with many rows and columns.
+ */
 export declare function Grid<CellProps extends object, TagName extends TagNames = "div">({ cellComponent: CellComponentProp, cellProps: cellPropsUnstable, children, className, columnCount, columnWidth, defaultHeight, defaultWidth, dir, gridRef, onCellsRendered, onResize, overscanCount, rowCount, rowHeight, style, tagName, ...rest }: GridProps<CellProps, TagName>): ReactElement;
 
-export declare type GridImperativeAPI = {
+/**
+ * Ref used to interact with this component's imperative API.
+ *
+ * This API has imperative methods for scrolling and a getter for the outermost DOM element.
+ *
+ * ℹ️ The `useGridRef` and `useGridCallbackRef` hooks are exported for convenience use in TypeScript projects.
+ */
+export declare interface GridImperativeAPI {
+    /**
+     * Outermost HTML element for the grid if mounted and null (if not mounted.
+     */
     get element(): HTMLDivElement | null;
-    scrollToCell({ behavior, columnAlign, columnIndex, rowAlign, rowIndex }: {
+    /**
+     * Scrolls the grid so that the specified row and column are visible.
+     *
+     * @param behavior Determines whether scrolling is instant or animates smoothly
+     * @param columnAlign Determines the horizontal alignment of the element within the list
+     * @param columnIndex Index of the column to scroll to (0-based)
+     * @param rowAlign Determines the vertical alignment of the element within the list
+     * @param rowIndex Index of the row to scroll to (0-based)
+     *
+     * @throws RangeError if an invalid row or column index is provided
+     */
+    scrollToCell: ({ behavior, columnAlign, columnIndex, rowAlign, rowIndex }: {
         behavior?: "auto" | "instant" | "smooth";
         columnAlign?: "auto" | "center" | "end" | "smart" | "start";
         columnIndex: number;
         rowAlign?: "auto" | "center" | "end" | "smart" | "start";
         rowIndex: number;
-    }): void;
-    scrollToColumn({ align, behavior, index }: {
+    }) => void;
+    /**
+     * Scrolls the grid so that the specified column is visible.
+     *
+     * @param align Determines the horizontal alignment of the element within the list
+     * @param behavior Determines whether scrolling is instant or animates smoothly
+     * @param index Index of the column to scroll to (0-based)
+     *
+     * @throws RangeError if an invalid column index is provided
+     */
+    scrollToColumn: ({ align, behavior, index }: {
         align?: "auto" | "center" | "end" | "smart" | "start";
         behavior?: "auto" | "instant" | "smooth";
         index: number;
-    }): void;
-    scrollToRow({ align, behavior, index }: {
+    }) => void;
+    /**
+     * Scrolls the grid so that the specified row is visible.
+     *
+     * @param align Determines the vertical alignment of the element within the list
+     * @param behavior Determines whether scrolling is instant or animates smoothly
+     * @param index Index of the row to scroll to (0-based)
+     *
+     * @throws RangeError if an invalid row index is provided
+     */
+    scrollToRow: ({ align, behavior, index }: {
         align?: "auto" | "center" | "end" | "smart" | "start";
         behavior?: "auto" | "instant" | "smooth";
         index: number;
-    }): void;
-};
+    }) => void;
+}
 
 export declare type GridProps<CellProps extends object, TagName extends TagNames = "div"> = Omit<HTMLAttributes<HTMLDivElement>, "onResize"> & {
     /**
@@ -114,19 +156,32 @@ export declare type GridProps<CellProps extends object, TagName extends TagNames
      */
     defaultWidth?: number;
     /**
-     * Corresponds to the HTML dir attribute:
-     * https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/dir
+     * Indicates the directionality of grid cells.
+     *
+     * ℹ️ See HTML `dir` [global attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/dir) for more information.
      */
     dir?: "ltr" | "rtl";
     /**
-     * Ref used to interact with this component's imperative API.
-     *
-     * This API has imperative methods for scrolling and a getter for the outermost DOM element.
+     * Imperative Grid API.
      *
      * ℹ️ The `useGridRef` and `useGridCallbackRef` hooks are exported for convenience use in TypeScript projects.
      */
     gridRef?: Ref<{
+        /**
+         * Outermost HTML element for the grid if mounted and null (if not mounted.
+         */
         get element(): HTMLDivElement | null;
+        /**
+         * Scrolls the grid so that the specified row and column are visible.
+         *
+         * @param behavior Determines whether scrolling is instant or animates smoothly
+         * @param columnAlign Determines the horizontal alignment of the element within the list
+         * @param columnIndex Index of the column to scroll to (0-based)
+         * @param rowAlign Determines the vertical alignment of the element within the list
+         * @param rowIndex Index of the row to scroll to (0-based)
+         *
+         * @throws RangeError if an invalid row or column index is provided
+         */
         scrollToCell(config: {
             behavior?: "auto" | "instant" | "smooth";
             columnAlign?: "auto" | "center" | "end" | "smart" | "start";
@@ -134,11 +189,29 @@ export declare type GridProps<CellProps extends object, TagName extends TagNames
             rowAlign?: "auto" | "center" | "end" | "smart" | "start";
             rowIndex: number;
         }): void;
+        /**
+         * Scrolls the grid so that the specified column is visible.
+         *
+         * @param align Determines the horizontal alignment of the element within the list
+         * @param behavior Determines whether scrolling is instant or animates smoothly
+         * @param index Index of the column to scroll to (0-based)
+         *
+         * @throws RangeError if an invalid column index is provided
+         */
         scrollToColumn(config: {
             align?: "auto" | "center" | "end" | "smart" | "start";
             behavior?: "auto" | "instant" | "smooth";
             index: number;
         }): void;
+        /**
+         * Scrolls the grid so that the specified row is visible.
+         *
+         * @param align Determines the vertical alignment of the element within the list
+         * @param behavior Determines whether scrolling is instant or animates smoothly
+         * @param index Index of the row to scroll to (0-based)
+         *
+         * @throws RangeError if an invalid row index is provided
+         */
         scrollToRow(config: {
             align?: "auto" | "center" | "end" | "smart" | "start";
             behavior?: "auto" | "instant" | "smooth";
@@ -200,16 +273,36 @@ export declare type GridProps<CellProps extends object, TagName extends TagNames
     tagName?: TagName;
 };
 
+/**
+ * Renders data with many rows.
+ */
 export declare function List<RowProps extends object, TagName extends TagNames = "div">({ children, className, defaultHeight, listRef, onResize, onRowsRendered, overscanCount, rowComponent: RowComponentProp, rowCount, rowHeight: rowHeightProp, rowProps: rowPropsUnstable, tagName, style, ...rest }: ListProps<RowProps, TagName>): ReactElement;
 
-export declare type ListImperativeAPI = {
+/**
+ * Imperative List API.
+ *
+ * ℹ️ The `useListRef` and `useListCallbackRef` hooks are exported for convenience use in TypeScript projects.
+ */
+export declare interface ListImperativeAPI {
+    /**
+     * Outermost HTML element for the list if mounted and null (if not mounted.
+     */
     get element(): HTMLDivElement | null;
-    scrollToRow({ align, behavior, index }: {
+    /**
+     * Scrolls the list so that the specified row is visible.
+     *
+     * @param align Determines the vertical alignment of the element within the list
+     * @param behavior Determines whether scrolling is instant or animates smoothly
+     * @param index Index of the row to scroll to (0-based)
+     *
+     * @throws RangeError if an invalid row index is provided
+     */
+    scrollToRow: ({ align, behavior, index }: {
         align?: "auto" | "center" | "end" | "smart" | "start";
         behavior?: "auto" | "instant" | "smooth";
         index: number;
-    }): void;
-};
+    }) => void;
+}
 
 export declare type ListProps<RowProps extends object, TagName extends TagNames = "div"> = Omit<HTMLAttributes<HTMLDivElement>, "onResize"> & {
     /**
@@ -234,7 +327,19 @@ export declare type ListProps<RowProps extends object, TagName extends TagNames
      * ℹ️ The `useListRef` and `useListCallbackRef` hooks are exported for convenience use in TypeScript projects.
      */
     listRef?: Ref<{
+        /**
+         * Outermost HTML element for the list if mounted and null (if not mounted.
+         */
         get element(): HTMLDivElement | null;
+        /**
+         * Scrolls the list so that the specified row is visible.
+         *
+         * @param align Determines the vertical alignment of the element within the list
+         * @param behavior Determines whether scrolling is instant or animates smoothly
+         * @param index Index of the row to scroll to (0-based)
+         *
+         * @throws RangeError if an invalid row index is provided
+         */
         scrollToRow(config: {
             align?: "auto" | "center" | "end" | "smart" | "start";
             behavior?: "auto" | "instant" | "smooth";