@mui/x-data-grid-pro 5.5.1 → 5.6.0

package/hooks/features/rowGrouping/gridRowGroupingInterfaces.js

@@ -0,0 +1 @@
+export {};

package/hooks/features/rowGrouping/gridRowGroupingSelector.d.ts

@@ -0,0 +1,4 @@
+import { GridStatePro } from '../../../models/gridStatePro';
+export declare const gridRowGroupingStateSelector: (state: GridStatePro) => import("./gridRowGroupingInterfaces").GridRowGroupingState;
+export declare const gridRowGroupingModelSelector: import("@mui/x-data-grid").OutputSelector<GridStatePro, import("./gridRowGroupingInterfaces").GridRowGroupingModel>;
+export declare const gridRowGroupingSanitizedModelSelector: import("@mui/x-data-grid").OutputSelector<GridStatePro, string[]>;

package/hooks/features/rowGrouping/gridRowGroupingSelector.js

@@ -0,0 +1,5 @@
+import { gridColumnLookupSelector } from '@mui/x-data-grid';
+import { createSelector } from '@mui/x-data-grid/internals';
+export const gridRowGroupingStateSelector = state => state.rowGrouping;
+export const gridRowGroupingModelSelector = createSelector(gridRowGroupingStateSelector, rowGrouping => rowGrouping.model);
+export const gridRowGroupingSanitizedModelSelector = createSelector(gridRowGroupingModelSelector, gridColumnLookupSelector, (model, columnsLookup) => model.filter(field => !!columnsLookup[field] && columnsLookup[field].groupable));

package/hooks/features/rowGrouping/gridRowGroupingUtils.d.ts

@@ -0,0 +1,24 @@
+import { GridRowTreeConfig, GridFilterState } from '@mui/x-data-grid';
+import { GridAggregatedFilterItemApplier } from '@mui/x-data-grid/internals';
+import { DataGridProProcessedProps } from '../../../models/dataGridProProps';
+import { GridRowGroupingModel } from './gridRowGroupingInterfaces';
+import { GridStatePro } from '../../../models/gridStatePro';
+export declare const GRID_ROW_GROUPING_SINGLE_GROUPING_FIELD = "__row_group_by_columns_group__";
+export declare const GROUPING_COLUMNS_FEATURE_NAME = "grouping-columns";
+export declare const getRowGroupingFieldFromGroupingCriteria: (groupingCriteria: string | null) => string;
+export declare const getRowGroupingCriteriaFromGroupingField: (groupingColDefField: string) => string | null;
+export declare const isGroupingColumn: (field: string) => boolean;
+interface FilterRowTreeFromTreeDataParams {
+    rowTree: GridRowTreeConfig;
+    isRowMatchingFilters: GridAggregatedFilterItemApplier | null;
+}
+/**
+ * A leaf is visible if it passed the filter
+ * A group is visible if all the following criteria are met:
+ * - One of its children is passing the filter
+ * - It is passing the filter
+ */
+export declare const filterRowTreeFromGroupingColumns: (params: FilterRowTreeFromTreeDataParams) => Omit<GridFilterState, 'filterModel'>;
+export declare const getColDefOverrides: (groupingColDefProp: DataGridProProcessedProps['groupingColDef'], fields: string[]) => import("../../..").GridGroupingColDefOverride | null | undefined;
+export declare const mergeStateWithRowGroupingModel: (rowGroupingModel: GridRowGroupingModel) => (state: GridStatePro) => GridStatePro;
+export {};

package/hooks/features/rowGrouping/gridRowGroupingUtils.js

