@mui/x-data-grid 5.13.0 → 5.15.0

package/hooks/features/keyboardNavigation/useGridKeyboardNavigation.js

@@ -9,6 +9,12 @@ import { gridClasses } from '../../../constants/gridClasses';
 import { GridCellModes } from '../../../models/gridEditRowModel';
 import { isNavigationKey } from '../../../utils/keyboardUtils';
 import { GRID_DETAIL_PANEL_TOGGLE_FIELD } from '../../../constants/gridDetailPanelToggleField';
+import { gridPinnedRowsSelector } from '../rows/gridRowsSelector';
+
+function enrichPageRowsWithPinnedRows(apiRef, rows) {
+  const pinnedRows = gridPinnedRowsSelector(apiRef) || {};
+  return [...(pinnedRows.top || []), ...rows, ...(pinnedRows.bottom || [])];
+}
 /**
  * @requires useGridSorting (method) - can be after
  * @requires useGridFilter (state) - can be after
@@ -19,20 +25,19 @@ import { GRID_DETAIL_PANEL_TOGGLE_FIELD } from '../../../constants/gridDetailPan
  * @requires useGridColumnSpanning (method) - can be after
  */
 
+
 export const useGridKeyboardNavigation = (apiRef, props) => {
   const logger = useGridLogger(apiRef, 'useGridKeyboardNavigation');
-  const currentPage = useGridVisibleRows(apiRef, props);
+  const initialCurrentPageRows = useGridVisibleRows(apiRef, props).rows;
+  const currentPageRows = React.useMemo(() => enrichPageRowsWithPinnedRows(apiRef, initialCurrentPageRows), [apiRef, initialCurrentPageRows]);
   /**
    * @param {number} colIndex Index of the column to focus
    * @param {number} rowIndex index of the row to focus
    * @param {string} closestColumnToUse Which closest column cell to use when the cell is spanned by `colSpan`.
    */
 
-  const goToCell = React.useCallback((colIndex, rowIndex, closestColumnToUse = 'left') => {
-    var _visibleSortedRows$ro;
-
+  const goToCell = React.useCallback((colIndex, rowId, closestColumnToUse = 'left') => {
     const visibleSortedRows = gridVisibleSortedRowEntriesSelector(apiRef);
-    const rowId = (_visibleSortedRows$ro = visibleSortedRows[rowIndex]) == null ? void 0 : _visibleSortedRows$ro.id;
     const nextCellColSpanInfo = apiRef.current.unstable_getCellColSpanInfo(rowId, colIndex);
 
     if (nextCellColSpanInfo && nextCellColSpanInfo.spannedByColSpan) {
@@ -41,12 +46,15 @@ export const useGridKeyboardNavigation = (apiRef, props) => {
       } else if (closestColumnToUse === 'right') {
         colIndex = nextCellColSpanInfo.rightVisibleCellIndex;
       }
-    }
+    } // `scrollToIndexes` requires a rowIndex relative to all visible rows.
+    // Those rows do not include pinned rows, but pinned rows do not need scroll anyway.
 
-    logger.debug(`Navigating to cell row ${rowIndex}, col ${colIndex}`);
+
+    const rowIndexRelativeToAllRows = visibleSortedRows.findIndex(row => row.id === rowId);
+    logger.debug(`Navigating to cell row ${rowIndexRelativeToAllRows}, col ${colIndex}`);
     apiRef.current.scrollToIndexes({
       colIndex,
-      rowIndex
+      rowIndex: rowIndexRelativeToAllRows
     });
     const field = apiRef.current.getVisibleColumns()[colIndex].field;
     apiRef.current.setCellFocus(rowId, field);
@@ -59,19 +67,21 @@ export const useGridKeyboardNavigation = (apiRef, props) => {
     const field = apiRef.current.getVisibleColumns()[colIndex].field;
     apiRef.current.setColumnHeaderFocus(field, event);
   }, [apiRef, logger]);
+  const getRowIdFromIndex = React.useCallback(rowIndex => {
+    return currentPageRows[rowIndex].id;
+  }, [currentPageRows]);
   const handleCellNavigationKeyDown = React.useCallback((params, event) => {
     const dimensions = apiRef.current.getRootDimensions();
 
-    if (!currentPage.range || !dimensions) {
+    if (currentPageRows.length === 0 || !dimensions) {
       return;
     }
 
     const viewportPageSize = apiRef.current.unstable_getViewportPageSize();
-    const visibleSortedRows = gridVisibleSortedRowEntriesSelector(apiRef);
     const colIndexBefore = params.field ? apiRef.current.getColumnIndex(params.field) : 0;
-    const rowIndexBefore = visibleSortedRows.findIndex(row => row.id === params.id);
-    const firstRowIndexInPage = currentPage.range.firstRowIndex;
-    const lastRowIndexInPage = currentPage.range.lastRowIndex;
+    const rowIndexBefore = currentPageRows.findIndex(row => row.id === params.id);
+    const firstRowIndexInPage = 0;
+    const lastRowIndexInPage = currentPageRows.length - 1;
     const firstColIndex = 0;
     const lastColIndex = gridVisibleColumnDefinitionsSelector(apiRef).length - 1;
     let shouldPreventDefault = true;
@@ -82,7 +92,7 @@ export const useGridKeyboardNavigation = (apiRef, props) => {
         {
           // "Enter" is only triggered by the row / cell editing feature
           if (rowIndexBefore < lastRowIndexInPage) {
-            goToCell(colIndexBefore, rowIndexBefore + 1);
+            goToCell(colIndexBefore, getRowIdFromIndex(rowIndexBefore + 1));
           }
 
           break;
@@ -91,7 +101,7 @@ export const useGridKeyboardNavigation = (apiRef, props) => {
       case 'ArrowUp':
         {
           if (rowIndexBefore > firstRowIndexInPage) {
-            goToCell(colIndexBefore, rowIndexBefore - 1);
+            goToCell(colIndexBefore, getRowIdFromIndex(rowIndexBefore - 1));
           } else {
             goToHeader(colIndexBefore, event);
           }
@@ -102,7 +112,7 @@ export const useGridKeyboardNavigation = (apiRef, props) => {
       case 'ArrowRight':
         {
           if (colIndexBefore < lastColIndex) {
-            goToCell(colIndexBefore + 1, rowIndexBefore, 'right');
+            goToCell(colIndexBefore + 1, getRowIdFromIndex(rowIndexBefore), 'right');
           }
 
           break;
@@ -111,7 +121,7 @@ export const useGridKeyboardNavigation = (apiRef, props) => {
       case 'ArrowLeft':
         {
           if (colIndexBefore > firstColIndex) {
-            goToCell(colIndexBefore - 1, rowIndexBefore);
+            goToCell(colIndexBefore - 1, getRowIdFromIndex(rowIndexBefore));
           }
 
           break;
@@ -121,9 +131,9 @@ export const useGridKeyboardNavigation = (apiRef, props) => {
         {
           // "Tab" is only triggered by the row / cell editing feature
           if (event.shiftKey && colIndexBefore > firstColIndex) {
-            goToCell(colIndexBefore - 1, rowIndexBefore, 'left');
+            goToCell(colIndexBefore - 1, getRowIdFromIndex(rowIndexBefore), 'left');
           } else if (!event.shiftKey && colIndexBefore < lastColIndex) {
-            goToCell(colIndexBefore + 1, rowIndexBefore, 'right');
+            goToCell(colIndexBefore + 1, getRowIdFromIndex(rowIndexBefore), 'right');
           }
 
           break;
@@ -144,7 +154,7 @@ export const useGridKeyboardNavigation = (apiRef, props) => {
           }
 
           if (!event.shiftKey && rowIndexBefore < lastRowIndexInPage) {
-            goToCell(colIndexBefore, Math.min(rowIndexBefore + viewportPageSize, lastRowIndexInPage));
+            goToCell(colIndexBefore, getRowIdFromIndex(Math.min(rowIndexBefore + viewportPageSize, lastRowIndexInPage)));
           }
 
           break;
@@ -153,7 +163,7 @@ export const useGridKeyboardNavigation = (apiRef, props) => {
       case 'PageDown':
         {
           if (rowIndexBefore < lastRowIndexInPage) {
-            goToCell(colIndexBefore, Math.min(rowIndexBefore + viewportPageSize, lastRowIndexInPage));
+            goToCell(colIndexBefore, getRowIdFromIndex(Math.min(rowIndexBefore + viewportPageSize, lastRowIndexInPage)));
           }
 
           break;
@@ -165,7 +175,7 @@ export const useGridKeyboardNavigation = (apiRef, props) => {
           const nextRowIndex = Math.max(rowIndexBefore - viewportPageSize, firstRowIndexInPage);
 
           if (nextRowIndex !== rowIndexBefore && nextRowIndex >= firstRowIndexInPage) {
-            goToCell(colIndexBefore, nextRowIndex);
+            goToCell(colIndexBefore, getRowIdFromIndex(nextRowIndex));
           } else {
             goToHeader(colIndexBefore, event);
           }
@@ -176,9 +186,9 @@ export const useGridKeyboardNavigation = (apiRef, props) => {
       case 'Home':
         {
           if (event.ctrlKey || event.metaKey || event.shiftKey) {
-            goToCell(firstColIndex, firstRowIndexInPage);
+            goToCell(firstColIndex, getRowIdFromIndex(firstRowIndexInPage));
           } else {
-            goToCell(firstColIndex, rowIndexBefore);
+            goToCell(firstColIndex, getRowIdFromIndex(rowIndexBefore));
           }
 
           break;
@@ -187,9 +197,9 @@ export const useGridKeyboardNavigation = (apiRef, props) => {
       case 'End':
         {
           if (event.ctrlKey || event.metaKey || event.shiftKey) {
-            goToCell(lastColIndex, lastRowIndexInPage);
+            goToCell(lastColIndex, getRowIdFromIndex(lastRowIndexInPage));
           } else {
-            goToCell(lastColIndex, rowIndexBefore);
+            goToCell(lastColIndex, getRowIdFromIndex(rowIndexBefore));
           }
 
           break;
@@ -204,10 +214,8 @@ export const useGridKeyboardNavigation = (apiRef, props) => {
     if (shouldPreventDefault) {
       event.preventDefault();
     }
-  }, [apiRef, currentPage, goToCell, goToHeader]);
+  }, [apiRef, currentPageRows, goToCell, goToHeader, getRowIdFromIndex]);
   const handleColumnHeaderKeyDown = React.useCallback((params, event) => {
-    var _currentPage$range$fi, _currentPage$range, _currentPage$range$la, _currentPage$range2;
-
     const headerTitleNode = event.currentTarget.querySelector(`.${gridClasses.columnHeaderTitleContainerContent}`);
     const isFromInsideContent = !!headerTitleNode && headerTitleNode.contains(event.target);
 
@@ -225,8 +233,8 @@ export const useGridKeyboardNavigation = (apiRef, props) => {
 
     const viewportPageSize = apiRef.current.unstable_getViewportPageSize();
     const colIndexBefore = params.field ? apiRef.current.getColumnIndex(params.field) : 0;
-    const firstRowIndexInPage = (_currentPage$range$fi = (_currentPage$range = currentPage.range) == null ? void 0 : _currentPage$range.firstRowIndex) != null ? _currentPage$range$fi : null;
-    const lastRowIndexInPage = (_currentPage$range$la = (_currentPage$range2 = currentPage.range) == null ? void 0 : _currentPage$range2.lastRowIndex) != null ? _currentPage$range$la : null;
+    const firstRowIndexInPage = 0;
+    const lastRowIndexInPage = currentPageRows.length - 1;
     const firstColIndex = 0;
     const lastColIndex = gridVisibleColumnDefinitionsSelector(apiRef).length - 1;
     let shouldPreventDefault = true;
@@ -235,7 +243,7 @@ export const useGridKeyboardNavigation = (apiRef, props) => {
       case 'ArrowDown':
         {
           if (firstRowIndexInPage !== null) {
-            goToCell(colIndexBefore, firstRowIndexInPage);
+            goToCell(colIndexBefore, getRowIdFromIndex(firstRowIndexInPage));
           }
 
           break;
@@ -262,7 +270,7 @@ export const useGridKeyboardNavigation = (apiRef, props) => {
       case 'PageDown':
         {
           if (firstRowIndexInPage !== null && lastRowIndexInPage !== null) {
-            goToCell(colIndexBefore, Math.min(firstRowIndexInPage + viewportPageSize, lastRowIndexInPage));
+            goToCell(colIndexBefore, getRowIdFromIndex(Math.min(firstRowIndexInPage + viewportPageSize, lastRowIndexInPage)));
           }
 
           break;
@@ -304,7 +312,7 @@ export const useGridKeyboardNavigation = (apiRef, props) => {
     if (shouldPreventDefault) {
       event.preventDefault();
     }
-  }, [apiRef, currentPage, goToCell, goToHeader]);
+  }, [apiRef, currentPageRows, goToCell, goToHeader, getRowIdFromIndex]);
   const handleCellKeyDown = React.useCallback((params, event) => {
     // Ignore portal
     if (!event.currentTarget.contains(event.target)) {

package/hooks/features/pagination/useGridPage.js

@@ -63,13 +63,14 @@ export const useGridPage = (apiRef, props) => {
    * PRE-PROCESSING
    */
 
-  const stateExportPreProcessing = React.useCallback(prevState => {
+  const stateExportPreProcessing = React.useCallback((prevState, context) => {
     var _props$initialState, _props$initialState$p;
 
     const pageToExport = gridPageSelector(apiRef);
-    const shouldExportPage = // Always export if the page is controlled
+    const shouldExportPage = // Always export if the `exportOnlyDirtyModels` property is activated
+    !context.exportOnlyDirtyModels || // Always export if the page is controlled
     props.page != null || // Always export if the page has been initialized
-    ((_props$initialState = props.initialState) == null ? void 0 : (_props$initialState$p = _props$initialState.pagination) == null ? void 0 : _props$initialState$p.page) != null || // Export if the page value is not equal to the default value
+    ((_props$initialState = props.initialState) == null ? void 0 : (_props$initialState$p = _props$initialState.pagination) == null ? void 0 : _props$initialState$p.page) != null || // Export if the page is not equal to the default value
     pageToExport !== 0;
 
     if (!shouldExportPage) {

package/hooks/features/pagination/useGridPageSize.js

@@ -4,6 +4,7 @@ import { useGridLogger, useGridApiMethod, useGridApiEventHandler, useGridSelecto
 import { gridPageSizeSelector } from './gridPaginationSelector';
 import { gridDensityRowHeightSelector } from '../density';
 import { useGridRegisterPipeProcessor } from '../../core/pipeProcessing';
+import { calculatePinnedRowsHeight } from '../rows/gridRowsUtils';
 export const defaultPageSize = autoPageSize => autoPageSize ? 0 : 100;
 
 const mergeStateWithPageSize = pageSize => state => _extends({}, state, {
@@ -49,13 +50,14 @@ export const useGridPageSize = (apiRef, props) => {
    * PRE-PROCESSING
    */
 
-  const stateExportPreProcessing = React.useCallback(prevState => {
+  const stateExportPreProcessing = React.useCallback((prevState, context) => {
     var _props$initialState, _props$initialState$p;
 
     const pageSizeToExport = gridPageSizeSelector(apiRef);
-    const shouldExportPageSize = // Always export if the page size is controlled
+    const shouldExportPageSize = // Always export if the `exportOnlyDirtyModels` property is activated
+    !context.exportOnlyDirtyModels || // Always export if the page size is controlled
     props.pageSize != null || // Always export if the page size has been initialized
-    ((_props$initialState = props.initialState) == null ? void 0 : (_props$initialState$p = _props$initialState.pagination) == null ? void 0 : _props$initialState$p.pageSize) != null || // Export if the page size value is not equal to the default value
+    ((_props$initialState = props.initialState) == null ? void 0 : (_props$initialState$p = _props$initialState.pagination) == null ? void 0 : _props$initialState$p.pageSize) != null || // Export if the page size is not equal to the default value
     pageSizeToExport !== defaultPageSize(props.autoPageSize);
 
     if (!shouldExportPageSize) {
@@ -96,7 +98,8 @@ export const useGridPageSize = (apiRef, props) => {
       return;
     }
 
-    const maximumPageSizeWithoutScrollBar = Math.floor(dimensions.viewportInnerSize.height / rowHeight);
+    const pinnedRowsHeight = calculatePinnedRowsHeight(apiRef);
+    const maximumPageSizeWithoutScrollBar = Math.floor((dimensions.viewportInnerSize.height - pinnedRowsHeight.top - pinnedRowsHeight.bottom) / rowHeight);
     apiRef.current.setPageSize(maximumPageSizeWithoutScrollBar);
   }, [apiRef, props.autoPageSize, rowHeight]);
   useGridApiEventHandler(apiRef, 'viewportInnerSizeChange', handleUpdateAutoPageSize);

package/hooks/features/preferencesPanel/useGridPreferencesPanel.d.ts

@@ -6,4 +6,4 @@ export declare const preferencePanelStateInitializer: GridStateInitializer<Pick<
 /**
  * TODO: Add a single `setPreferencePanel` method to avoid multiple `setState`
  */
-export declare const useGridPreferencesPanel: (apiRef: React.MutableRefObject<GridApiCommunity>) => void;
+export declare const useGridPreferencesPanel: (apiRef: React.MutableRefObject<GridApiCommunity>, props: Pick<DataGridProcessedProps, 'initialState'>) => void;

package/hooks/features/preferencesPanel/useGridPreferencesPanel.js

@@ -17,7 +17,9 @@ export const preferencePanelStateInitializer = (state, props) => {
  * TODO: Add a single `setPreferencePanel` method to avoid multiple `setState`
  */
 
-export const useGridPreferencesPanel = apiRef => {
+export const useGridPreferencesPanel = (apiRef, props) => {
+  var _props$initialState3;
+
   const logger = useGridLogger(apiRef, 'useGridPreferencesPanel');
   const hideTimeout = React.useRef();
   const immediateTimeout = React.useRef();
@@ -74,17 +76,23 @@ export const useGridPreferencesPanel = apiRef => {
    * PRE-PROCESSING
    */
 
-  const stateExportPreProcessing = React.useCallback(prevState => {
+  const stateExportPreProcessing = React.useCallback((prevState, context) => {
+    var _props$initialState2;
+
     const preferencePanelToExport = gridPreferencePanelStateSelector(apiRef.current.state);
+    const shouldExportPreferencePanel = // Always export if the `exportOnlyDirtyModels` property is activated
+    !context.exportOnlyDirtyModels || // Always export if the panel was initialized
+    ((_props$initialState2 = props.initialState) == null ? void 0 : _props$initialState2.preferencePanel) != null || // Always export if the panel is opened
+    preferencePanelToExport.open;
 
-    if (!preferencePanelToExport.open && !preferencePanelToExport.openedPanelValue) {
+    if (!shouldExportPreferencePanel) {
       return prevState;
     }
 
     return _extends({}, prevState, {
       preferencePanel: preferencePanelToExport
     });
-  }, [apiRef]);
+  }, [apiRef, (_props$initialState3 = props.initialState) == null ? void 0 : _props$initialState3.preferencePanel]);
   const stateRestorePreProcessing = React.useCallback((params, context) => {
     const preferencePanel = context.stateToRestore.preferencePanel;
 

package/hooks/features/rows/gridRowsSelector.d.ts

@@ -9,3 +9,17 @@ export declare const gridRowTreeSelector: import("../../../utils/createSelector"
 export declare const gridRowGroupingNameSelector: import("../../../utils/createSelector").OutputSelector<GridStateCommunity, string>;
 export declare const gridRowTreeDepthSelector: import("../../../utils/createSelector").OutputSelector<GridStateCommunity, number>;
 export declare const gridRowIdsSelector: import("../../../utils/createSelector").OutputSelector<GridStateCommunity, import("../../..").GridRowId[]>;
+/**
+ * @ignore - do not document.
+ */
+export declare const gridAdditionalRowGroupsSelector: import("../../../utils/createSelector").OutputSelector<GridStateCommunity, {
+    pinnedRows?: import("./gridRowsState").GridPinnedRowsState | undefined;
+} | undefined>;
+/**
+ * @ignore - do not document.
+ */
+export declare const gridPinnedRowsSelector: import("../../../utils/createSelector").OutputSelector<GridStateCommunity, import("./gridRowsState").GridPinnedRowsState | undefined>;
+/**
+ * @ignore - do not document.
+ */
+export declare const gridPinnedRowsCountSelector: import("../../../utils/createSelector").OutputSelector<GridStateCommunity, number>;

package/hooks/features/rows/gridRowsSelector.js

@@ -8,4 +8,23 @@ export const gridRowsIdToIdLookupSelector = createSelector(gridRowsStateSelector
 export const gridRowTreeSelector = createSelector(gridRowsStateSelector, rows => rows.tree);
 export const gridRowGroupingNameSelector = createSelector(gridRowsStateSelector, rows => rows.groupingName);
 export const gridRowTreeDepthSelector = createSelector(gridRowsStateSelector, rows => rows.treeDepth);
-export const gridRowIdsSelector = createSelector(gridRowsStateSelector, rows => rows.ids);
+export const gridRowIdsSelector = createSelector(gridRowsStateSelector, rows => rows.ids);
+/**
+ * @ignore - do not document.
+ */
+
+export const gridAdditionalRowGroupsSelector = createSelector(gridRowsStateSelector, rows => rows == null ? void 0 : rows.additionalRowGroups);
+/**
+ * @ignore - do not document.
+ */
+
+export const gridPinnedRowsSelector = createSelector(gridAdditionalRowGroupsSelector, additionalRowGroups => additionalRowGroups == null ? void 0 : additionalRowGroups.pinnedRows);
+/**
+ * @ignore - do not document.
+ */
+
+export const gridPinnedRowsCountSelector = createSelector(gridPinnedRowsSelector, pinnedRows => {
+  var _pinnedRows$top, _pinnedRows$bottom;
+
+  return ((pinnedRows == null ? void 0 : (_pinnedRows$top = pinnedRows.top) == null ? void 0 : _pinnedRows$top.length) || 0) + ((pinnedRows == null ? void 0 : (_pinnedRows$bottom = pinnedRows.bottom) == null ? void 0 : _pinnedRows$bottom.length) || 0);
+});

package/hooks/features/rows/gridRowsState.d.ts

@@ -1,4 +1,4 @@
-import { GridRowId, GridRowsLookup, GridRowTreeConfig } from '../../../models/gridRows';
+import { GridRowId, GridRowsLookup, GridRowTreeConfig, GridRowEntry } from '../../../models/gridRows';
 import type { DataGridProcessedProps } from '../../../models/props/DataGridProps';
 export interface GridRowTreeCreationParams {
     ids: GridRowId[];
@@ -17,6 +17,9 @@ export interface GridRowTreeCreationValue {
     ids: GridRowId[];
     idRowsLookup: GridRowsLookup;
     idToIdLookup: Record<string, GridRowId>;
+    additionalRowGroups?: {
+        pinnedRows?: GridPinnedRowsState;
+    };
 }
 export interface GridRowsInternalCache extends Omit<GridRowTreeCreationParams, 'previousTree'> {
     /**
@@ -51,3 +54,7 @@ export interface GridRowsState extends GridRowTreeCreationValue {
     groupingResponseBeforeRowHydration: GridRowTreeCreationValue;
 }
 export declare type GridHydrateRowsValue = GridRowTreeCreationValue;
+export interface GridPinnedRowsState {
+    top?: GridRowEntry[];
+    bottom?: GridRowEntry[];
+}

package/hooks/features/rows/gridRowsUtils.d.ts

@@ -10,7 +10,7 @@ import { GridRowsInternalCache, GridRowsState } from './gridRowsState';
  * @param {string} detailErrorMessage A custom error message to display for invalid IDs
  */
 export declare function checkGridRowIdIsValid(id: GridRowId, row: GridRowModel | Partial<GridRowModel>, detailErrorMessage?: string): void;
-export declare const getRowIdFromRowModel: (rowModel: GridRowModel, getRowId?: GridRowIdGetter<any> | undefined, detailErrorMessage?: string | undefined) => GridRowId;
+export declare const getRowIdFromRowModel: (rowModel: GridRowModel, getRowId?: GridRowIdGetter, detailErrorMessage?: string) => GridRowId;
 export declare const createRowsInternalCache: ({ rows, getRowId, loading, }: Pick<DataGridProcessedProps, 'rows' | 'getRowId' | 'loading'>) => GridRowsInternalCache;
 export declare const getRowsStateFromCache: ({ apiRef, previousTree, rowCountProp, loadingProp, }: {
     apiRef: React.MutableRefObject<GridApiCommunity>;
@@ -19,3 +19,7 @@ export declare const getRowsStateFromCache: ({ apiRef, previousTree, rowCountPro
     loadingProp: boolean | undefined;
 }) => GridRowsState;
 export declare const getTreeNodeDescendants: (tree: GridRowTreeConfig, parentId: GridRowId, skipAutoGeneratedRows: boolean) => GridRowId[];
+export declare function calculatePinnedRowsHeight(apiRef: React.MutableRefObject<GridApiCommunity>): {
+    top: number;
+    bottom: number;
+};

package/hooks/features/rows/gridRowsUtils.js

@@ -1,13 +1,14 @@
 import _extends from "@babel/runtime/helpers/esm/extends";
 import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
 const _excluded = ["rowsBeforePartialUpdates"];
-
+import { gridPinnedRowsSelector } from './gridRowsSelector';
 /**
  * A helper function to check if the id provided is valid.
  * @param {GridRowId} id Id as [[GridRowId]].
  * @param {GridRowModel | Partial<GridRowModel>} row Row as [[GridRowModel]].
  * @param {string} detailErrorMessage A custom error message to display for invalid IDs
  */
+
 export function checkGridRowIdIsValid(id, row, detailErrorMessage = 'A row was provided without id in the rows prop:') {
   if (id == null) {
     throw new Error(['MUI: The data grid component requires all rows to have a unique `id` property.', 'Alternatively, you can use the `getRowId` prop to specify a custom id for each row.', detailErrorMessage, JSON.stringify(row)].join('\n'));
@@ -55,7 +56,7 @@ export const getRowsStateFromCache = ({
     previousTree
   }));
   const processedGroupingResponse = apiRef.current.unstable_applyPipeProcessors('hydrateRows', groupingResponse);
-  const dataTopLevelRowCount = processedGroupingResponse.treeDepth === 1 ? processedGroupingResponse.ids.length : Object.values(processedGroupingResponse.tree).filter(node => node.parent == null).length;
+  const dataTopLevelRowCount = processedGroupingResponse.treeDepth === 1 ? processedGroupingResponse.ids.length : Object.values(processedGroupingResponse.tree).filter(node => node.parent == null && !node.isPinned).length;
   return _extends({}, processedGroupingResponse, {
     groupingResponseBeforeRowHydration: groupingResponse,
     loading: loadingProp,
@@ -86,4 +87,21 @@ export const getTreeNodeDescendants = (tree, parentId, skipAutoGeneratedRows) =>
   }
 
   return validDescendants;
-};
+};
+export function calculatePinnedRowsHeight(apiRef) {
+  var _pinnedRows$top, _pinnedRows$bottom;
+
+  const pinnedRows = gridPinnedRowsSelector(apiRef);
+  const topPinnedRowsHeight = (pinnedRows == null ? void 0 : (_pinnedRows$top = pinnedRows.top) == null ? void 0 : _pinnedRows$top.reduce((acc, value) => {
+    acc += apiRef.current.unstable_getRowHeight(value.id);
+    return acc;
+  }, 0)) || 0;
+  const bottomPinnedRowsHeight = (pinnedRows == null ? void 0 : (_pinnedRows$bottom = pinnedRows.bottom) == null ? void 0 : _pinnedRows$bottom.reduce((acc, value) => {
+    acc += apiRef.current.unstable_getRowHeight(value.id);
+    return acc;
+  }, 0)) || 0;
+  return {
+    top: topPinnedRowsHeight,
+    bottom: bottomPinnedRowsHeight
+  };
+}

package/hooks/features/rows/index.d.ts

@@ -1,5 +1,5 @@
 export * from './gridRowsMetaSelector';
 export * from './gridRowsMetaState';
-export * from './gridRowsSelector';
+export { gridRowsStateSelector, gridRowCountSelector, gridRowsLoadingSelector, gridTopLevelRowCountSelector, gridRowsLookupSelector, gridRowsIdToIdLookupSelector, gridRowTreeSelector, gridRowGroupingNameSelector, gridRowTreeDepthSelector, gridRowIdsSelector, } from './gridRowsSelector';
 export type { GridRowsState } from './gridRowsState';
 export { checkGridRowIdIsValid } from './gridRowsUtils';

package/hooks/features/rows/index.js

@@ -1,4 +1,4 @@
 export * from './gridRowsMetaSelector';
 export * from './gridRowsMetaState';
-export * from './gridRowsSelector';
+export { gridRowsStateSelector, gridRowCountSelector, gridRowsLoadingSelector, gridTopLevelRowCountSelector, gridRowsLookupSelector, gridRowsIdToIdLookupSelector, gridRowTreeSelector, gridRowGroupingNameSelector, gridRowTreeDepthSelector, gridRowIdsSelector } from './gridRowsSelector';
 export { checkGridRowIdIsValid } from './gridRowsUtils';

package/hooks/features/rows/useGridRowsMeta.js

@@ -9,6 +9,7 @@ import { gridFilterStateSelector } from '../filter/gridFilterSelector';
 import { gridPaginationSelector } from '../pagination/gridPaginationSelector';
 import { gridSortingStateSelector } from '../sorting/gridSortingSelector';
 import { useGridRegisterPipeApplier } from '../../core/pipeProcessing';
+import { gridPinnedRowsSelector } from './gridRowsSelector';
 export const rowsMetaStateInitializer = state => _extends({}, state, {
   rowsMeta: {
     currentPageTotalHeight: 0,
@@ -35,13 +36,14 @@ export const useGridRowsMeta = (apiRef, props) => {
   const paginationState = useGridSelector(apiRef, gridPaginationSelector);
   const sortingState = useGridSelector(apiRef, gridSortingStateSelector);
   const currentPage = useGridVisibleRows(apiRef, props);
+  const pinnedRows = useGridSelector(apiRef, gridPinnedRowsSelector);
   const hydrateRowsMeta = React.useCallback(() => {
+    var _pinnedRows$top, _pinnedRows$bottom;
+
     hasRowWithAutoHeight.current = false;
     const densityFactor = gridDensityFactorSelector(apiRef.current.state, apiRef.current.instanceId);
-    const positions = [];
-    const currentPageTotalHeight = currentPage.rows.reduce((acc, row) => {
-      positions.push(acc);
 
+    const calculateRowProcessedSizes = row => {
       if (!rowsHeightLookup.current[row.id]) {
         rowsHeightLookup.current[row.id] = {
           sizes: {
@@ -113,9 +115,22 @@ export const useGridRowsMeta = (apiRef, props) => {
 
       const processedSizes = apiRef.current.unstable_applyPipeProcessors('rowHeight', initialHeights, row);
       rowsHeightLookup.current[row.id].sizes = processedSizes;
+      return processedSizes;
+    };
+
+    const positions = [];
+    const currentPageTotalHeight = currentPage.rows.reduce((acc, row) => {
+      positions.push(acc);
+      const processedSizes = calculateRowProcessedSizes(row);
       const finalRowHeight = Object.values(processedSizes).reduce((acc2, value) => acc2 + value, 0);
       return acc + finalRowHeight;
     }, 0);
+    pinnedRows == null ? void 0 : (_pinnedRows$top = pinnedRows.top) == null ? void 0 : _pinnedRows$top.forEach(row => {
+      calculateRowProcessedSizes(row);
+    });
+    pinnedRows == null ? void 0 : (_pinnedRows$bottom = pinnedRows.bottom) == null ? void 0 : _pinnedRows$bottom.forEach(row => {
+      calculateRowProcessedSizes(row);
+    });
     apiRef.current.setState(state => {
       return _extends({}, state, {
         rowsMeta: {
@@ -131,7 +146,7 @@ export const useGridRowsMeta = (apiRef, props) => {
     }
 
     apiRef.current.forceUpdate();
-  }, [apiRef, currentPage.rows, rowHeightFromDensity, getRowHeightProp, getRowSpacing, getEstimatedRowHeight]);
+  }, [apiRef, currentPage.rows, rowHeightFromDensity, getRowHeightProp, getRowSpacing, getEstimatedRowHeight, pinnedRows]);
   const getRowHeight = React.useCallback(rowId => {
     const height = rowsHeightLookup.current[rowId];
     return height ? height.sizes.base : rowHeightFromDensity;

package/hooks/features/rows/useGridRowsPreProcessors.js

@@ -11,7 +11,8 @@ const flatRowTreeCreationMethod = ({
   for (let i = 0; i < ids.length; i += 1) {
     const rowId = ids[i];
 
-    if (previousTree && previousTree[rowId] && previousTree[rowId].depth === 0 && previousTree[rowId].parent == null) {
+    if (previousTree && previousTree[rowId] && previousTree[rowId].depth === 0 && previousTree[rowId].parent == null && // pinned row can be unpinned
+    !previousTree[rowId].isPinned) {
       tree[rowId] = previousTree[rowId];
     } else {
       tree[rowId] = {

package/hooks/features/scroll/useGridScroll.js

@@ -6,7 +6,8 @@ import { gridPageSelector, gridPageSizeSelector } from '../pagination/gridPagina
 import { gridRowCountSelector } from '../rows/gridRowsSelector';
 import { gridRowsMetaSelector } from '../rows/gridRowsMetaSelector';
 import { useGridApiMethod } from '../../utils/useGridApiMethod';
-import { gridVisibleSortedRowEntriesSelector } from '../filter/gridFilterSelector'; // Logic copied from https://www.w3.org/TR/wai-aria-practices/examples/listbox/js/listbox.js
+import { gridVisibleSortedRowEntriesSelector } from '../filter/gridFilterSelector';
+import { gridClasses } from '../../../constants/gridClasses'; // Logic copied from https://www.w3.org/TR/wai-aria-practices/examples/listbox/js/listbox.js
 // Similar to https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView
 
 function scrollIntoView(dimensions) {
@@ -88,13 +89,17 @@ export const useGridScroll = (apiRef, props) => {
     }
 
     if (params.rowIndex != null) {
+      var _querySelector, _querySelector2;
+
       const rowsMeta = gridRowsMetaSelector(apiRef.current.state);
       const page = gridPageSelector(apiRef);
       const pageSize = gridPageSizeSelector(apiRef);
       const elementIndex = !props.pagination ? params.rowIndex : params.rowIndex - page * pageSize;
       const targetOffsetHeight = rowsMeta.positions[elementIndex + 1] ? rowsMeta.positions[elementIndex + 1] - rowsMeta.positions[elementIndex] : rowsMeta.currentPageTotalHeight - rowsMeta.positions[elementIndex];
+      const topPinnedRowsHeight = ((_querySelector = windowRef.current.querySelector(`.${gridClasses['pinnedRows--top']}`)) == null ? void 0 : _querySelector.clientHeight) || 0;
+      const bottomPinnedRowsHeight = ((_querySelector2 = windowRef.current.querySelector(`.${gridClasses['pinnedRows--bottom']}`)) == null ? void 0 : _querySelector2.clientHeight) || 0;
       scrollCoordinates.top = scrollIntoView({
-        clientHeight: windowRef.current.clientHeight,
+        clientHeight: windowRef.current.clientHeight - topPinnedRowsHeight - bottomPinnedRowsHeight,
         scrollTop: windowRef.current.scrollTop,
         offsetHeight: targetOffsetHeight,
         offsetTop: rowsMeta.positions[elementIndex]