@mui/x-data-grid 7.0.0-alpha.8 → 7.0.0-beta.0

package/modern/hooks/features/columns/gridColumnsSelector.js

@@ -1,4 +1,7 @@
 import { createSelector, createSelectorMemoized } from '../../../utils/createSelector';
+import { EMPTY_PINNED_COLUMN_FIELDS } from './gridColumnsInterfaces';
+import { gridThemeSelector } from '../../core/gridCoreSelector';
+
 /**
  * Get the columns state
  * @category Columns
@@ -42,6 +45,54 @@ export const gridVisibleColumnDefinitionsSelector = createSelectorMemoized(gridC
  */
 export const gridVisibleColumnFieldsSelector = createSelectorMemoized(gridVisibleColumnDefinitionsSelector, visibleColumns => visibleColumns.map(column => column.field));
 
+/**
+ * Get the visible pinned columns model.
+ * @category Visible Columns
+ */
+export const gridPinnedColumnsSelector = state => state.pinnedColumns;
+
+/**
+ * Get the visible pinned columns.
+ * @category Visible Columns
+ */
+export const gridVisiblePinnedColumnDefinitionsSelector = createSelectorMemoized(gridColumnsStateSelector, gridPinnedColumnsSelector, gridVisibleColumnFieldsSelector, gridThemeSelector, (columnsState, model, visibleColumnFields, theme) => {
+  const visiblePinnedFields = filterVisibleColumns(model, visibleColumnFields, theme.direction === 'rtl');
+  const visiblePinnedColumns = {
+    left: visiblePinnedFields.left.map(field => columnsState.lookup[field]),
+    right: visiblePinnedFields.right.map(field => columnsState.lookup[field])
+  };
+  return visiblePinnedColumns;
+});
+function filterVisibleColumns(pinnedColumns, columns, invert) {
+  if (!Array.isArray(pinnedColumns.left) && !Array.isArray(pinnedColumns.right)) {
+    return EMPTY_PINNED_COLUMN_FIELDS;
+  }
+  if (pinnedColumns.left?.length === 0 && pinnedColumns.right?.length === 0) {
+    return EMPTY_PINNED_COLUMN_FIELDS;
+  }
+  const filter = (newPinnedColumns, remainingColumns) => {
+    if (!Array.isArray(newPinnedColumns)) {
+      return [];
+    }
+    return newPinnedColumns.filter(field => remainingColumns.includes(field));
+  };
+  const leftPinnedColumns = filter(pinnedColumns.left, columns);
+  const columnsWithoutLeftPinnedColumns = columns.filter(
+  // Filter out from the remaining columns those columns already pinned to the left
+  field => !leftPinnedColumns.includes(field));
+  const rightPinnedColumns = filter(pinnedColumns.right, columnsWithoutLeftPinnedColumns);
+  if (invert) {
+    return {
+      left: rightPinnedColumns,
+      right: leftPinnedColumns
+    };
+  }
+  return {
+    left: leftPinnedColumns,
+    right: rightPinnedColumns
+  };
+}
+
 /**
  * Get the left position in pixel of each visible columns relative to the left of the first column.
  * @category Visible Columns

package/modern/hooks/features/columns/gridColumnsUtils.js

@@ -1,10 +1,12 @@
 import _extends from "@babel/runtime/helpers/esm/extends";
-import { DEFAULT_GRID_COL_TYPE_KEY, GRID_STRING_COL_DEF } from '../../../colDef';
+import { DEFAULT_GRID_COL_TYPE_KEY, GRID_STRING_COL_DEF, getGridDefaultColumnTypes } from '../../../colDef';
 import { gridColumnsStateSelector, gridColumnVisibilityModelSelector } from './gridColumnsSelector';
 import { clamp } from '../../../utils/utils';
 import { gridDensityFactorSelector } from '../density/densitySelector';
 import { gridColumnGroupsHeaderMaxDepthSelector } from '../columnGrouping/gridColumnGroupsSelector';
 export const COLUMNS_DIMENSION_PROPERTIES = ['maxWidth', 'minWidth', 'width', 'flex'];
+const COLUMN_TYPES = getGridDefaultColumnTypes();
+
 /**
  * Computes width for flex columns.
  * Based on CSS Flexbox specification:
@@ -196,10 +198,10 @@ export const applyInitialState = (columnsState, initialState) => {
   });
   return newColumnsState;
 };
-function getDefaultColTypeDef(columnTypes, type) {
-  let colDef = columnTypes[DEFAULT_GRID_COL_TYPE_KEY];
-  if (type && columnTypes[type]) {
-    colDef = columnTypes[type];
+function getDefaultColTypeDef(type) {
+  let colDef = COLUMN_TYPES[DEFAULT_GRID_COL_TYPE_KEY];
+  if (type && COLUMN_TYPES[type]) {
+    colDef = COLUMN_TYPES[type];
   }
   return colDef;
 }
@@ -207,7 +209,6 @@ export const createColumnsState = ({
   apiRef,
   columnsToUpsert,
   initialState,
-  columnTypes,
   columnVisibilityModel = gridColumnVisibilityModelSelector(apiRef),
   keepOnlyColumnsToUpsert = false
 }) => {
@@ -243,7 +244,7 @@ export const createColumnsState = ({
     columnsToKeep[field] = true;
     let existingState = columnsState.lookup[field];
     if (existingState == null) {
-      existingState = _extends({}, getDefaultColTypeDef(columnTypes, newColumn.type), {
+      existingState = _extends({}, getDefaultColTypeDef(newColumn.type), {
         field,
         hasBeenResized: false
       });
@@ -254,7 +255,7 @@ export const createColumnsState = ({
 
     // If the column type has changed - merge the existing state with the default column type definition
     if (existingState && existingState.type !== newColumn.type) {
-      existingState = _extends({}, getDefaultColTypeDef(columnTypes, newColumn.type), {
+      existingState = _extends({}, getDefaultColTypeDef(newColumn.type), {
         field
       });
     }
@@ -280,11 +281,8 @@ export const createColumnsState = ({
   }
   const columnsStateWithPreProcessing = apiRef.current.unstable_applyPipeProcessors('hydrateColumns', columnsState);
   const columnsStateWithPortableColumns = applyInitialState(columnsStateWithPreProcessing, initialState);
-  return hydrateColumnsWidth(columnsStateWithPortableColumns, apiRef.current.getRootDimensions?.()?.viewportInnerSize.width ?? 0);
+  return hydrateColumnsWidth(columnsStateWithPortableColumns, apiRef.current.getRootDimensions?.().viewportInnerSize.width ?? 0);
 };
-export const mergeColumnsState = columnsState => state => _extends({}, state, {
-  columns: columnsState
-});
 export function getFirstNonSpannedColumnToRender({
   firstColumnToRender,
   apiRef,

package/modern/hooks/features/columns/index.js

@@ -1 +1,2 @@
-export { gridColumnFieldsSelector, gridColumnLookupSelector, gridColumnDefinitionsSelector, gridColumnVisibilityModelSelector, gridVisibleColumnDefinitionsSelector, gridVisibleColumnFieldsSelector, gridColumnPositionsSelector, gridColumnsTotalWidthSelector, gridFilterableColumnDefinitionsSelector, gridFilterableColumnLookupSelector } from './gridColumnsSelector';
+export * from './gridColumnsSelector';
+export * from './gridColumnsInterfaces';

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

@@ -7,66 +7,9 @@ import { useGridApiEventHandler } from '../../utils/useGridApiEventHandler';
  */
 export const useGridColumnSpanning = apiRef => {
   const lookup = React.useRef({});
-  const setCellColSpanInfo = React.useCallback((rowId, columnIndex, cellColSpanInfo) => {
-    const sizes = lookup.current;
-    if (!sizes[rowId]) {
-      sizes[rowId] = {};
-    }
-    sizes[rowId][columnIndex] = cellColSpanInfo;
-  }, []);
-  const getCellColSpanInfo = React.useCallback((rowId, columnIndex) => {
+  const getCellColSpanInfo = (rowId, columnIndex) => {
     return lookup.current[rowId]?.[columnIndex];
-  }, []);
-
-  // Calculate `colSpan` for the cell.
-  const calculateCellColSpan = React.useCallback(params => {
-    const {
-      columnIndex,
-      rowId,
-      minFirstColumnIndex,
-      maxLastColumnIndex,
-      columns
-    } = params;
-    const columnsLength = columns.length;
-    const column = columns[columnIndex];
-    const colSpan = typeof column.colSpan === 'function' ? column.colSpan(apiRef.current.getCellParams(rowId, column.field)) : column.colSpan;
-    if (!colSpan || colSpan === 1) {
-      setCellColSpanInfo(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(rowId, columnIndex + j, {
-          spannedByColSpan: true,
-          rightVisibleCellIndex: Math.min(columnIndex + colSpan, columnsLength - 1),
-          leftVisibleCellIndex: columnIndex
-        });
-      }
-      setCellColSpanInfo(rowId, columnIndex, {
-        spannedByColSpan: false,
-        cellProps: {
-          colSpan,
-          width
-        }
-      });
-    }
-    return {
-      colSpan
-    };
-  }, [apiRef, setCellColSpanInfo]);
+  };
 
   // Calculate `colSpan` for each cell in the row
   const calculateColSpan = React.useCallback(({
@@ -77,6 +20,8 @@ export const useGridColumnSpanning = apiRef => {
   }) => {
     for (let i = minFirstColumn; i < maxLastColumn; i += 1) {
       const cellProps = calculateCellColSpan({
+        apiRef,
+        lookup: lookup.current,
         columnIndex: i,
         rowId,
         minFirstColumnIndex: minFirstColumn,
@@ -87,7 +32,7 @@ export const useGridColumnSpanning = apiRef => {
         i += cellProps.colSpan - 1;
       }
     }
-  }, [calculateCellColSpan]);
+  }, [apiRef]);
   const columnSpanningPublicApi = {
     unstable_getCellColSpanInfo: getCellColSpanInfo
   };
@@ -101,4 +46,60 @@ export const useGridColumnSpanning = apiRef => {
     lookup.current = {};
   }, []);
   useGridApiEventHandler(apiRef, 'columnOrderChange', handleColumnReorderChange);
-};
+};
+function calculateCellColSpan(params) {
+  const {
+    apiRef,
+    lookup,
+    columnIndex,
+    rowId,
+    minFirstColumnIndex,
+    maxLastColumnIndex,
+    columns
+  } = params;
+  const columnsLength = columns.length;
+  const column = columns[columnIndex];
+  const colSpan = typeof column.colSpan === 'function' ? column.colSpan(apiRef.current.getCellParams(rowId, column.field)) : 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;
+}

