@mui/x-data-grid 8.9.1 → 8.9.2

package/esm/components/virtualization/GridVirtualScroller.js

@@ -3,12 +3,12 @@ import * as React from 'react';
 import { styled } from '@mui/system';
 import composeClasses from '@mui/utils/composeClasses';
 import { gridHasBottomFillerSelector, gridHasScrollXSelector, gridHasScrollYSelector } from "../../hooks/features/dimensions/gridDimensionsSelectors.js";
+import { gridRowTreeSelector } from "../../hooks/features/rows/index.js";
 import { GridScrollArea } from "../GridScrollArea.js";
 import { useGridRootProps } from "../../hooks/utils/useGridRootProps.js";
-import { useGridApiContext } from "../../hooks/utils/useGridApiContext.js";
+import { useGridPrivateApiContext } from "../../hooks/utils/useGridPrivateApiContext.js";
 import { useGridSelector } from "../../hooks/utils/useGridSelector.js";
 import { getDataGridUtilityClass } from "../../constants/gridClasses.js";
-import { useGridVirtualScroller } from "../../hooks/features/virtualization/useGridVirtualScroller.js";
 import { useGridOverlays } from "../../hooks/features/overlays/useGridOverlays.js";
 import { GridHeaders } from "../GridHeaders.js";
 import { GridMainContainer as Container } from "./GridMainContainer.js";
@@ -61,7 +61,7 @@ const Scroller = styled('div', {
 });
 const hasPinnedRightSelector = apiRef => apiRef.current.state.dimensions.rightPinnedWidth > 0;
 function GridVirtualScroller(props) {
-  const apiRef = useGridApiContext();
+  const apiRef = useGridPrivateApiContext();
   const rootProps = useGridRootProps();
   const hasScrollY = useGridSelector(apiRef, gridHasScrollYSelector);
   const hasScrollX = useGridSelector(apiRef, gridHasScrollXSelector);
@@ -77,7 +77,7 @@ function GridVirtualScroller(props) {
     hasPinnedRight
   }, overlaysProps);
   const classes = useUtilityClasses(ownerState);