@@ -0,0 +1,124 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+export const GRID_ROW_GROUPING_SINGLE_GROUPING_FIELD = '__row_group_by_columns_group__';
+export const GROUPING_COLUMNS_FEATURE_NAME = 'grouping-columns';
+export const getRowGroupingFieldFromGroupingCriteria = groupingCriteria => {
+  if (groupingCriteria === null) {
+    return GRID_ROW_GROUPING_SINGLE_GROUPING_FIELD;
+  }
+
+  return `__row_group_by_columns_group_${groupingCriteria}__`;
+};
+export const getRowGroupingCriteriaFromGroupingField = groupingColDefField => {
+  const match = groupingColDefField.match(/^__row_group_by_columns_group_(.*)__$/);
+
+  if (!match) {
+    return null;
+  }
+
+  return match[1];
+};
+export const isGroupingColumn = field => field === GRID_ROW_GROUPING_SINGLE_GROUPING_FIELD || getRowGroupingCriteriaFromGroupingField(field) !== null;
+
+/**
+ * When filtering a group, we only want to filter according to the items related to this grouping column.
+ */
+const shouldApplyFilterItemOnGroup = (item, node) => {
+  if (item.columnField === GRID_ROW_GROUPING_SINGLE_GROUPING_FIELD) {
+    return true;
+  }
+
+  const groupingCriteriaField = getRowGroupingCriteriaFromGroupingField(item.columnField);
+  return groupingCriteriaField === node.groupingField;
+};
+/**
+ * A leaf is visible if it passed the filter
+ * A group is visible if all the following criteria are met:
+ * - One of its children is passing the filter
+ * - It is passing the filter
+ */
+
+
+export const filterRowTreeFromGroupingColumns = params => {
+  const {
+    rowTree,
+    isRowMatchingFilters
+  } = params;
+  const visibleRowsLookup = {};
+  const filteredRowsLookup = {};
+  const filteredDescendantCountLookup = {};
+
+  const filterTreeNode = (node, areAncestorsPassingChildren, areAncestorsExpanded) => {
+    var _node$children, _node$children2;
+
+    let isMatchingFilters;
+
+    if (!isRowMatchingFilters) {
+      isMatchingFilters = true;
+    } else {
+      const shouldApplyItem = node.isAutoGenerated ? item => shouldApplyFilterItemOnGroup(item, node) : undefined;
+      isMatchingFilters = isRowMatchingFilters(node.id, shouldApplyItem);
+    }
+
+    let filteredDescendantCount = 0;
+    (_node$children = node.children) == null ? void 0 : _node$children.forEach(childId => {
+      const childNode = rowTree[childId];
+      const childSubTreeSize = filterTreeNode(childNode, areAncestorsPassingChildren && isMatchingFilters, areAncestorsExpanded && !!node.childrenExpanded);
+      filteredDescendantCount += childSubTreeSize;
+    });
+    let shouldPassFilters;
+
+    if (!areAncestorsPassingChildren) {
+      shouldPassFilters = false;
+    } else if ((_node$children2 = node.children) != null && _node$children2.length) {
+      shouldPassFilters = isMatchingFilters && filteredDescendantCount > 0;
+    } else {
+      shouldPassFilters = isMatchingFilters;
+    }
+
+    visibleRowsLookup[node.id] = shouldPassFilters && areAncestorsExpanded;
+    filteredRowsLookup[node.id] = shouldPassFilters;
+
+    if (!shouldPassFilters) {
+      return 0;
+    }
+
+    filteredDescendantCountLookup[node.id] = filteredDescendantCount;
+
+    if (!node.children) {
+      return filteredDescendantCount + 1;
+    }
+
+    return filteredDescendantCount;
+  };
+
+  const nodes = Object.values(rowTree);
+
+  for (let i = 0; i < nodes.length; i += 1) {
+    const node = nodes[i];
+
+    if (node.depth === 0) {
+      filterTreeNode(node, true, true);
+    }
+  }
+
+  return {
+    visibleRowsLookup,
+    filteredRowsLookup,
+    filteredDescendantCountLookup
+  };
+};
+export const getColDefOverrides = (groupingColDefProp, fields) => {
+  if (typeof groupingColDefProp === 'function') {
+    return groupingColDefProp({
+      groupingName: GROUPING_COLUMNS_FEATURE_NAME,
+      fields
+    });
+  }
+
+  return groupingColDefProp;
+};
+export const mergeStateWithRowGroupingModel = rowGroupingModel => state => _extends({}, state, {
+  rowGrouping: _extends({}, state.rowGrouping, {
+    model: rowGroupingModel
+  })
+});

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

@@ -0,0 +1,3 @@
+export * from './gridRowGroupingSelector';
+export * from './gridRowGroupingInterfaces';
+export { GRID_ROW_GROUPING_SINGLE_GROUPING_FIELD, getRowGroupingFieldFromGroupingCriteria, } from './gridRowGroupingUtils';

package/hooks/features/rowGrouping/index.js

@@ -0,0 +1,3 @@
+export * from './gridRowGroupingSelector';
+export * from './gridRowGroupingInterfaces';
+export { GRID_ROW_GROUPING_SINGLE_GROUPING_FIELD, getRowGroupingFieldFromGroupingCriteria } from './gridRowGroupingUtils';

