@mui/x-data-grid 5.6.0 → 5.8.0

package/modern/hooks/features/editRows/useGridRowEditing.new.js

@@ -0,0 +1,499 @@
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+import _toPropertyKey from "@babel/runtime/helpers/esm/toPropertyKey";
+import _extends from "@babel/runtime/helpers/esm/extends";
+import * as React from 'react';
+import { useGridApiEventHandler, useGridApiOptionHandler } from '../../utils/useGridApiEventHandler';
+import { GridEvents } from '../../../models/events/gridEvents';
+import { GridEditModes, GridRowModes } from '../../../models/gridEditRowModel';
+import { useGridApiMethod } from '../../utils/useGridApiMethod';
+import { gridEditRowsStateSelector } from './gridEditRowsSelector';
+import { isPrintableKey } from '../../../utils/keyboardUtils';
+import { gridColumnFieldsSelector } from '../columns/gridColumnsSelector';
+import { buildWarning } from '../../../utils/warning';
+import { GridRowEditStopReasons, GridRowEditStartReasons } from '../../../models/params/gridRowParams';
+const missingOnProcessRowUpdateErrorWarning = buildWarning(['MUI: A call to `processRowUpdate` threw an error which was not handled because `onProcessRowUpdateError` is missing.', 'To handle the error pass a callback to the `onProcessRowUpdateError` prop, e.g. `<DataGrid onProcessRowUpdateError={(error) => ...} />`.', 'For more detail, see http://mui.com/components/data-grid/editing/#persistence.'], 'error');
+export const useGridRowEditing = (apiRef, props) => {
+  const focusTimeout = React.useRef(null);
+  const nextFocusedCell = React.useRef(null);
+  const {
+    processRowUpdate,
+    onProcessRowUpdateError
+  } = props;
+
+  const runIfEditModeIsRow = callback => (...args) => {
+    if (props.editMode === GridEditModes.Row) {
+      callback(...args);
+    }
+  };
+
+  const throwIfNotEditable = React.useCallback((id, field) => {
+    const params = apiRef.current.getCellParams(id, field);
+
+    if (!apiRef.current.isCellEditable(params)) {
+      throw new Error(`MUI: The cell with id=${id} and field=${field} is not editable.`);
+    }
+  }, [apiRef]);
+  const throwIfNotInMode = React.useCallback((id, mode) => {
+    if (apiRef.current.getRowMode(id) !== mode) {
+      throw new Error(`MUI: The row with id=${id} is not in ${mode} mode.`);
+    }
+  }, [apiRef]);
+  const handleCellDoubleClick = React.useCallback((params, event) => {
+    if (!params.isEditable) {
+      return;
+    }
+
+    if (apiRef.current.getRowMode(params.id) === GridRowModes.Edit) {
+      return;
+    }
+
+    const rowParams = apiRef.current.getRowParams(params.id);
+
+    const newParams = _extends({}, rowParams, {
+      field: params.field,
+      reason: GridRowEditStartReasons.cellDoubleClick
+    });
+
+    apiRef.current.publishEvent(GridEvents.rowEditStart, newParams, event);
+  }, [apiRef]);
+  const handleCellFocusIn = React.useCallback(params => {
+    nextFocusedCell.current = params;
+  }, []);
+  const handleCellFocusOut = React.useCallback((params, event) => {
+    if (!params.isEditable) {
+      return;
+    }
+
+    if (apiRef.current.getRowMode(params.id) === GridRowModes.View) {
+      return;
+    } // The mechanism to detect if we can stop editing a row is different from
+    // the cell editing. Instead of triggering it when clicking outside a cell,
+    // we must check if another cell in the same row was not clicked. To achieve
+    // that, first we keep track of all cells that gained focus. When a cell loses
+    // focus we check if the next cell that received focus is from a different row.
+
+
+    nextFocusedCell.current = null;
+    focusTimeout.current = setTimeout(() => {
+      focusTimeout.current = null;
+
+      if (nextFocusedCell.current?.id !== params.id) {
+        const rowParams = apiRef.current.getRowParams(params.id);
+
+        const newParams = _extends({}, rowParams, {
+          field: params.field,
+          reason: GridRowEditStopReasons.rowFocusOut
+        });
+
+        apiRef.current.publishEvent(GridEvents.rowEditStop, newParams, event);
+      }
+    });
+  }, [apiRef]);
+  React.useEffect(() => {
+    return () => {
+      clearTimeout(focusTimeout.current);
+    };
+  }, []);
+  const handleCellKeyDown = React.useCallback((params, event) => {
+    if (params.cellMode === GridRowModes.Edit) {
+      let reason;
+
+      if (event.key === 'Escape') {
+        reason = GridRowEditStopReasons.escapeKeyDown;
+      } else if (event.key === 'Enter') {
+        reason = GridRowEditStopReasons.enterKeyDown;
+      } else if (event.key === 'Tab') {
+        const columnFields = gridColumnFieldsSelector(apiRef).filter(field => apiRef.current.isCellEditable(apiRef.current.getCellParams(params.id, field)));
+
+        if (event.shiftKey) {
+          if (params.field === columnFields[0]) {
+            // Exit if user pressed Shift+Tab on the first field
+            reason = GridRowEditStopReasons.shiftTabKeyDown;
+          }
+        } else if (params.field === columnFields[columnFields.length - 1]) {
+          // Exit if user pressed Tab on the last field
+          reason = GridRowEditStopReasons.tabKeyDown;
+        }
+
+        if (reason) {
+          event.preventDefault(); // Prevent going to the next element in the tab sequence
+        }
+      }
+
+      if (reason) {
+        const rowParams = apiRef.current.getRowParams(params.id);
+
+        const newParams = _extends({}, rowParams, {
+          reason,
+          field: params.field
+        });
+
+        apiRef.current.publishEvent(GridEvents.rowEditStop, newParams, event);
+      }
+    } else if (params.isEditable) {
+      let reason;
+
+      if (isPrintableKey(event.key)) {
+        if (event.shiftKey || event.ctrlKey || event.metaKey || event.altKey) {
+          return;
+        }
+
+        reason = GridRowEditStartReasons.printableKeyDown;
+      } else if (event.key === 'Enter') {
+        reason = GridRowEditStartReasons.enterKeyDown;
+      } else if (event.key === 'Delete') {
+        reason = GridRowEditStartReasons.deleteKeyDown;
+      }
+
+      if (reason) {
+        const rowParams = apiRef.current.getRowParams(params.id);
+
+        const newParams = _extends({}, rowParams, {
+          field: params.field,
+          reason
+        });
+
+        apiRef.current.publishEvent(GridEvents.rowEditStart, newParams, event);
+      }
+    }
+  }, [apiRef]);
+  const handleRowEditStart = React.useCallback((params, event) => {
+    const {
+      id,
+      field,
+      reason
+    } = params;
+    apiRef.current.startRowEditMode({
+      id,
+      fieldToFocus: field
+    });
+
+    if (reason === GridRowEditStartReasons.deleteKeyDown || reason === GridRowEditStartReasons.printableKeyDown) {
+      apiRef.current.setEditCellValue({
+        id,
+        field: field,
+        value: ''
+      }, event);
+    }
+  }, [apiRef]);
+  const handleRowEditStop = React.useCallback(params => {
+    const {
+      id,
+      reason,
+      field
+    } = params;
+    apiRef.current.unstable_runPendingEditCellValueMutation(id);
+    let cellToFocusAfter;
+
+    if (reason === GridRowEditStopReasons.enterKeyDown) {
+      cellToFocusAfter = 'below';
+    } else if (reason === GridRowEditStopReasons.tabKeyDown) {
+      cellToFocusAfter = 'right';
+    } else if (reason === GridRowEditStopReasons.shiftTabKeyDown) {
+      cellToFocusAfter = 'left';
+    }
+
+    let ignoreModifications = reason === 'escapeKeyDown';
+    const editingState = gridEditRowsStateSelector(apiRef.current.state);
+
+    if (!ignoreModifications) {
+      // The user wants to stop editing the cell but we can't wait for the props to be processed.
+      // In this case, discard the modifications if any field is processing its props.
+      ignoreModifications = Object.values(editingState[id]).some(fieldProps => {
+        return fieldProps.isProcessingProps;
+      });
+    }
+
+    apiRef.current.stopRowEditMode({
+      id,
+      ignoreModifications,
+      field,
+      cellToFocusAfter
+    });
+  }, [apiRef]);
+  useGridApiEventHandler(apiRef, GridEvents.cellDoubleClick, runIfEditModeIsRow(handleCellDoubleClick));
+  useGridApiEventHandler(apiRef, GridEvents.cellFocusIn, runIfEditModeIsRow(handleCellFocusIn));
+  useGridApiEventHandler(apiRef, GridEvents.cellFocusOut, runIfEditModeIsRow(handleCellFocusOut));
+  useGridApiEventHandler(apiRef, GridEvents.cellKeyDown, runIfEditModeIsRow(handleCellKeyDown));
+  useGridApiEventHandler(apiRef, GridEvents.rowEditStart, runIfEditModeIsRow(handleRowEditStart));
+  useGridApiEventHandler(apiRef, GridEvents.rowEditStop, runIfEditModeIsRow(handleRowEditStop));
+  useGridApiOptionHandler(apiRef, GridEvents.rowEditStart, props.onRowEditStart);
+  useGridApiOptionHandler(apiRef, GridEvents.rowEditStop, props.onRowEditStop);
+  const getRowMode = React.useCallback(id => {
+    if (props.editMode === GridEditModes.Cell) {
+      return GridRowModes.View;
+    }
+
+    const editingState = gridEditRowsStateSelector(apiRef.current.state);
+    const isEditing = editingState[id] && Object.keys(editingState[id]).length > 0;
+    return isEditing ? GridRowModes.Edit : GridRowModes.View;
+  }, [apiRef, props.editMode]);
+  const updateOrDeleteRowState = React.useCallback((id, newProps) => {
+    apiRef.current.setState(state => {
+      const newEditingState = _extends({}, state.editRows);
+
+      if (newProps !== null) {
+        newEditingState[id] = newProps;
+      } else {
+        delete newEditingState[id];
+      }
+
+      return _extends({}, state, {
+        editRows: newEditingState
+      });
+    });
+    apiRef.current.forceUpdate();
+  }, [apiRef]);
+  const updateOrDeleteFieldState = React.useCallback((id, field, newProps) => {
+    apiRef.current.setState(state => {
+      const newEditingState = _extends({}, state.editRows);
+
+      if (newProps !== null) {
+        newEditingState[id] = _extends({}, newEditingState[id], {
+          [field]: _extends({}, newProps)
+        });
+      } else {
+        delete newEditingState[id][field];
+
+        if (Object.keys(newEditingState[id]).length === 0) {
+          delete newEditingState[id];
+        }
+      }
+
+      return _extends({}, state, {
+        editRows: newEditingState
+      });
+    });
+    apiRef.current.forceUpdate();
+  }, [apiRef]);
+  const startRowEditMode = React.useCallback(params => {
+    const {
+      id,
+      fieldToFocus
+    } = params;
+    throwIfNotInMode(id, GridRowModes.View);
+
+    if (apiRef.current.getRowMode(id) === GridRowModes.Edit) {
+      throw new Error(`MUI: The cell with id=${id} is already in edit mode.`);
+    }
+
+    const columnFields = gridColumnFieldsSelector(apiRef);
+    const newProps = columnFields.reduce((acc, field) => {
+      const cellParams = apiRef.current.getCellParams(id, field);
+
+      if (!cellParams.isEditable) {
+        return acc;
+      }
+
+      acc[field] = {
+        value: apiRef.current.getCellValue(id, field),
+        error: false,
+        isProcessingProps: false
+      };
+      return acc;
+    }, {});
+    updateOrDeleteRowState(id, newProps);
+
+    if (fieldToFocus) {
+      apiRef.current.setCellFocus(id, fieldToFocus);
+    }
+  }, [apiRef, throwIfNotInMode, updateOrDeleteRowState]);
+  const stopRowEditMode = React.useCallback(params => {
+    const {
+      id,
+      ignoreModifications,
+      field: focusedField,
+      cellToFocusAfter = 'none'
+    } = params;
+    throwIfNotInMode(id, GridRowModes.Edit);
+    apiRef.current.unstable_runPendingEditCellValueMutation(id);
+
+    const updateFocusedCellIfNeeded = () => {
+      if (cellToFocusAfter !== 'none' && focusedField) {
+        apiRef.current.unstable_moveFocusToRelativeCell(id, focusedField, cellToFocusAfter);
+      }
+    };
+
+    if (ignoreModifications) {
+      updateFocusedCellIfNeeded();
+      updateOrDeleteRowState(id, null);
+      return;
+    }
+
+    const editingState = gridEditRowsStateSelector(apiRef.current.state);
+    const row = apiRef.current.getRow(id);
+    const isSomeFieldProcessingProps = Object.values(editingState[id]).some(fieldProps => fieldProps.isProcessingProps);
+
+    if (isSomeFieldProcessingProps) {
+      return;
+    }
+
+    const hasSomeFieldWithError = Object.values(editingState[id]).some(fieldProps => fieldProps.error);
+
+    if (hasSomeFieldWithError) {
+      return;
+    }
+
+    let rowUpdate = _extends({}, row);
+
+    Object.entries(editingState[id]).forEach(([field, fieldProps]) => {
+      const column = apiRef.current.getColumn(field);
+
+      if (column.valueSetter) {
+        rowUpdate = column.valueSetter({
+          value: fieldProps.value,
+          row: rowUpdate
+        });
+      } else {
+        rowUpdate[field] = fieldProps.value;
+      }
+    });
+
+    if (processRowUpdate) {
+      const handleError = errorThrown => {
+        if (onProcessRowUpdateError) {
+          onProcessRowUpdateError(errorThrown);
+        } else {
+          missingOnProcessRowUpdateErrorWarning();
+        }
+      };
+
+      try {
+        Promise.resolve(processRowUpdate(rowUpdate, row)).then(finalRowUpdate => {
+          apiRef.current.updateRows([finalRowUpdate]);
+          updateFocusedCellIfNeeded();
+          updateOrDeleteRowState(id, null);
+        }).catch(handleError);
+      } catch (errorThrown) {
+        handleError(errorThrown);
+      }
+    } else {
+      apiRef.current.updateRows([rowUpdate]);
+      updateFocusedCellIfNeeded();
+      updateOrDeleteRowState(id, null);
+    }
+  }, [apiRef, onProcessRowUpdateError, processRowUpdate, throwIfNotInMode, updateOrDeleteRowState]);
+  const setRowEditingEditCellValue = React.useCallback(params => {
+    const {
+      id,
+      field,
+      value
+    } = params;
+    throwIfNotEditable(id, field);
+    const column = apiRef.current.getColumn(field);
+    const row = apiRef.current.getRow(id);
+    let parsedValue = value;
+
+    if (column.valueParser) {
+      parsedValue = column.valueParser(value, apiRef.current.getCellParams(id, field));
+    }
+
+    let editingState = gridEditRowsStateSelector(apiRef.current.state);
+
+    let newProps = _extends({}, editingState[id][field], {
+      value: parsedValue
+    });
+
+    if (!column.preProcessEditCellProps) {
+      updateOrDeleteFieldState(id, field, newProps);
+    }
+
+    return new Promise(resolve => {
+      const promises = [];
+
+      if (column.preProcessEditCellProps) {
+        const hasChanged = newProps.value !== editingState[id][field].value;
+        newProps = _extends({}, newProps, {
+          isProcessingProps: true
+        });
+        updateOrDeleteFieldState(id, field, newProps);
+
+        const _editingState$id = editingState[id],
+              otherFieldsProps = _objectWithoutPropertiesLoose(_editingState$id, [field].map(_toPropertyKey));
+
+        const promise = Promise.resolve(column.preProcessEditCellProps({
+          id,
+          row,
+          props: newProps,
+          hasChanged,
+          otherFieldsProps
+        })).then(processedProps => {
+          // Check again if the row is in edit mode because the user may have
+          // discarded the changes while the props were being processed.
+          if (apiRef.current.getRowMode(id) === GridRowModes.View) {
+            resolve(false);
+            return;
+          }
+
+          editingState = gridEditRowsStateSelector(apiRef.current.state);
+          processedProps = _extends({}, processedProps, {
+            isProcessingProps: false
+          }); // We don't reuse the value from the props pre-processing because when the
+          // promise resolves it may be already outdated. The only exception to this rule
+          // is when there's no pre-processing.
+
+          processedProps.value = column.preProcessEditCellProps ? editingState[id][field].value : parsedValue;
+          updateOrDeleteFieldState(id, field, processedProps);
+        });
+        promises.push(promise);
+      }
+
+      Object.entries(editingState[id]).forEach(([thisField, fieldProps]) => {
+        if (thisField === field) {
+          return;
+        }
+
+        const fieldColumn = apiRef.current.getColumn(thisField);
+
+        if (!fieldColumn.preProcessEditCellProps) {
+          return;
+        }
+
+        fieldProps = _extends({}, fieldProps, {
+          isProcessingProps: true
+        });
+        updateOrDeleteFieldState(id, thisField, fieldProps);
+        editingState = gridEditRowsStateSelector(apiRef.current.state);
+
+        const _editingState$id2 = editingState[id],
+              otherFieldsProps = _objectWithoutPropertiesLoose(_editingState$id2, [thisField].map(_toPropertyKey));
+
+        const promise = Promise.resolve(fieldColumn.preProcessEditCellProps({
+          id,
+          row,
+          props: fieldProps,
+          hasChanged: false,
+          otherFieldsProps
+        })).then(processedProps => {
+          // Check again if the row is in edit mode because the user may have
+          // discarded the changes while the props were being processed.
+          if (apiRef.current.getRowMode(id) === GridRowModes.View) {
+            resolve(false);
+            return;
+          }
+
+          processedProps = _extends({}, processedProps, {
+            isProcessingProps: false
+          });
+          updateOrDeleteFieldState(id, thisField, processedProps);
+        });
+        promises.push(promise);
+      });
+      Promise.all(promises).then(() => {
+        if (apiRef.current.getRowMode(id) === GridRowModes.Edit) {
+          editingState = gridEditRowsStateSelector(apiRef.current.state);
+          resolve(!editingState[id][field].error);
+        } else {
+          resolve(false);
+        }
+      });
+    });
+  }, [apiRef, throwIfNotEditable, updateOrDeleteFieldState]);
+  const editingApi = {
+    getRowMode,
+    startRowEditMode,
+    stopRowEditMode,
+    unstable_setRowEditingEditCellValue: setRowEditingEditCellValue
+  };
+  useGridApiMethod(apiRef, editingApi, 'EditingApi');
+};

