@mui/x-virtualizer 0.1.0 → 0.1.2

package/models/dimensions.d.ts

@@ -38,7 +38,7 @@ export interface DimensionsState {
    */
   scrollbarSize: number;
   /**
-   * Width of a row.
+   * Width of a row. At least as wide as `viewportOuterSize.width`.
    */
   rowWidth: number;
   /**
@@ -46,7 +46,7 @@ export interface DimensionsState {
    */
   rowHeight: number;
   /**
-   * Size of all the visible columns.
+   * Size of all the columns.
    */
   columnsTotalWidth: number;
   /**
@@ -57,22 +57,6 @@ export interface DimensionsState {
    * Size of right pinned columns.
    */
   rightPinnedWidth: number;
-  /**
-   * Height of one column header.
-   */
-  headerHeight: number;
-  /**
-   * Height of one column group header.
-   */
-  groupHeaderHeight: number;
-  /**
-   * Height of header filters.
-   */
-  headerFilterHeight: number;
-  /**
-   * Height of all the column headers.
-   */
-  headersTotalHeight: number;
   /**
    * Size of the top container.
    */
@@ -103,21 +87,6 @@ export interface RowsMetaState {
    */
   pinnedBottomRowsTotalHeight: number;
 }
-export interface RowVisibilityParams {
-  /**
-   * Whether this row is the first visible or not.
-   */
-  isFirstVisible: boolean;
-  /**
-   * Whether this row is the last visible or not.
-   */
-  isLastVisible: boolean;
-  /**
-   * Index of the row in the current page.
-   * If the pagination is disabled, it will be the index relative to all filtered rows.
-   */
-  indexRelativeToCurrentPage: number;
-}
 export interface RowSpacing {
   top?: number;
   bottom?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/x-virtualizer",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "author": "MUI Team",
   "description": "MUI virtualization library",
   "license": "MIT",
@@ -27,8 +27,9 @@
     "directory": "packages/x-virtualizer"
   },
   "dependencies": {
-    "@babel/runtime": "^7.27.4",
-    "@mui/x-internals": "8.9.2"
+    "@babel/runtime": "^7.28.2",
+    "@mui/utils": "^7.3.1",
+    "@mui/x-internals": "8.10.0"
   },
   "peerDependencies": {
     "react": "^17.0.0 || ^18.0.0 || ^19.0.0",
@@ -37,31 +38,41 @@
   "engines": {
     "node": ">=14.0.0"
   },
-  "private": false,
+  "type": "commonjs",
+  "main": "./index.js",
+  "types": "./index.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "import": {
+        "types": "./esm/index.d.ts",
+        "default": "./esm/index.js"
+      },
       "require": {
         "types": "./index.d.ts",
         "default": "./index.js"
-      },
+      }
+    },
+    "./useVirtualizer": {
       "import": {
-        "types": "./esm/index.d.ts",
-        "default": "./esm/index.js"
+        "types": "./esm/useVirtualizer.d.ts",
+        "default": "./esm/useVirtualizer.js"
+      },
+      "require": {
+        "types": "./useVirtualizer.d.ts",
+        "default": "./useVirtualizer.js"
       }
     },
     "./*": {
-      "require": {
-        "types": "./*/index.d.ts",
-        "default": "./*/index.js"
-      },
       "import": {
         "types": "./esm/*/index.d.ts",
         "default": "./esm/*/index.js"
+      },
+      "require": {
+        "types": "./*/index.d.ts",
+        "default": "./*/index.js"
       }
     },
-    "./esm": null,
-    "./modern": null
-  },
-  "types": "./index.d.ts"
+    "./esm": null
+  }
 }

package/useVirtualizer.d.ts

@@ -5,34 +5,32 @@ import { Colspan } from "./features/colspan.js";
 import { Dimensions } from "./features/dimensions.js";
 import { Rowspan } from "./features/rowspan.js";
 import { Virtualization } from "./features/virtualization.js";