package/hooks/features/rowGrouping/useGridRowGrouping.d.ts

@@ -0,0 +1,13 @@
+import * as React from 'react';
+import { GridStateInitializer } from '@mui/x-data-grid/internals';
+import { GridApiPro } from '../../../models/gridApiPro';
+import { DataGridProProcessedProps } from '../../../models/dataGridProProps';
+export declare const rowGroupingStateInitializer: GridStateInitializer<Pick<DataGridProProcessedProps, 'rowGroupingModel' | 'initialState'>>;
+/**
+ * Only available in DataGridPro
+ * @requires useGridColumns (state, method) - can be after, async only
+ * @requires useGridRows (state, method) - can be after, async only
+ * @requires useGridParamsApi (method) - can be after, async only
+ * TODO: Move the the Premium plan once available and remove the `experimentalFeatures.rowGrouping` flag
+ */
+export declare const useGridRowGrouping: (apiRef: React.MutableRefObject<GridApiPro>, props: Pick<DataGridProProcessedProps, 'initialState' | 'rowGroupingModel' | 'onRowGroupingModelChange' | 'defaultGroupingExpansionDepth' | 'isGroupExpandedByDefault' | 'groupingColDef' | 'rowGroupingColumnMode' | 'disableRowGrouping'>) => void;

package/hooks/features/rowGrouping/useGridRowGrouping.js