-  const virtualScroller = useGridVirtualScroller();
+  const virtualScroller = apiRef.current.virtualizer.api.useVirtualization().getters;
   const {
     getContainerProps,
     getScrollerProps,
@@ -88,7 +88,7 @@ function GridVirtualScroller(props) {
     getRows,
     getScrollAreaProps
   } = virtualScroller;
-  const rows = getRows();
+  const rows = getRows(undefined, gridRowTreeSelector(apiRef));
   return /*#__PURE__*/_jsxs(Container, _extends({
     className: classes.root
   }, getContainerProps(), {

package/esm/constants/dataGridPropsDefaultValues.js

@@ -10,6 +10,7 @@ export const DATA_GRID_PROPS_DEFAULT_VALUES = {
   checkboxSelectionVisibleOnly: false,
   clipboardCopyCellDelimiter: '\t',
   columnBufferPx: 150,
+  columnFilterDebounceMs: 150,
   columnHeaderHeight: 56,
   disableAutosize: false,
   disableColumnFilter: false,

package/esm/hooks/core/useGridVirtualizer.d.ts

@@ -0,0 +1,9 @@
+import { RefObject } from '@mui/x-internals/types';
+import { GridPrivateApiCommunity } from "../../models/api/gridApiCommunity.js";
+import { DataGridProcessedProps } from "../../models/props/DataGridProps.js";
+type RootProps = DataGridProcessedProps;
+/**
+ * Virtualizer setup
+ */
+export declare function useGridVirtualizer(apiRef: RefObject<GridPrivateApiCommunity>, rootProps: RootProps): void;
+export {};

package/esm/hooks/core/useGridVirtualizer.js

@@ -0,0 +1,223 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import * as React from 'react';
+import useEventCallback from '@mui/utils/useEventCallback';
+import { useRtl } from '@mui/system/RtlProvider';
+import { roundToDecimalPlaces } from '@mui/x-internals/math';
+import { useStoreEffect } from '@mui/x-internals/store';
+import { useVirtualizer } from '@mui/x-virtualizer';
+import { useFirstRender } from "../utils/useFirstRender.js";
+import { createSelector } from "../../utils/createSelector.js";
+import { useGridSelector } from "../utils/useGridSelector.js";
+import { gridContentHeightSelector, gridHasFillerSelector, gridVerticalScrollbarWidthSelector } from "../features/dimensions/gridDimensionsSelectors.js";
+import { gridDensityFactorSelector } from "../features/density/index.js";
+import { gridVisibleColumnDefinitionsSelector, gridVisiblePinnedColumnDefinitionsSelector, gridColumnPositionsSelector, gridHasColSpanSelector } from "../features/columns/gridColumnsSelector.js";
+import { gridPinnedRowsSelector, gridRowCountSelector } from "../features/rows/gridRowsSelector.js";
+import { useGridVisibleRows } from "../utils/useGridVisibleRows.js";
+import { gridPaginationSelector } from "../features/pagination/index.js";
+import { gridFocusedVirtualCellSelector } from "../features/virtualization/gridFocusedVirtualCellSelector.js";
+import { gridRowSelectionManagerSelector } from "../features/rowSelection/index.js";
+import { DATA_GRID_PROPS_DEFAULT_VALUES } from "../../constants/dataGridPropsDefaultValues.js";
+import { getValidRowHeight, minimalContentHeight, rowHeightWarning } from "../features/rows/gridRowsUtils.js";
+import { getTotalHeaderHeight } from "../features/columns/gridColumnsUtils.js";
+import { jsx as _jsx } from "react/jsx-runtime";
+function identity(x) {
+  return x;
+}
+const columnsTotalWidthSelector = createSelector(gridVisibleColumnDefinitionsSelector, gridColumnPositionsSelector, (visibleColumns, positions) => {
+  const colCount = visibleColumns.length;
+  if (colCount === 0) {
+    return 0;
+  }
+  return roundToDecimalPlaces(positions[colCount - 1] + visibleColumns[colCount - 1].computedWidth, 1);
+});
+
+/**
+ * Virtualizer setup
+ */
+export function useGridVirtualizer(apiRef, rootProps) {
+  const isRtl = useRtl();
+  const {
+    listView
+  } = rootProps;
+  const visibleColumns = useGridSelector(apiRef, gridVisibleColumnDefinitionsSelector);
+  const pinnedRows = useGridSelector(apiRef, gridPinnedRowsSelector);
+  const pinnedColumns = gridVisiblePinnedColumnDefinitionsSelector(apiRef);
+  const rowSelectionManager = useGridSelector(apiRef, gridRowSelectionManagerSelector);
+  const isRowSelected = id => rowSelectionManager.has(id) && apiRef.current.isRowSelectable(id);
+  const currentPage = useGridVisibleRows(apiRef);
+  const hasColSpan = useGridSelector(apiRef, gridHasColSpanSelector);
+
+  /* TODO: extract dimensions code */
+  const contentHeight = useGridSelector(apiRef, gridContentHeightSelector);
+  const verticalScrollbarWidth = useGridSelector(apiRef, gridVerticalScrollbarWidthSelector);
+  const hasFiller = useGridSelector(apiRef, gridHasFillerSelector);
+  const {
+    autoHeight
+  } = rootProps;
+  const scrollReset = listView;
+
+  // <DIMENSIONS>
+  const density = useGridSelector(apiRef, gridDensityFactorSelector);
+  const baseRowHeight = getValidRowHeight(rootProps.rowHeight, DATA_GRID_PROPS_DEFAULT_VALUES.rowHeight, rowHeightWarning);
+  const rowHeight = Math.floor(baseRowHeight * density);
+  const headerHeight = Math.floor(rootProps.columnHeaderHeight * density);
+  const groupHeaderHeight = Math.floor((rootProps.columnGroupHeaderHeight ?? rootProps.columnHeaderHeight) * density);
+  const headerFilterHeight = Math.floor((rootProps.headerFilterHeight ?? rootProps.columnHeaderHeight) * density);
+  const columnsTotalWidth = useGridSelector(apiRef, columnsTotalWidthSelector);
+  const headersTotalHeight = getTotalHeaderHeight(apiRef, rootProps);
+  const leftPinnedWidth = pinnedColumns.left.reduce((w, col) => w + col.computedWidth, 0);
+  const rightPinnedWidth = pinnedColumns.right.reduce((w, col) => w + col.computedWidth, 0);
+  const dimensions = {
+    rowHeight,
+    headerHeight,
+    groupHeaderHeight,
+    headerFilterHeight,
+    columnsTotalWidth,
+    headersTotalHeight,
+    leftPinnedWidth,
+    rightPinnedWidth
+  };
+
+  // </DIMENSIONS>
+
+  // <ROWS_META>
+  const dataRowCount = useGridSelector(apiRef, gridRowCountSelector);
+  const pagination = useGridSelector(apiRef, gridPaginationSelector);
+  const rowCount = Math.min(pagination.enabled ? pagination.paginationModel.pageSize : dataRowCount, dataRowCount);
+  const {
+    getRowHeight,
+    getEstimatedRowHeight,
+    getRowSpacing
+  } = rootProps;
+  // </ROWS_META>
+
+  const focusedVirtualCell = useGridSelector(apiRef, gridFocusedVirtualCellSelector);
+  const virtualizer = useVirtualizer({
+    scrollbarSize: rootProps.scrollbarSize,
+    dimensions,
+    initialState: {
+      scroll: rootProps.initialState?.scroll,
+      dimensions: apiRef.current.state.dimensions,
+      rowSpanning: apiRef.current.state.rowSpanning,
+      virtualization: apiRef.current.state.virtualization
+    },
+    isRtl,
+    rows: currentPage.rows,
+    range: currentPage.range,
+    rowIdToIndexMap: currentPage.rowIdToIndexMap,
+    rowCount,
+    columns: visibleColumns,
+    pinnedRows,
+    pinnedColumns,
+    refs: {
+      container: apiRef.current.mainElementRef,
+      scroller: apiRef.current.virtualScrollerRef,
+      scrollbarVertical: apiRef.current.virtualScrollbarVerticalRef,
+      scrollbarHorizontal: apiRef.current.virtualScrollbarHorizontalRef
+    },
+    hasColSpan,
+    contentHeight,
+    minimalContentHeight,
+    autoHeight,
+    getRowHeight: React.useMemo(() => {
+      if (!getRowHeight) {
+        return undefined;
+      }
+      return rowEntry => getRowHeight(_extends({}, rowEntry, {
+        densityFactor: density
+      }));
+    }, [getRowHeight, density]),
+    getEstimatedRowHeight: React.useMemo(() => getEstimatedRowHeight ? rowEntry => getEstimatedRowHeight(_extends({}, rowEntry, {
+      densityFactor: density
+    })) : undefined, [getEstimatedRowHeight, density]),
+    getRowSpacing: React.useMemo(() => getRowSpacing ? (rowEntry, visibility) => getRowSpacing(_extends({}, rowEntry, visibility, {
+      indexRelativeToCurrentPage: apiRef.current.getRowIndexRelativeToVisibleRows(rowEntry.id)
+    })) : undefined, [apiRef, getRowSpacing]),
+    applyRowHeight: useEventCallback((entry, row) => apiRef.current.unstable_applyPipeProcessors('rowHeight', entry, row)),
+    virtualizeColumnsWithAutoRowHeight: rootProps.virtualizeColumnsWithAutoRowHeight,
+    focusedVirtualCell: useEventCallback(() => focusedVirtualCell),
+    rowBufferPx: rootProps.rowBufferPx,
+    columnBufferPx: rootProps.columnBufferPx,
+    resizeThrottleMs: rootProps.resizeThrottleMs,
+    onResize: useEventCallback(size => apiRef.current.publishEvent('resize', size)),
+    onWheel: useEventCallback(event => {
+      apiRef.current.publishEvent('virtualScrollerWheel', {}, event);
+    }),
+    onTouchMove: useEventCallback(event => {
+      apiRef.current.publishEvent('virtualScrollerTouchMove', {}, event);
+    }),
+    onRenderContextChange: useEventCallback(nextRenderContext => {
+      apiRef.current.publishEvent('renderedRowsIntervalChange', nextRenderContext);
+    }),
+    onScrollChange: (scrollPosition, nextRenderContext) => {
+      apiRef.current.publishEvent('scrollPositionChange', {
+        top: scrollPosition.top,
+        left: scrollPosition.left,
+        renderContext: nextRenderContext
+      });
+    },
+    scrollReset,
+    getColspan: (rowId, column) => {
+      if (typeof column.colSpan === 'function') {
+        const row = apiRef.current.getRow(rowId);
+        const value = apiRef.current.getRowValue(row, column);
+        return column.colSpan(value, row, column, apiRef) ?? 0;
+      }
+      return column.colSpan ?? 0;
+    },
+    renderRow: params => /*#__PURE__*/_jsx(rootProps.slots.row, _extends({
+      row: params.model,
+      rowId: params.id,
+      index: params.rowIndex,
+      selected: isRowSelected(params.id),
+      offsetLeft: params.offsetLeft,
+      columnsTotalWidth: columnsTotalWidth,
+      rowHeight: params.baseRowHeight,
+      pinnedColumns: pinnedColumns,
+      visibleColumns: params.columns,
+      firstColumnIndex: params.firstColumnIndex,
+      lastColumnIndex: params.lastColumnIndex,
+      focusedColumnIndex: params.focusedColumnIndex,
+      isFirstVisible: params.isFirstVisible,
+      isLastVisible: params.isLastVisible,
+      isNotVisible: params.isVirtualFocusRow,
+      showBottomBorder: params.showBottomBorder,
+      scrollbarWidth: verticalScrollbarWidth,
+      gridHasFiller: hasFiller
+    }, rootProps.slotProps?.row), params.id),
+    renderInfiniteLoadingTrigger: id => apiRef.current.getInfiniteLoadingTriggerElement?.({
+      lastRowId: id
+    })
+  });
+
+  // HACK: Keep the grid's store in sync with the virtualizer store. We set up the
+  // subscription in the render phase rather than in an effect because other grid
+  // initialization code runs between those two moments.
+  //
+  // TODO(v9): Remove this
+  useFirstRender(() => {
+    apiRef.current.store.state.dimensions = virtualizer.store.state.dimensions;
+    apiRef.current.store.state.rowsMeta = virtualizer.store.state.rowsMeta;
+    apiRef.current.store.state.virtualization = virtualizer.store.state.virtualization;
+  });
+  useStoreEffect(virtualizer.store, identity, (_, state) => {
+    if (state.dimensions !== apiRef.current.state.dimensions) {
+      apiRef.current.setState(gridState => _extends({}, gridState, {
+        dimensions: state.dimensions
+      }));
+    }
+    if (state.rowsMeta !== apiRef.current.state.rowsMeta) {
+      apiRef.current.setState(gridState => _extends({}, gridState, {
+        rowsMeta: state.rowsMeta
+      }));
+    }
+    if (state.virtualization !== apiRef.current.state.virtualization) {
+      apiRef.current.setState(gridState => _extends({}, gridState, {
+        virtualization: state.virtualization
+      }));
+    }
+  });
+  apiRef.current.register('private', {
+    virtualizer
+  });
+}

package/esm/hooks/features/columnHeaders/useGridColumnHeaders.d.ts

@@ -31,7 +31,7 @@ export interface GetHeadersParams {
 type OwnerState = DataGridProcessedProps;
 export declare const GridColumnHeaderRow: import("@emotion/styled").StyledComponent<import("@mui/system").MUIStyledCommonProps<import("@mui/material/styles").Theme> & {
   ownerState: OwnerState;
-}, Pick<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, keyof React.HTMLAttributes<HTMLDivElement> | keyof React.ClassAttributes<HTMLDivElement>>, {}>;
+}, Pick<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, keyof React.ClassAttributes<HTMLDivElement> | keyof React.HTMLAttributes<HTMLDivElement>>, {}>;
 export declare const useGridColumnHeaders: (props: UseGridColumnHeadersProps) => {
   renderContext: GridColumnsRenderContext;
   leftRenderContext: {

package/esm/hooks/features/columnHeaders/useGridColumnHeaders.js

@@ -4,6 +4,7 @@ import _extends from "@babel/runtime/helpers/esm/extends";
 import * as React from 'react';
 import clsx from 'clsx';
 import { styled } from '@mui/material/styles';
+import { computeOffsetLeft } from '@mui/x-virtualizer';
 import { useGridSelector } from "../../utils/index.js";
 import { useGridRootProps } from "../../utils/useGridRootProps.js";
 import { useGridPrivateApiContext } from "../../utils/useGridPrivateApiContext.js";
@@ -11,7 +12,6 @@ import { useGridEvent } from "../../utils/useGridEvent.js";
 import { GridColumnHeaderItem } from "../../../components/columnHeaders/GridColumnHeaderItem.js";
 import { gridColumnsTotalWidthSelector, gridGroupHeaderHeightSelector, gridHasFillerSelector, gridHeaderHeightSelector, gridVerticalScrollbarWidthSelector } from "../dimensions/gridDimensionsSelectors.js";
 import { gridRenderContextColumnsSelector } from "../virtualization/index.js";
-import { computeOffsetLeft } from "../virtualization/useGridVirtualScroller.js";
 import { GridColumnGroupHeader } from "../../../components/columnHeaders/GridColumnGroupHeader.js";
 import { gridColumnPositionsSelector, gridVisiblePinnedColumnDefinitionsSelector, gridColumnLookupSelector } from "../columns/index.js";
 import { gridColumnGroupsUnwrappedModelSelector } from "../columnGrouping/gridColumnGroupsSelector.js";
@@ -85,7 +85,8 @@ export const useGridColumnHeaders = props => {
       renderContext: currentContext = renderContext
     } = params || {};
     const firstColumnToRender = currentContext.firstColumnIndex;
-    const lastColumnToRender = currentContext.lastColumnIndex;
+    // HACK: renderContext ins't always synchronized, this should be handled properly.
+    const lastColumnToRender = Math.min(currentContext.lastColumnIndex, visibleColumns.length);
     const renderedColumns = visibleColumns.slice(firstColumnToRender, lastColumnToRender);
     return {
       renderedColumns,

package/esm/hooks/features/columns/useGridColumnSpanning.js

@@ -1,4 +1,3 @@
-import * as React from 'react';
 import { useGridApiMethod } from "../../utils/useGridApiMethod.js";
 import { useGridEvent } from "../../utils/useGridEvent.js";
 /**
@@ -6,36 +5,10 @@ import { useGridEvent } from "../../utils/useGridEvent.js";
  * @requires useGridParamsApi (method)
  */
 export const useGridColumnSpanning = apiRef => {
-  const lookup = React.useRef({});
-  const getCellColSpanInfo = (rowId, columnIndex) => {
-    return lookup.current[rowId]?.[columnIndex];
-  };
-  const resetColSpan = () => {
-    lookup.current = {};
-  };
-
-  // Calculate `colSpan` for each cell in the row
-  const calculateColSpan = React.useCallback(({
-    rowId,
-    minFirstColumn,
-    maxLastColumn,
-    columns
-  }) => {
-    for (let i = minFirstColumn; i < maxLastColumn; i += 1) {
-      const cellProps = calculateCellColSpan({
-        apiRef,
-        lookup: lookup.current,
-        columnIndex: i,
-        rowId,
-        minFirstColumnIndex: minFirstColumn,
-        maxLastColumnIndex: maxLastColumn,
-        columns
-      });
-      if (cellProps.colSpan > 1) {
-        i += cellProps.colSpan - 1;
-      }
-    }
-  }, [apiRef]);
+  const virtualizer = apiRef.current.virtualizer;
+  const resetColSpan = virtualizer.api.resetColSpan;
+  const getCellColSpanInfo = virtualizer.api.getCellColSpanInfo;
+  const calculateColSpan = virtualizer.api.calculateColSpan;
   const columnSpanningPublicApi = {
     unstable_getCellColSpanInfo: getCellColSpanInfo
   };
@@ -46,62 +19,4 @@ export const useGridColumnSpanning = apiRef => {
   useGridApiMethod(apiRef, columnSpanningPublicApi, 'public');
   useGridApiMethod(apiRef, columnSpanningPrivateApi, 'private');
   useGridEvent(apiRef, 'columnOrderChange', resetColSpan);
-};
-function calculateCellColSpan(params) {
-  const {
-    apiRef,
-    lookup,
-    columnIndex,
-    rowId,
-    minFirstColumnIndex,
-    maxLastColumnIndex,
-    columns
-  } = params;
-  const columnsLength = columns.length;
-  const column = columns[columnIndex];
-  const row = apiRef.current.getRow(rowId);
-  const value = apiRef.current.getRowValue(row, column);
-  const colSpan = typeof column.colSpan === 'function' ? column.colSpan(value, row, column, apiRef) : column.colSpan;
-  if (!colSpan || colSpan === 1) {
-    setCellColSpanInfo(lookup, rowId, columnIndex, {
-      spannedByColSpan: false,
-      cellProps: {
-        colSpan: 1,
-        width: column.computedWidth
-      }
-    });
-    return {
-      colSpan: 1
-    };
-  }
-  let width = column.computedWidth;
-  for (let j = 1; j < colSpan; j += 1) {
-    const nextColumnIndex = columnIndex + j;
-    // Cells should be spanned only within their column section (left-pinned, right-pinned and unpinned).
-    if (nextColumnIndex >= minFirstColumnIndex && nextColumnIndex < maxLastColumnIndex) {
-      const nextColumn = columns[nextColumnIndex];
-      width += nextColumn.computedWidth;
-      setCellColSpanInfo(lookup, rowId, columnIndex + j, {
-        spannedByColSpan: true,
-        rightVisibleCellIndex: Math.min(columnIndex + colSpan, columnsLength - 1),
-        leftVisibleCellIndex: columnIndex
-      });
-    }
-    setCellColSpanInfo(lookup, rowId, columnIndex, {
-      spannedByColSpan: false,
-      cellProps: {
-        colSpan,
-        width
-      }
-    });
-  }
-  return {
-    colSpan
-  };
-}
-function setCellColSpanInfo(lookup, rowId, columnIndex, cellColSpanInfo) {
-  if (!lookup[rowId]) {
-    lookup[rowId] = {};
-  }
-  lookup[rowId][columnIndex] = cellColSpanInfo;
-}
+};