@versini/ui-datagrid 3.1.2 → 4.0.0

package/dist/DataGridInfinite/DataGridInfiniteBody.d.ts

@@ -1,11 +1,11 @@
 export type DataGridInfiniteBodyProps<T> = ({
     /**
-     * If true, displays an empty state instead of infinite scroll content. When
-     * noData is true, data, children, and scroll-related props are optional.
+     * If true, displays an empty state instead of the grid rows. When noData
+     * is true, data and children are optional.
      */
     noData: true;
     /**
-     * The full dataset to render progressively.
+     * The full dataset to virtualize.
      */
     data?: T[];
     /**
@@ -20,12 +20,12 @@ export type DataGridInfiniteBodyProps<T> = ({
     noDataText?: string;
 } | {
     /**
-     * If true, displays an empty state instead of infinite scroll content.
+     * If true, displays an empty state instead of the grid rows.
      * @default false
      */
     noData?: false;
     /**
-     * The full dataset to render progressively.
+     * The full dataset to virtualize.
      */
     data: T[];
     /**
@@ -37,23 +37,20 @@ export type DataGridInfiniteBodyProps<T> = ({
     noDataText?: never;
 }) & {
     /**
-     * Number of items to show initially and to add on each scroll.
-     * @default 20
+     * Rows rendered beyond the viewport on each side.
+     * @default 8
      */
-    batchSize?: number;
+    overscan?: number;
     /**
-     * How many items to keep below the marker for seamless scrolling. The marker
-     * is placed `threshold` items before the end of visible items.
-     * @default 5
+     * Initial row-height estimate (px) used before rows are measured. Real heights
+     * are always measured from the DOM; a value near the average row height
+     * minimizes scrollbar drift and improves scrollToIndex accuracy. Defaults to
+     * the grid's density: 44 normally, 29 when the DataGrid is `compact`.
      */
-    threshold?: number;
+    estimatedRowHeight?: number;
     /**
-     * IntersectionObserver root margin.
-     * @default "20px"
-     */
-    rootMargin?: string;
-    /**
-     * Callback when visible count changes. Useful for displaying count in header.
+     * Callback reporting a monotonic high-water mark: the furthest row index
+     * scrolled into view, plus one. Useful for a "showing N of M" caption.
      */
     onVisibleCountChange?: (visibleCount: number, totalItems: number) => void;
     /**
@@ -66,48 +63,40 @@ export type DataGridInfiniteBodyProps<T> = ({
  */
 export type DataGridInfiniteBodyRef = {
     /**
-     * Scroll to a specific row index with smooth animation. If the row is not yet
-     * visible, it will expand the visible count first.
+     * Scroll a row into view (centered). Works for any index, mounted or not.
      * @param index - The index of the row to scroll to
      */
     scrollToIndex: (index: number) => void;
 };
 /**
- * A DataGridBody variant that handles infinite scroll internally.
+ * A virtualized DataGrid body for large datasets.
+ *
+ * Only the rows near the viewport stay mounted (windowing via
+ * `@tanstack/react-virtual`), so the DOM stays small and scrolling stays smooth
+ * at any row count. Rows are rendered in normal grid flow between two full-span
+ * spacer elements, so `columns`/subgrid (including intrinsic `auto` tracks) keep
+ * working without any consumer change. The virtualizer windows against the
+ * DataGrid's own scroll container (created by `maxHeight` or a sticky
+ * header/footer), or the page (window scroll) when the grid has neither.
  *
- * This component manages all the complexity of infinite scroll:
- * - Progressive data loading with IntersectionObserver
- * - Correct marker placement for seamless scrolling
- * - Automatic data slicing and memoization
- * - Programmatic scroll-to-row with smooth animation
+ * Because off-screen rows are removed from the DOM, the grid exposes
+ * `aria-rowcount`/`aria-rowindex` and keeps keyboard focus on the grid if a
+ * focused row recycles out. Browser find-in-page and uncontrolled per-row state
+ * do not persist across recycling (inherent to DOM virtualization).
  *
  * @example
  * ```tsx
- * const infiniteBodyRef = useRef<DataGridInfiniteBodyRef>(null);
- *
- * // Jump to a specific row
- * const handleJumpToRow = () => {
- *   infiniteBodyRef.current?.scrollToIndex(134);
- * };
- *
  * <DataGrid maxHeight="400px" stickyHeader>
- *   <DataGridHeader caption={`Showing ${visibleCount} of ${data.length}`}>
+ *   <DataGridHeader caption={`Showing ${reached} of ${data.length}`}>
  *     <DataGridRow>
  *       <DataGridCell>Name</DataGridCell>
- *       <DataGridCell>Role</DataGridCell>
  *     </DataGridRow>
  *   </DataGridHeader>
  *
- *   <DataGridInfiniteBody
- *     ref={infiniteBodyRef}
- *     data={largeData}
- *     batchSize={25}
- *     onVisibleCountChange={(count) => setVisibleCount(count)}
- *   >
+ *   <DataGridInfiniteBody data={largeData} estimatedRowHeight={56}>
  *     {(row) => (
  *       <DataGridRow key={row.id}>
  *         <DataGridCell>{row.name}</DataGridCell>
- *         <DataGridCell>{row.role}</DataGridCell>
  *       </DataGridRow>
  *     )}
  *   </DataGridInfiniteBody>
@@ -115,6 +104,6 @@ export type DataGridInfiniteBodyRef = {
  * ```
  *
  */
-export declare function DataGridInfiniteBody<T>({ data, children: renderRow, batchSize, threshold, rootMargin, onVisibleCountChange, className, noData, noDataText, ref, }: DataGridInfiniteBodyProps<T> & {
+export declare function DataGridInfiniteBody<T>({ data, children: renderRow, overscan, estimatedRowHeight, onVisibleCountChange, className, noData, noDataText, ref, }: DataGridInfiniteBodyProps<T> & {
     ref?: React.Ref<DataGridInfiniteBodyRef>;
 }): import("react").JSX.Element;