@@ -0,0 +1,325 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import * as React from 'react';
+import Divider from '@mui/material/Divider';
+import { GridEvents, gridRowIdsSelector, gridRowTreeSelector, useGridApiEventHandler, useGridApiMethod, gridColumnLookupSelector, gridFilteredDescendantCountLookupSelector, useFirstRender } from '@mui/x-data-grid';
+import { useGridRegisterPreProcessor, useGridRegisterSortingMethod, useGridRegisterFilteringMethod, isDeepEqual } from '@mui/x-data-grid/internals';
+import { buildRowTree } from '../../../utils/tree/buildRowTree';
+import { gridRowGroupingModelSelector, gridRowGroupingSanitizedModelSelector } from './gridRowGroupingSelector';
+import { filterRowTreeFromGroupingColumns, getRowGroupingFieldFromGroupingCriteria, GROUPING_COLUMNS_FEATURE_NAME, isGroupingColumn, mergeStateWithRowGroupingModel } from './gridRowGroupingUtils';
+import { sortRowTree } from '../../../utils/tree/sortRowTree';
+import { GridRowGroupableColumnMenuItems } from '../../../components/GridRowGroupableColumnMenuItems';
+import { GridRowGroupingColumnMenuItems } from '../../../components/GridRowGroupingColumnMenuItems';
+import { jsx as _jsx } from "react/jsx-runtime";
+export const rowGroupingStateInitializer = (state, props) => {
+  var _ref, _props$rowGroupingMod, _props$initialState, _props$initialState$r;
+
+  return _extends({}, state, {
+    rowGrouping: {
+      model: (_ref = (_props$rowGroupingMod = props.rowGroupingModel) != null ? _props$rowGroupingMod : (_props$initialState = props.initialState) == null ? void 0 : (_props$initialState$r = _props$initialState.rowGrouping) == null ? void 0 : _props$initialState$r.model) != null ? _ref : []
+    }
+  });
+};
+/**
+ * Only available in DataGridPro
+ * @requires useGridColumns (state, method) - can be after, async only
+ * @requires useGridRows (state, method) - can be after, async only
+ * @requires useGridParamsApi (method) - can be after, async only
+ * TODO: Move the the Premium plan once available and remove the `experimentalFeatures.rowGrouping` flag
+ */
+
+export const useGridRowGrouping = (apiRef, props) => {
+  apiRef.current.unstable_updateControlState({
+    stateId: 'rowGrouping',
+    propModel: props.rowGroupingModel,
+    propOnChange: props.onRowGroupingModelChange,
+    stateSelector: gridRowGroupingModelSelector,
+    changeEvent: GridEvents.rowGroupingModelChange
+  });
+  /**
+   * ROW GROUPING
+   */
+  // Tracks the model on the last pre-processing to check if we need to re-build the grouping columns when the grid upserts a column.
+
+  const sanitizedModelOnLastRowPreProcessing = React.useRef([]);
+  const updateRowGrouping = React.useCallback(() => {
+    const groupRows = params => {
+      const rowGroupingModel = gridRowGroupingSanitizedModelSelector(apiRef);
+      const columnsLookup = gridColumnLookupSelector(apiRef);
+      sanitizedModelOnLastRowPreProcessing.current = rowGroupingModel;
+
+      if (props.disableRowGrouping || rowGroupingModel.length === 0) {
+        return null;
+      }
+
+      const distinctValues = Object.fromEntries(rowGroupingModel.map(groupingField => [groupingField, {
+        lookup: {},
+        list: []
+      }]));
+
+      const getCellGroupingCriteria = ({
+        row,
+        id,
+        colDef
+      }) => {
+        let key;
+
+        if (colDef.groupingValueGetter) {
+          const groupingValueGetterParams = {
+            colDef,
+            field: colDef.field,
+            value: row[colDef.field],
+            id,
+            row,
+            rowNode: {
+              isAutoGenerated: false,
+              id
+            }
+          };
+          key = colDef.groupingValueGetter(groupingValueGetterParams);
+        } else {
+          key = row[colDef.field];
+        }
+
+        return {
+          key,
+          field: colDef.field
+        };
+      };
+
+      params.ids.forEach(rowId => {
+        const row = params.idRowsLookup[rowId];
+        rowGroupingModel.forEach(groupingCriteria => {
+          const {
+            key
+          } = getCellGroupingCriteria({
+            row,
+            id: rowId,
+            colDef: columnsLookup[groupingCriteria]
+          });
+          const groupingFieldsDistinctKeys = distinctValues[groupingCriteria];
+
+          if (key != null && !groupingFieldsDistinctKeys.lookup[key.toString()]) {
+            groupingFieldsDistinctKeys.lookup[key.toString()] = true;
+            groupingFieldsDistinctKeys.list.push(key);
+          }
+        });
+      });
+      const rows = params.ids.map(rowId => {
+        const row = params.idRowsLookup[rowId];
+        const parentPath = rowGroupingModel.map(groupingField => getCellGroupingCriteria({
+          row,
+          id: rowId,
+          colDef: columnsLookup[groupingField]
+        })).filter(cell => cell.key != null);
+        const leafGroupingCriteria = {
+          key: rowId.toString(),
+          field: null
+        };
+        return {
+          path: [...parentPath, leafGroupingCriteria],
+          id: rowId
+        };
+      });
+      return buildRowTree(_extends({}, params, {
+        rows,
+        defaultGroupingExpansionDepth: props.defaultGroupingExpansionDepth,
+        isGroupExpandedByDefault: props.isGroupExpandedByDefault,
+        groupingName: GROUPING_COLUMNS_FEATURE_NAME
+      }));
+    };
+
+    return apiRef.current.unstable_registerRowGroupsBuilder('rowGrouping', groupRows);
+  }, [apiRef, props.defaultGroupingExpansionDepth, props.isGroupExpandedByDefault, props.disableRowGrouping]);
+  useFirstRender(() => {
+    updateRowGrouping();
+  });
+  const isFirstRender = React.useRef(true);
+  React.useEffect(() => {
+    if (isFirstRender.current) {
+      isFirstRender.current = false;
+      return () => {};
+    }
+
+    return updateRowGrouping();
+  }, [updateRowGrouping]);
+  /**
+   * PRE-PROCESSING
+   */
+
+  const addColumnMenuButtons = React.useCallback((initialValue, columns) => {
+    if (props.disableRowGrouping) {
+      return initialValue;
+    }
+
+    let menuItems;
+
+    if (isGroupingColumn(columns.field)) {
+      menuItems = /*#__PURE__*/_jsx(GridRowGroupingColumnMenuItems, {});
+    } else if (columns.groupable) {
+      menuItems = /*#__PURE__*/_jsx(GridRowGroupableColumnMenuItems, {});
+    } else {
+      menuItems = null;
+    }
+
+    if (menuItems == null) {
+      return initialValue;
+    }
+
+    return [...initialValue, /*#__PURE__*/_jsx(Divider, {}), menuItems];
+  }, [props.disableRowGrouping]);
+  const filteringMethod = React.useCallback(params => {
+    const rowTree = gridRowTreeSelector(apiRef);
+    return filterRowTreeFromGroupingColumns({
+      rowTree,
+      isRowMatchingFilters: params.isRowMatchingFilters
+    });
+  }, [apiRef]);
+  const sortingMethod = React.useCallback(params => {
+    const rowTree = gridRowTreeSelector(apiRef);
+    const rowIds = gridRowIdsSelector(apiRef);
+    return sortRowTree({
+      rowTree,
+      rowIds,
+      sortRowList: params.sortRowList,
+      disableChildrenSorting: false
+    });
+  }, [apiRef]);
+  useGridRegisterPreProcessor(apiRef, 'columnMenu', addColumnMenuButtons);
+  useGridRegisterFilteringMethod(apiRef, GROUPING_COLUMNS_FEATURE_NAME, filteringMethod);
+  useGridRegisterSortingMethod(apiRef, GROUPING_COLUMNS_FEATURE_NAME, sortingMethod);
+  /**
+   * API METHODS
+   */
+
+  const setRowGroupingModel = React.useCallback(model => {
+    const currentModel = gridRowGroupingModelSelector(apiRef);
+
+    if (currentModel !== model) {
+      apiRef.current.setState(mergeStateWithRowGroupingModel(model));
+      updateRowGrouping();
+      apiRef.current.forceUpdate();
+    }
+  }, [apiRef, updateRowGrouping]);
+  const addRowGroupingCriteria = React.useCallback((field, groupingIndex) => {
+    const currentModel = gridRowGroupingModelSelector(apiRef);
+
+    if (currentModel.includes(field)) {
+      return;
+    }
+
+    const cleanGroupingIndex = groupingIndex != null ? groupingIndex : currentModel.length;
+    const updatedModel = [...currentModel.slice(0, cleanGroupingIndex), field, ...currentModel.slice(cleanGroupingIndex)];
+    apiRef.current.setRowGroupingModel(updatedModel);
+  }, [apiRef]);
+  const removeRowGroupingCriteria = React.useCallback(field => {
+    const currentModel = gridRowGroupingModelSelector(apiRef);
+
+    if (!currentModel.includes(field)) {
+      return;
+    }
+
+    apiRef.current.setRowGroupingModel(currentModel.filter(el => el !== field));
+  }, [apiRef]);
+  const setRowGroupingCriteriaIndex = React.useCallback((field, targetIndex) => {
+    const currentModel = gridRowGroupingModelSelector(apiRef);
+    const currentTargetIndex = currentModel.indexOf(field);
+
+    if (currentTargetIndex === -1) {
+      return;
+    }
+
+    const updatedModel = [...currentModel];
+    updatedModel.splice(targetIndex, 0, updatedModel.splice(currentTargetIndex, 1)[0]);
+    apiRef.current.setRowGroupingModel(updatedModel);
+  }, [apiRef]);
+  const rowGroupingApi = {
+    setRowGroupingModel,
+    addRowGroupingCriteria,
+    removeRowGroupingCriteria,
+    setRowGroupingCriteriaIndex
+  };
+  useGridApiMethod(apiRef, rowGroupingApi, 'GridRowGroupingApi');
+  /**
+   * PRE-PROCESSING
+   */
+
+  const stateExportPreProcessing = React.useCallback(prevState => {
+    if (props.disableRowGrouping) {
+      return prevState;
+    }
+
+    const rowGroupingModelToExport = gridRowGroupingModelSelector(apiRef);
+
+    if (rowGroupingModelToExport.length === 0) {
+      return prevState;
+    }
+
+    return _extends({}, prevState, {
+      rowGrouping: {
+        model: rowGroupingModelToExport
+      }
+    });
+  }, [apiRef, props.disableRowGrouping]);
+  const stateRestorePreProcessing = React.useCallback((params, context) => {
+    var _context$stateToResto;
+
+    if (props.disableRowGrouping) {
+      return params;
+    }
+
+    const rowGroupingModel = (_context$stateToResto = context.stateToRestore.rowGrouping) == null ? void 0 : _context$stateToResto.model;
+
+    if (rowGroupingModel != null) {
+      apiRef.current.setState(mergeStateWithRowGroupingModel(rowGroupingModel));
+    }
+
+    return params;
+  }, [apiRef, props.disableRowGrouping]);
+  useGridRegisterPreProcessor(apiRef, 'exportState', stateExportPreProcessing);
+  useGridRegisterPreProcessor(apiRef, 'restoreState', stateRestorePreProcessing);
+  /**
+   * EVENTS
+   */
+
+  const handleCellKeyDown = React.useCallback((params, event) => {
+    const cellParams = apiRef.current.getCellParams(params.id, params.field);
+
+    if (isGroupingColumn(cellParams.field) && event.key === ' ' && !event.shiftKey) {
+      var _gridFilteredDescenda;
+
+      event.stopPropagation();
+      event.preventDefault();
+      const filteredDescendantCount = (_gridFilteredDescenda = gridFilteredDescendantCountLookupSelector(apiRef)[params.id]) != null ? _gridFilteredDescenda : 0;
+      const isOnGroupingCell = props.rowGroupingColumnMode === 'single' || getRowGroupingFieldFromGroupingCriteria(params.rowNode.groupingField) === params.field;
+
+      if (!isOnGroupingCell || filteredDescendantCount === 0) {
+        return;
+      }
+
+      apiRef.current.setRowChildrenExpansion(params.id, !params.rowNode.childrenExpanded);
+    }
+  }, [apiRef, props.rowGroupingColumnMode]);
+  const checkGroupingColumnsModelDiff = React.useCallback(() => {
+    const rowGroupingModel = gridRowGroupingSanitizedModelSelector(apiRef);
+    const lastGroupingColumnsModelApplied = sanitizedModelOnLastRowPreProcessing.current;
+
+    if (!isDeepEqual(lastGroupingColumnsModelApplied, rowGroupingModel)) {
+      sanitizedModelOnLastRowPreProcessing.current = rowGroupingModel; // Refresh the column pre-processing
+
+      apiRef.current.updateColumns([]);
+      updateRowGrouping();
+    }
+  }, [apiRef, updateRowGrouping]);
+  useGridApiEventHandler(apiRef, GridEvents.cellKeyDown, handleCellKeyDown);
+  useGridApiEventHandler(apiRef, GridEvents.columnsChange, checkGroupingColumnsModelDiff);
+  useGridApiEventHandler(apiRef, GridEvents.rowGroupingModelChange, checkGroupingColumnsModelDiff);
+  /**
+   * EFFECTS
+   */
+
+  React.useEffect(() => {
+    if (props.rowGroupingModel !== undefined) {
+      apiRef.current.setRowGroupingModel(props.rowGroupingModel);
+    }
+  }, [apiRef, props.rowGroupingModel]);
+};