-import type { RowId } from "./models/core.js";
-import type { HeightEntry, RowSpacing, RowVisibilityParams } from "./models/dimensions.js";
+import type { HeightEntry, RowSpacing } from "./models/dimensions.js";
+import type { ColspanParams } from "./features/colspan.js";
+import type { DimensionsParams } from "./features/dimensions.js";
+import type { VirtualizationParams } from "./features/virtualization.js";
 import { ColumnWithWidth, FocusedCell, Size, PinnedRows, PinnedColumns, RenderContext, Row, RowEntry } from "./models/index.js";
 export type Virtualizer = ReturnType<typeof useVirtualizer>;
 export type VirtualScrollerCompat = Virtualization.State['getters'];
 export type BaseState = Virtualization.State & Dimensions.State;
 export type VirtualizerParams = {
-  scrollbarSize?: number;
-  dimensions: {
-    rowHeight: number;
-    headerHeight: number;
-    groupHeaderHeight: number;
-    headerFilterHeight: number;
-    columnsTotalWidth: number;
-    headersTotalHeight: number;
-    leftPinnedWidth: number;
-    rightPinnedWidth: number;
+  refs: {
+    container: RefObject<HTMLDivElement | null>;
+    scroller: RefObject<HTMLDivElement | null>;
+    scrollbarVertical: RefObject<HTMLDivElement | null>;
+    scrollbarHorizontal: RefObject<HTMLDivElement | null>;
   };
+  dimensions: DimensionsParams;
+  virtualization: VirtualizationParams;
+  colspan?: ColspanParams;
   initialState?: {
     scroll?: {
       top: number;
       left: number;
     };
-    dimensions?: Partial<Dimensions.State['dimensions']>;
     rowSpanning?: Rowspan.State['rowSpanning'];
     virtualization?: Partial<Virtualization.State['virtualization']>;
   };
-  isRtl: boolean;
   /** current page rows */
   rows: RowEntry[];
   /** current page range */
@@ -40,21 +38,12 @@ export type VirtualizerParams = {
     firstRowIndex: integer;
     lastRowIndex: integer;
   } | null;
-  rowIdToIndexMap: Map<RowId, number>;
   rowCount: integer;
   columns: ColumnWithWidth[];
-  pinnedRows: PinnedRows;
-  pinnedColumns: PinnedColumns;
-  refs: {
-    container: RefObject<HTMLDivElement | null>;
-    scroller: RefObject<HTMLDivElement | null>;
-    scrollbarVertical: RefObject<HTMLDivElement | null>;
-    scrollbarHorizontal: RefObject<HTMLDivElement | null>;
-  };
-  hasColSpan: boolean;
-  contentHeight: number;
-  minimalContentHeight: number | string;
+  pinnedRows?: PinnedRows;
+  pinnedColumns?: PinnedColumns;
   autoHeight: boolean;
+  minimalContentHeight?: number | string;
   getRowHeight?: (row: RowEntry) => number | null | undefined | 'auto';
   /**
    * Function that returns the estimated height for a row.
@@ -67,10 +56,9 @@ export type VirtualizerParams = {
   /**
    * Function that allows to specify the spacing between rows.
    * @param rowEntry
-   * @param visibility With all properties from [[RowVisibilityParams]].
    * @returns The row spacing values.
    */
-  getRowSpacing?: (rowEntry: RowEntry, visibility: RowVisibilityParams) => RowSpacing;
+  getRowSpacing?: (rowEntry: RowEntry) => RowSpacing;
   /** Update the row height values before they're used.
    * Used to add detail panel heights.
    * @param entry
@@ -87,11 +75,8 @@ export type VirtualizerParams = {
     top: number;
     left: number;
   }, nextRenderContext: RenderContext) => void;
-  focusedVirtualCell: () => FocusedCell | null;
-  rowBufferPx: number;
-  columnBufferPx: number;
+  focusedVirtualCell?: () => FocusedCell | null;
   scrollReset?: any;
-  getColspan: (rowId: RowId, column: ColumnWithWidth, columnIndex: integer) => number;
   renderRow: (params: {
     id: any;
     model: Row;
@@ -99,7 +84,6 @@ export type VirtualizerParams = {
     offsetLeft: number;
     columnsTotalWidth: number;
     baseRowHeight: number | 'auto';
-    columns: ColumnWithWidth[];
     firstColumnIndex: number;
     lastColumnIndex: number;
     focusedColumnIndex: number | undefined;
@@ -116,29 +100,29 @@ export declare const useVirtualizer: (params: VirtualizerParams) => {
     updateDimensions: () => void;
     debouncedUpdateDimensions: ((() => void) & import("@mui/x-internals/throttle/throttle").Cancelable) | undefined;
     rowsMeta: {
-      getRowHeight: (rowId: RowId) => any;
+      getRowHeight: (rowId: import("./models/index.js").RowId) => any;
       setLastMeasuredRowIndex: (index: number) => void;
-      storeRowHeightMeasurement: (id: RowId, height: number) => void;
+      storeRowHeightMeasurement: (id: import("./models/index.js").RowId, height: number) => void;
       hydrateRowsMeta: () => void;
-      observeRowHeight: (element: Element, rowId: RowId) => () => void | undefined;
-      rowHasAutoHeight: (id: RowId) => any;
-      getRowHeightEntry: (rowId: RowId) => any;
+      observeRowHeight: (element: Element, rowId: import("./models/index.js").RowId) => () => void | undefined;
+      rowHasAutoHeight: (id: import("./models/index.js").RowId) => any;
+      getRowHeightEntry: (rowId: import("./models/index.js").RowId) => any;
       getLastMeasuredRowIndex: () => number;
       resetRowHeights: () => void;
     };
   } & {
     getters: {
       setPanels: React.Dispatch<React.SetStateAction<Readonly<Map<any, React.ReactNode>>>>;
-      getRows: (rowParams: {
+      getRows: (rowParams?: {
         rows?: RowEntry[];
         position?: import("./models/index.js").PinnedRowPosition;
         renderContext?: RenderContext;
-      } | undefined, unstable_rowTree: Record<RowId, any>) => React.ReactNode[];
+      }, unstable_rowTree?: Record<import("./models/index.js").RowId, any>) => React.ReactNode[];
       getContainerProps: () => {
-        ref: React.RefObject<HTMLDivElement | null>;
+        ref: (node: HTMLDivElement | null) => void;
       };
       getScrollerProps: () => {
-        ref: React.RefObject<HTMLDivElement | null>;
+        ref: (node: HTMLDivElement | null) => void;
         onScroll: () => void;
         onWheel: ((event: React.WheelEvent) => void) | undefined;
         onTouchMove: ((event: React.TouchEvent) => void) | undefined;
@@ -147,22 +131,19 @@ export declare const useVirtualizer: (params: VirtualizerParams) => {
         tabIndex: number | undefined;
       };
       getContentProps: () => {
-        style: React.CSSProperties;
-        role: string;
         ref: (node: HTMLDivElement | null) => void;
-      };
-      getRenderZoneProps: () => {
+        style: React.CSSProperties;
         role: string;
       };
       getScrollbarVerticalProps: () => {
-        ref: React.RefObject<HTMLDivElement | null>;
+        ref: (node: HTMLDivElement | null) => void;
         scrollPosition: React.RefObject<{
           top: number;
           left: number;
         }>;
       };
       getScrollbarHorizontalProps: () => {
-        ref: React.RefObject<HTMLDivElement | null>;
+        ref: (node: HTMLDivElement | null) => void;
         scrollPosition: React.RefObject<{
           top: number;
           left: number;
@@ -178,13 +159,13 @@ export declare const useVirtualizer: (params: VirtualizerParams) => {
     useVirtualization: () => BaseState;
     setPanels: React.Dispatch<React.SetStateAction<Readonly<Map<any, React.ReactNode>>>>;
     forceUpdateRenderContext: () => void;
-    getCellColSpanInfo: (rowId: RowId, columnIndex: integer) => import("./models/index.js").CellColSpanInfo;
-    calculateColSpan: (rowId: RowId, minFirstColumn: integer, maxLastColumn: integer, columns: ColumnWithWidth[]) => void;
-    getHiddenCellsOrigin: () => Record<RowId, Record<number, number>>;
+    getCellColSpanInfo: (rowId: import("./models/index.js").RowId, columnIndex: integer) => import("./models/index.js").CellColSpanInfo;
+    calculateColSpan: (rowId: import("./models/index.js").RowId, minFirstColumn: integer, maxLastColumn: integer, columns: ColumnWithWidth[]) => void;
+    getHiddenCellsOrigin: () => Record<import("./models/index.js").RowId, Record<number, number>>;
   } & {
     resetColSpan: () => void;
-    getCellColSpanInfo: (rowId: RowId, columnIndex: integer) => import("./models/index.js").CellColSpanInfo | undefined;
-    calculateColSpan: (rowId: RowId, minFirstColumn: integer, maxLastColumn: integer, columns: ColumnWithWidth[]) => void;
+    getCellColSpanInfo: (rowId: import("./models/index.js").RowId, columnIndex: integer) => import("./models/index.js").CellColSpanInfo | undefined;
+    calculateColSpan: (rowId: import("./models/index.js").RowId, minFirstColumn: integer, maxLastColumn: integer, columns: ColumnWithWidth[]) => void;
   } & {
     getHiddenCellsOrigin: () => Record<number, Record<number, number>>;
   } & {