@mui/x-virtualizer 0.2.10 → 0.2.11

package/index.js

@@ -1,5 +1,5 @@
 /**
- * @mui/x-virtualizer v0.2.10
+ * @mui/x-virtualizer v0.2.11
  *
  * @license MIT
  * This source code is licensed under the MIT license found in the
@@ -31,4 +31,15 @@ Object.keys(_features).forEach(function (key) {
       return _features[key];
     }
   });
+});
+var _constants = require("./constants");
+Object.keys(_constants).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _constants[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _constants[key];
+    }
+  });
 });

package/models/core.d.ts

@@ -62,6 +62,13 @@ export type ScrollPosition = {
   top: number;
   left: number;
 };
+export declare const ScrollPosition: {
+  EMPTY: {
+    top: number;
+    left: number;
+  };
+  equals: (a: ScrollPosition, b: ScrollPosition) => boolean;
+};
 export declare enum ScrollDirection {
   NONE = 0,
   UP = 1,

package/models/core.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.Size = exports.ScrollDirection = exports.PinnedRows = exports.PinnedColumns = void 0;
+exports.Size = exports.ScrollPosition = exports.ScrollDirection = exports.PinnedRows = exports.PinnedColumns = void 0;
 /* eslint-disable @typescript-eslint/no-redeclare */
 
 const Size = exports.Size = {
@@ -28,6 +28,13 @@ const PinnedColumns = exports.PinnedColumns = {
     right: []
   }
 };
+const ScrollPosition = exports.ScrollPosition = {
+  EMPTY: {
+    top: 0,
+    left: 0
+  },
+  equals: (a, b) => a.top === b.top && a.left === b.left
+};
 let ScrollDirection = exports.ScrollDirection = /*#__PURE__*/function (ScrollDirection) {
   ScrollDirection[ScrollDirection["NONE"] = 0] = "NONE";
   ScrollDirection[ScrollDirection["UP"] = 1] = "UP";

package/models/dimensions.d.ts

@@ -65,6 +65,14 @@ export interface DimensionsState {
    * Size of the bottom container.
    */
   bottomContainerHeight: number;
+  /**
+   * Indicates that the container takes the height of its content.
+   */
+  autoHeight: boolean;
+  /**
+   * Minimal height to display the content area.
+   */
+  minimalContentHeight: string | number | undefined;
 }
 /**
  * The rows total height and positions.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/x-virtualizer",
-  "version": "0.2.10",
+  "version": "0.2.11",
   "author": "MUI Team",
   "description": "MUI virtualization library",
   "license": "MIT",
@@ -29,7 +29,7 @@
   "dependencies": {
     "@babel/runtime": "^7.28.4",
     "@mui/utils": "^7.3.5",
-    "@mui/x-internals": "8.19.0"
+    "@mui/x-internals": "8.21.0"
   },
   "peerDependencies": {
     "react": "^17.0.0 || ^18.0.0 || ^19.0.0",

package/useVirtualizer.d.ts

@@ -1,25 +1,21 @@
 import * as React from 'react';
-import { integer, RefObject } from '@mui/x-internals/types';
+import { integer } from '@mui/x-internals/types';
 import { Store } from '@mui/x-internals/store';
 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 { Virtualization } from "./features/virtualization/index.js";
+import type { Layout } from "./features/virtualization/layout.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 type { VirtualizationParams } from "./features/virtualization/index.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 = {
-  refs: {
-    container: RefObject<HTMLDivElement | null>;
-    scroller: RefObject<HTMLDivElement | null>;
-    scrollbarVertical: RefObject<HTMLDivElement | null>;
-    scrollbarHorizontal: RefObject<HTMLDivElement | null>;
-  };
+export type VirtualScrollerCompat<L extends Layout = Layout> = Virtualization.State<L>['getters'];
+export type BaseState<L extends Layout = Layout> = Virtualization.State<L> & Dimensions.State;
+export type VirtualizerParams<L extends Layout = Layout> = {
+  layout: L;
   dimensions: DimensionsParams;
   virtualization: VirtualizationParams;
   colspan?: ColspanParams;
@@ -29,7 +25,7 @@ export type VirtualizerParams = {
       left: number;
     };
     rowSpanning?: Rowspan.State['rowSpanning'];
-    virtualization?: Partial<Virtualization.State['virtualization']>;
+    virtualization?: Partial<Virtualization.State<L>['virtualization']>;
   };
   /** current page rows */
   rows: RowEntry[];
@@ -39,13 +35,11 @@ export type VirtualizerParams = {
     lastRowIndex: integer;
   } | null;
   rowCount: integer;
-  columns: ColumnWithWidth[];
+  columns?: ColumnWithWidth[];
   pinnedRows?: PinnedRows;
   pinnedColumns?: PinnedColumns;
-  autoHeight: boolean;
   disableHorizontalScroll?: boolean;
   disableVerticalScroll?: boolean;
-  minimalContentHeight?: number | string;
   getRowHeight?: (row: RowEntry) => number | null | undefined | 'auto';
   /**
    * Function that returns the estimated height for a row.
@@ -68,7 +62,7 @@ export type VirtualizerParams = {
    */
   applyRowHeight?: (entry: HeightEntry, rowEntry: RowEntry) => void;
   virtualizeColumnsWithAutoRowHeight?: boolean;
-  resizeThrottleMs: number;
+  resizeThrottleMs?: number;
   onResize?: (lastSize: Size) => void;
   onWheel?: (event: React.WheelEvent) => void;
   onTouchMove?: (event: React.TouchEvent) => void;
@@ -94,10 +88,15 @@ export type VirtualizerParams = {
     isVirtualFocusRow: boolean;
     showBottomBorder: boolean;
   }) => React.ReactElement;