package/hooks/features/rowGrouping/useGridRowGroupingPreProcessors.d.ts

@@ -0,0 +1,4 @@
+import * as React from 'react';
+import { DataGridProProcessedProps } from '../../../models/dataGridProProps';
+import { GridApiPro } from '../../../models/gridApiPro';
+export declare const useGridRowGroupingPreProcessors: (apiRef: React.MutableRefObject<GridApiPro>, props: Pick<DataGridProProcessedProps, 'disableRowGrouping' | 'groupingColDef' | 'rowGroupingColumnMode'>) => void;

package/hooks/features/rowGrouping/useGridRowGroupingPreProcessors.js

@@ -0,0 +1,76 @@
+import * as React from 'react';
+import { useGridRegisterPreProcessor } from '@mui/x-data-grid/internals';
+import { gridRowGroupingModelSelector } from './gridRowGroupingSelector';
+import { createGroupingColDefForAllGroupingCriteria, createGroupingColDefForOneGroupingCriteria } from './createGroupingColDef';
+import { getColDefOverrides, isGroupingColumn } from './gridRowGroupingUtils';
+export const useGridRowGroupingPreProcessors = (apiRef, props) => {
+  const getGroupingColDefs = React.useCallback(columnsState => {
+    if (props.disableRowGrouping) {
+      return [];
+    }
+
+    const groupingColDefProp = props.groupingColDef; // We can't use `gridGroupingRowsSanitizedModelSelector` here because the new columns are not in the state yet
+
+    const rowGroupingModel = gridRowGroupingModelSelector(apiRef).filter(field => !!columnsState.lookup[field]);
+
+    if (rowGroupingModel.length === 0) {
+      return [];
+    }
+
+    switch (props.rowGroupingColumnMode) {
+      case 'single':
+        {
+          return [createGroupingColDefForAllGroupingCriteria({
+            apiRef,
+            rowGroupingModel,
+            colDefOverride: getColDefOverrides(groupingColDefProp, rowGroupingModel),
+            columnsLookup: columnsState.lookup
+          })];
+        }
+
+      case 'multiple':
+        {
+          return rowGroupingModel.map(groupingCriteria => createGroupingColDefForOneGroupingCriteria({
+            groupingCriteria,
+            colDefOverride: getColDefOverrides(groupingColDefProp, [groupingCriteria]),
+            groupedByColDef: columnsState.lookup[groupingCriteria],
+            columnsLookup: columnsState.lookup
+          }));
+        }
+
+      default:
+        {
+          return [];
+        }
+    }
+  }, [apiRef, props.groupingColDef, props.rowGroupingColumnMode, props.disableRowGrouping]);
+  const updateGroupingColumn = React.useCallback(columnsState => {
+    const groupingColDefs = getGroupingColDefs(columnsState);
+    let newColumnFields = [];
+    const newColumnsLookup = {}; // We only keep the non-grouping columns
+
+    columnsState.all.forEach(field => {
+      if (!isGroupingColumn(field)) {
+        newColumnFields.push(field);
+        newColumnsLookup[field] = columnsState.lookup[field];
+      }
+    }); // We add the grouping column
+
+    groupingColDefs.forEach(groupingColDef => {
+      const matchingGroupingColDef = columnsState.lookup[groupingColDef.field];
+
+      if (matchingGroupingColDef) {
+        groupingColDef.width = matchingGroupingColDef.width;
+        groupingColDef.flex = matchingGroupingColDef.flex;
+      }
+
+      newColumnsLookup[groupingColDef.field] = groupingColDef;
+    });
+    const startIndex = newColumnFields[0] === '__check__' ? 1 : 0;
+    newColumnFields = [...newColumnFields.slice(0, startIndex), ...groupingColDefs.map(colDef => colDef.field), ...newColumnFields.slice(startIndex)];
+    columnsState.all = newColumnFields;
+    columnsState.lookup = newColumnsLookup;
+    return columnsState;
+  }, [getGroupingColDefs]);
+  useGridRegisterPreProcessor(apiRef, 'hydrateColumns', updateGroupingColumn);
+};