package/modern/hooks/features/editRows/{useGridRowEditing.js → useGridRowEditing.old.js}

@@ -4,7 +4,7 @@ import { useEventCallback } from '@mui/material/utils';
 import { useGridApiMethod } from '../../utils/useGridApiMethod';
 import { GridRowModes, GridEditModes, GridCellModes } from '../../../models/gridEditRowModel';
 import { useGridSelector } from '../../utils/useGridSelector';
-import { gridColumnFieldsSelector } from '../columns/gridColumnsSelector';
+import { gridColumnDefinitionsSelector } from '../columns/gridColumnsSelector';
 import { gridEditRowsStateSelector } from './gridEditRowsSelector';
 import { GridEvents } from '../../../models/events/gridEvents';
 import { gridFocusCellSelector } from '../focus/gridFocusStateSelector';
@@ -12,7 +12,7 @@ import { useGridApiOptionHandler, useGridApiEventHandler } from '../../utils/use
 export const useGridRowEditing = (apiRef, props) => {
   const focusTimeout = React.useRef(null);
   const nextFocusedCell = React.useRef(null);
-  const columnFields = useGridSelector(apiRef, gridColumnFieldsSelector);
+  const columns = useGridSelector(apiRef, gridColumnDefinitionsSelector);
 
   const buildCallback = callback => (...args) => {
     if (props.editMode === GridEditModes.Row) {
@@ -30,11 +30,11 @@ export const useGridRowEditing = (apiRef, props) => {
 
       if (mode === GridRowModes.Edit) {
         newEditRowsState[id] = {};
-        columnFields.forEach(field => {
-          const cellParams = apiRef.current.getCellParams(id, field);
+        columns.forEach(column => {
+          const cellParams = apiRef.current.getCellParams(id, column.field);
 
           if (cellParams.isEditable) {
-            newEditRowsState[id][field] = {
+            newEditRowsState[id][column.field] = {
               value: cellParams.value
             };
           }
@@ -48,7 +48,7 @@ export const useGridRowEditing = (apiRef, props) => {
       });
     });
     apiRef.current.forceUpdate();
-  }, [apiRef, columnFields]);
+  }, [apiRef, columns]);
   const getRowMode = React.useCallback(id => {
     if (props.editMode === GridEditModes.Cell) {
       return GridRowModes.View;
@@ -62,7 +62,7 @@ export const useGridRowEditing = (apiRef, props) => {
       throw new Error(`MUI: You can't commit changes when the edit mode is 'cell'.`);
     }
 
-    apiRef.current.unstable_runPendingEditCellValueChangeDebounce(id);
+    apiRef.current.unstable_runPendingEditCellValueMutation(id);
     const model = apiRef.current.getEditRowsModel();
     const editRowProps = model[id];
 

package/modern/hooks/features/events/useGridEvents.js

@@ -17,6 +17,8 @@ export function useGridEvents(apiRef, props) {
   useGridApiOptionHandler(apiRef, GridEvents.cellDoubleClick, props.onCellDoubleClick);
   useGridApiOptionHandler(apiRef, GridEvents.cellKeyDown, props.onCellKeyDown);
   useGridApiOptionHandler(apiRef, GridEvents.cellFocusOut, props.onCellFocusOut);
+  useGridApiOptionHandler(apiRef, GridEvents.preferencePanelClose, props.onPreferencePanelClose);
+  useGridApiOptionHandler(apiRef, GridEvents.preferencePanelOpen, props.onPreferencePanelOpen);
   useGridApiOptionHandler(apiRef, GridEvents.rowDoubleClick, props.onRowDoubleClick);
   useGridApiOptionHandler(apiRef, GridEvents.rowClick, props.onRowClick);
   useGridApiOptionHandler(apiRef, GridEvents.componentError, props.onError);

package/modern/hooks/features/export/serializers/csvSerializer.js

@@ -1,4 +1,5 @@
 import { GRID_CHECKBOX_SELECTION_COL_DEF } from '../../../../colDef';
+import { buildWarning } from '../../../../utils/warning';
 
 const serialiseCellValue = (value, delimiterCharacter) => {
   if (typeof value === 'string') {
@@ -14,15 +15,14 @@ const serialiseCellValue = (value, delimiterCharacter) => {
   return value;
 };
 
-let warnedOnce = false;
+const objectFormattedValueWarning = buildWarning(['MUI: When the value of a field is an object or a `renderCell` is provided, the CSV export might not display the value correctly.', 'You can provide a `valueFormatter` with a string representation to be used.']);
 
 const serialiseRow = (id, columns, getCellParams, delimiterCharacter) => columns.map(column => {
   const cellParams = getCellParams(id, column.field);
 
   if (process.env.NODE_ENV !== 'production') {
-    if (!warnedOnce && String(cellParams.formattedValue) === '[object Object]') {
-      console.warn(['MUI: When the value of a field is an object or a `renderCell` is provided, the CSV export might not display the value correctly.', 'You can provide a `valueFormatter` with a string representation to be used.'].join('\n'));
-      warnedOnce = true;
+    if (String(cellParams.formattedValue) === '[object Object]') {
+      objectFormattedValueWarning();
     }
   }
 

package/modern/hooks/features/filter/gridFilterSelector.js

@@ -63,6 +63,7 @@ export const gridFilteredSortedRowIdsSelector = createSelector(gridFilteredSorte
  * @category Filtering
  * @deprecated Use `gridVisibleSortedRowIdsSelector` instead
  * @ignore - do not document.
+ * TODO: Add deprecation warning once we have the new selectors without the "visible" keyword.
  */
 
 export const gridVisibleRowsSelector = gridVisibleSortedRowIdsSelector;