package/modern/hooks/features/columns/useGridColumns.js

@@ -5,22 +5,23 @@ import { useGridLogger } from '../../utils/useGridLogger';
 import { gridColumnFieldsSelector, gridColumnDefinitionsSelector, gridColumnLookupSelector, gridColumnsStateSelector, gridColumnVisibilityModelSelector, gridVisibleColumnDefinitionsSelector, gridColumnPositionsSelector } from './gridColumnsSelector';
 import { GridSignature, useGridApiEventHandler } from '../../utils/useGridApiEventHandler';
 import { useGridRegisterPipeProcessor, useGridRegisterPipeApplier } from '../../core/pipeProcessing';
-import { hydrateColumnsWidth, createColumnsState, mergeColumnsState, COLUMNS_DIMENSION_PROPERTIES } from './gridColumnsUtils';
+import { EMPTY_PINNED_COLUMN_FIELDS } from './gridColumnsInterfaces';
+import { hydrateColumnsWidth, createColumnsState, COLUMNS_DIMENSION_PROPERTIES } from './gridColumnsUtils';
 import { GridPreferencePanelsValue } from '../preferencesPanel';
-import { getGridDefaultColumnTypes } from '../../../colDef';
 import { jsx as _jsx } from "react/jsx-runtime";
-const defaultColumnTypes = getGridDefaultColumnTypes();
 export const columnsStateInitializer = (state, props, apiRef) => {
   const columnsState = createColumnsState({
     apiRef,
-    columnTypes: defaultColumnTypes,
     columnsToUpsert: props.columns,
     initialState: props.initialState?.columns,
     columnVisibilityModel: props.columnVisibilityModel ?? props.initialState?.columns?.columnVisibilityModel ?? {},
     keepOnlyColumnsToUpsert: true
   });
   return _extends({}, state, {
-    columns: columnsState
+    columns: columnsState,
+    // In pro/premium, this part of the state is defined. We give it an empty but defined value
+    // for the community version.
+    pinnedColumns: state.pinnedColumns ?? EMPTY_PINNED_COLUMN_FIELDS
   });
 };
 