package/hooks/features/treeData/gridTreeDataGroupColDef.d.ts

@@ -0,0 +1,7 @@
+import { GridColDef } from '@mui/x-data-grid';
+/**
+ * TODO: Add sorting and filtering on the value and the filteredDescendantCount
+ */
+export declare const GRID_TREE_DATA_GROUPING_COL_DEF: Omit<GridColDef, 'field' | 'editable'>;
+export declare const GRID_TREE_DATA_GROUPING_FIELD = "__tree_data_group__";
+export declare const GRID_TREE_DATA_GROUPING_COL_DEF_FORCED_PROPERTIES: Pick<GridColDef, 'field' | 'editable' | 'groupable'>;

package/hooks/features/treeData/gridTreeDataGroupColDef.js

@@ -0,0 +1,22 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import { GRID_STRING_COL_DEF } from '@mui/x-data-grid';
+/**
+ * TODO: Add sorting and filtering on the value and the filteredDescendantCount
+ */
+
+export const GRID_TREE_DATA_GROUPING_COL_DEF = _extends({}, GRID_STRING_COL_DEF, {
+  type: 'treeDataGroup',
+  sortable: false,
+  filterable: false,
+  disableColumnMenu: true,
+  disableReorder: true,
+  align: 'left',
+  width: 200,
+  valueGetter: params => params.rowNode.groupingKey
+});
+export const GRID_TREE_DATA_GROUPING_FIELD = '__tree_data_group__';
+export const GRID_TREE_DATA_GROUPING_COL_DEF_FORCED_PROPERTIES = {
+  field: GRID_TREE_DATA_GROUPING_FIELD,
+  editable: false,
+  groupable: false
+};

package/hooks/features/treeData/gridTreeDataUtils.d.ts

@@ -0,0 +1,14 @@
+import { GridRowTreeConfig, GridFilterState } from '@mui/x-data-grid';
+import { GridAggregatedFilterItemApplier } from '@mui/x-data-grid/internals';
+interface FilterRowTreeFromTreeDataParams {
+    rowTree: GridRowTreeConfig;
+    disableChildrenFiltering: boolean;
+    isRowMatchingFilters: GridAggregatedFilterItemApplier | null;
+}
+/**
+ * A node is visible if one of the following criteria is met:
+ * - One of its children is passing the filter
+ * - It is passing the filter
+ */
+export declare const filterRowTreeFromTreeData: (params: FilterRowTreeFromTreeDataParams) => Omit<GridFilterState, 'filterModel'>;
+export {};