-  renderInfiniteLoadingTrigger: (id: any) => React.ReactElement;
+  renderInfiniteLoadingTrigger?: (id: any) => React.ReactElement;
+};
+type RequiredFields<T, K extends keyof T> = T & Required<Pick<T, K>>;
+export type ParamsWithDefaults = RequiredFields<VirtualizerParams, 'resizeThrottleMs' | 'columns'> & {
+  dimensions: RequiredFields<VirtualizerParams['dimensions'], 'columnsTotalWidth' | 'leftPinnedWidth' | 'rightPinnedWidth' | 'topPinnedHeight' | 'bottomPinnedHeight' | 'autoHeight'>;
+  virtualization: RequiredFields<VirtualizerParams['virtualization'], 'isRtl' | 'rowBufferPx' | 'columnBufferPx'>;
 };
-export declare const useVirtualizer: (params: VirtualizerParams) => {
-  store: Store<Dimensions.State & Virtualization.State & Colspan.State & Rowspan.State>;
+export declare const useVirtualizer: <L extends Layout = Layout>(params: VirtualizerParams<L>) => {
+  store: Store<Dimensions.State & Virtualization.State<L> & Colspan.State & Rowspan.State>;
   api: {
     updateDimensions: (firstUpdate?: boolean) => void;
     debouncedUpdateDimensions: (((firstUpdate?: boolean) => void) & import("@mui/x-internals/throttle").Cancelable) | undefined;
@@ -113,57 +112,13 @@ export declare const useVirtualizer: (params: VirtualizerParams) => {
       resetRowHeights: () => void;
     };
   } & {
-    getters: {
-      setPanels: React.Dispatch<React.SetStateAction<Readonly<Map<any, React.ReactNode>>>>;
-      getOffsetTop: () => number;
-      getRows: (rowParams?: {
-        rows?: RowEntry[];
-        position?: import("./models/index.js").PinnedRowPosition;
-        renderContext?: RenderContext;
-      }, unstable_rowTree?: Record<import("./models/index.js").RowId, any>) => React.ReactNode[];
-      rows: RowEntry[];
-      getContainerProps: () => {
-        ref: (node: HTMLDivElement | null) => (() => void | undefined) | undefined;
-      };
-      getScrollerProps: () => {
-        ref: (node: HTMLDivElement | null) => (() => void | undefined) | undefined;
-        style: React.CSSProperties;
-        role: string;
-        tabIndex: number | undefined;
-      };
-      getContentProps: () => {
-        ref: (node: HTMLDivElement | null) => void;
-        style: React.CSSProperties;
-        role: string;
-      };
-      getScrollbarVerticalProps: () => {
-        ref: (node: HTMLDivElement | null) => void;
-        scrollPosition: React.RefObject<{
-          top: number;
-          left: number;
-        }>;
-      };
-      getScrollbarHorizontalProps: () => {
-        ref: (node: HTMLDivElement | null) => void;
-        scrollPosition: React.RefObject<{
-          top: number;
-          left: number;
-        }>;
-      };
-      getScrollAreaProps: () => {
-        scrollPosition: React.RefObject<{
-          top: number;
-          left: number;
-        }>;
-      };
-    };
-    useVirtualization: () => BaseState;
-    setPanels: React.Dispatch<React.SetStateAction<Readonly<Map<any, React.ReactNode>>>>;
-    forceUpdateRenderContext: () => void;
-    scheduleUpdateRenderContext: () => void;
     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>>;
+    getters: any;
+    setPanels: React.Dispatch<React.SetStateAction<Readonly<Map<any, React.ReactNode>>>>;
+    forceUpdateRenderContext: () => void;
+    scheduleUpdateRenderContext: () => void;
   } & {
     resetColSpan: () => void;
     getCellColSpanInfo: (rowId: import("./models/index.js").RowId, columnIndex: integer) => import("./models/index.js").CellColSpanInfo | undefined;
@@ -173,4 +128,5 @@ export declare const useVirtualizer: (params: VirtualizerParams) => {
   } & {
     getViewportPageSize: () => number;
   };
-};
+};
+export {};

package/useVirtualizer.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.useVirtualizer = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
 var _useLazyRef = _interopRequireDefault(require("@mui/utils/useLazyRef"));
 var _store = require("@mui/x-internals/store");
 var _colspan = require("./features/colspan");
@@ -12,22 +13,38 @@ var _dimensions = require("./features/dimensions");
 var _keyboard = require("./features/keyboard");
 var _rowspan = require("./features/rowspan");
 var _virtualization = require("./features/virtualization");
+var _constants = require("./constants");
 /* eslint-disable jsdoc/require-param-type */
 /* eslint-disable jsdoc/require-param-description */
 /* eslint-disable jsdoc/require-returns-type */
 
 const FEATURES = [_dimensions.Dimensions, _virtualization.Virtualization, _colspan.Colspan, _rowspan.Rowspan, _keyboard.Keyboard];
 const useVirtualizer = params => {
+  const paramsWithDefault = mergeDefaults(params, _constants.DEFAULT_PARAMS);
   const store = (0, _useLazyRef.default)(() => {
-    return new _store.Store(FEATURES.map(f => f.initialize(params)).reduce((state, partial) => Object.assign(state, partial), {}));
+    return new _store.Store(FEATURES.map(f => f.initialize(paramsWithDefault)).reduce((state, partial) => Object.assign(state, partial), {}));
   }).current;
   const api = {};
   for (const feature of FEATURES) {
-    Object.assign(api, feature.use(store, params, api));
+    Object.assign(api, feature.use(store, paramsWithDefault, api));
   }
   return {
     store,
     api
   };
 };
-exports.useVirtualizer = useVirtualizer;
+exports.useVirtualizer = useVirtualizer;
+function mergeDefaults(params, defaults) {
+  const result = (0, _extends2.default)({}, params);
+  for (const key in defaults) {
+    if (Object.hasOwn(defaults, key)) {
+      const value = defaults[key];
+      if (value !== null && typeof value === 'object' && !Array.isArray(value)) {
+        result[key] = mergeDefaults(params[key] ?? {}, value);
+      } else {
+        result[key] = params[key] ?? value;
+      }
+    }
+  }
+  return result;
+}