@@ -31,9 +32,7 @@ export const columnsStateInitializer = (state, props, apiRef) => {
  */
 export function useGridColumns(apiRef, props) {
   const logger = useGridLogger(apiRef, 'useGridColumns');
-  const columnTypes = defaultColumnTypes;
   const previousColumnsProp = React.useRef(props.columns);
-  const previousColumnTypesProp = React.useRef(columnTypes);
   apiRef.current.registerControlState({
     stateId: 'visibleColumns',
     propModel: props.columnVisibilityModel,
@@ -44,8 +43,8 @@ export function useGridColumns(apiRef, props) {
   const setGridColumnsState = React.useCallback(columnsState => {
     logger.debug('Updating columns state.');
     apiRef.current.setState(mergeColumnsState(columnsState));
-    apiRef.current.forceUpdate();
     apiRef.current.publishEvent('columnsChange', columnsState.orderedFields);
+    apiRef.current.forceUpdate();
   }, [logger, apiRef]);
 
   /**
@@ -68,7 +67,6 @@ export function useGridColumns(apiRef, props) {
       apiRef.current.setState(state => _extends({}, state, {
         columns: createColumnsState({
           apiRef,
-          columnTypes,
           columnsToUpsert: [],
           initialState: undefined,
           columnVisibilityModel: model,
@@ -77,17 +75,16 @@ export function useGridColumns(apiRef, props) {
       }));
       apiRef.current.forceUpdate();
     }
-  }, [apiRef, columnTypes]);
+  }, [apiRef]);
   const updateColumns = React.useCallback(columns => {
     const columnsState = createColumnsState({
       apiRef,
-      columnTypes,
       columnsToUpsert: columns,
       initialState: undefined,
       keepOnlyColumnsToUpsert: false
     });
     setGridColumnsState(columnsState);
-  }, [apiRef, setGridColumnsState, columnTypes]);
+  }, [apiRef, setGridColumnsState]);
   const setColumnVisibility = React.useCallback((field, isVisible) => {
     const columnVisibilityModel = gridColumnVisibilityModelSelector(apiRef);
     const isCurrentlyVisible = columnVisibilityModel[field] ?? true;
@@ -134,7 +131,7 @@ export function useGridColumns(apiRef, props) {
       lookup: _extends({}, columnsState.lookup, {
         [field]: newColumn
       })
-    }), apiRef.current.getRootDimensions()?.viewportInnerSize.width ?? 0));
+    }), apiRef.current.getRootDimensions().viewportInnerSize.width));
     apiRef.current.publishEvent('columnWidthChange', {
       element: apiRef.current.getColumnHeaderElement(field),
       colDef: newColumn,
@@ -209,7 +206,6 @@ export function useGridColumns(apiRef, props) {
     }
     const columnsState = createColumnsState({
       apiRef,
-      columnTypes,
       columnsToUpsert: [],
       initialState,
       columnVisibilityModel: columnVisibilityModelToImport,
@@ -220,7 +216,7 @@ export function useGridColumns(apiRef, props) {
       apiRef.current.publishEvent('columnsChange', columnsState.orderedFields);
     }
     return params;
-  }, [apiRef, columnTypes]);
+  }, [apiRef]);
   const preferencePanelPreProcessing = React.useCallback((initialValue, value) => {
     if (value === GridPreferencePanelsValue.columns) {
       const ColumnsPanel = props.slots.columnsPanel;
@@ -258,13 +254,12 @@ export function useGridColumns(apiRef, props) {
     logger.info(`Columns pipe processing have changed, regenerating the columns`);
     const columnsState = createColumnsState({
       apiRef,
-      columnTypes,
       columnsToUpsert: [],
       initialState: undefined,
       keepOnlyColumnsToUpsert: false
     });
     setGridColumnsState(columnsState);
-  }, [apiRef, logger, setGridColumnsState, columnTypes]);
+  }, [apiRef, logger, setGridColumnsState]);
   useGridRegisterPipeApplier(apiRef, 'hydrateColumns', hydrateColumns);
 
   /**
@@ -279,24 +274,27 @@ export function useGridColumns(apiRef, props) {
       return;
     }
     logger.info(`GridColumns have changed, new length ${props.columns.length}`);
-    if (previousColumnsProp.current === props.columns && previousColumnTypesProp.current === columnTypes) {
+    if (previousColumnsProp.current === props.columns) {
       return;
     }
     const columnsState = createColumnsState({
       apiRef,
-      columnTypes,
       initialState: undefined,
       // If the user provides a model, we don't want to set it in the state here because it has it's dedicated `useEffect` which calls `setColumnVisibilityModel`
       columnsToUpsert: props.columns,
       keepOnlyColumnsToUpsert: true
     });
     previousColumnsProp.current = props.columns;
-    previousColumnTypesProp.current = columnTypes;
     setGridColumnsState(columnsState);
-  }, [logger, apiRef, setGridColumnsState, props.columns, columnTypes]);
+  }, [logger, apiRef, setGridColumnsState, props.columns]);
   React.useEffect(() => {
     if (props.columnVisibilityModel !== undefined) {
       apiRef.current.setColumnVisibilityModel(props.columnVisibilityModel);
     }
   }, [apiRef, logger, props.columnVisibilityModel]);
+}
+function mergeColumnsState(columnsState) {
+  return state => _extends({}, state, {
+    columns: columnsState
+  });
 }

package/modern/hooks/features/dimensions/gridDimensionsSelectors.js

@@ -0,0 +1 @@
+export const gridDimensionsSelector = state => state.dimensions;

package/modern/hooks/features/dimensions/index.js

@@ -1 +1,2 @@
+export * from './gridDimensionsSelectors';
 export {};