@mui/x-data-grid 5.8.0 → 5.11.0

package/models/api/gridEditingApi.d.ts

@@ -1,9 +1,52 @@
 import { GridCellMode, GridRowMode } from '../gridCell';
-import { GridEditRowsModel, GridEditCellProps } from '../gridEditRowModel';
-import { GridRowId } from '../gridRows';
+import { GridEditRowsModel, GridEditCellProps, GridCellModes, GridRowModes } from '../gridEditRowModel';
+import { GridRowId, GridRowModel } from '../gridRows';
 import { GridCellParams } from '../params/gridCellParams';
 import { GridCommitCellChangeParams, GridEditCellValueParams, GridEditCellPropsParams } from '../params/gridEditCellParams';
 import { MuiBaseEvent } from '../muiEvent';
+export declare type GridCellModesModelProps = ({
+    mode: GridCellModes.View;
+} & Omit<GridStopCellEditModeParams, 'id' | 'field'>) | ({
+    mode: GridCellModes.Edit;
+} & Omit<GridStartCellEditModeParams, 'id' | 'field'>);
+export declare type GridCellModesModel = Record<GridRowId, Record<string, GridCellModesModelProps>>;
+export declare type GridRowModesModelProps = ({
+    mode: GridRowModes.View;
+} & Omit<GridStopRowEditModeParams, 'id' | 'field'>) | ({
+    mode: GridRowModes.Edit;
+} & Omit<GridStartRowEditModeParams, 'id' | 'field'>);
+export declare type GridRowModesModel = Record<GridRowId, GridRowModesModelProps>;
+export interface GridNewEditingSharedApi {
+    /**
+     * Controls if a cell is editable.
+     * @param {GridCellParams} params The cell params.
+     * @returns {boolean} A boolean value determining if the cell is editable.
+     */
+    isCellEditable: (params: GridCellParams) => boolean;
+    /**
+     * Sets the value of the edit cell.
+     * Commonly used inside the edit cell component.
+     * @param {GridEditCellValueParams} params Contains the id, field and value to set.
+     * @param {React.SyntheticEvent} event The event to pass forward.
+     * @returns {Promise<boolean> | void} A promise with the validation status if `preventCommitWhileValidating` is `true`. Otherwise, void.
+     */
+    setEditCellValue: (params: GridEditCellValueParams, event?: MuiBaseEvent) => Promise<boolean> | void;
+    /**
+     * Immediatelly updates the value of the cell, without waiting for the debounce.
+     * @param {GridRowId} id The row id.
+     * @param {string} field The field to update. If not passed, updates all fields in the given row id.
+     * @ignore - do not document.
+     */
+    unstable_runPendingEditCellValueMutation: (id: GridRowId, field?: string) => void;
+    /**
+     * Returns the row with the values that were set by editing the cells.
+     * In row editing, `field` is ignored and all fields are considered.
+     * @param {GridRowId} id The row id being edited.
+     * @param {string} field The field being edited.
+     * @ignore - do not document.
+     */
+    unstable_getRowWithUpdatedValues: (id: GridRowId, field: string) => GridRowModel;
+}
 /**
  * The shared methods used by the cell and row editing API.
  */
@@ -11,11 +54,13 @@ export interface GridEditingSharedApi {
     /**
      * Set the edit rows model of the grid.
      * @param {GridEditRowsModel} model The new edit rows model.
+     * @deprecated Prefer the new editing API.
      */
     setEditRowsModel: (model: GridEditRowsModel) => void;
     /**
      * Gets the edit rows model of the grid.
      * @returns {GridEditRowsModel} The edit rows model.
+     * @deprecated Prefer the new editing API.
      */
     getEditRowsModel: () => GridEditRowsModel;
     /**
@@ -115,7 +160,7 @@ export interface GridCellEditingApi extends GridEditingSharedApi {
 /**
  * Params passed to `apiRef.current.startCellEditMode`.
  */
-interface GridStartCellEditModeParams {
+export interface GridStartCellEditModeParams {
     /**
      * The row id.
      */
@@ -124,6 +169,10 @@ interface GridStartCellEditModeParams {
      * The field.
      */
     field: string;
+    /**
+     * If `true`, the value will be deleted before entering the edit mode.
+     */
+    deleteValue?: boolean;
 }
 /**
  * Params passed to `apiRef.current.stopCellEditMode`.
@@ -151,7 +200,7 @@ export interface GridStopCellEditModeParams {
 /**
  * Params passed to `apiRef.current.startRowEditMode`.
  */
-interface GridStartRowEditModeParams {
+export interface GridStartRowEditModeParams {
     /**
      * The row id.
      */
@@ -160,6 +209,10 @@ interface GridStartRowEditModeParams {
      * The field to put focus.
      */
     fieldToFocus?: string;
+    /**
+     * If `true`, the value in `fieldToFocus` will be deleted before entering the edit mode.
+     */
+    deleteValue?: boolean;
 }
 /**
  * Params passed to `apiRef.current.stopRowEditMode`.
@@ -186,7 +239,7 @@ export interface GridStopRowEditModeParams {
      */
     cellToFocusAfter?: 'none' | 'below' | 'right' | 'left';
 }
-export interface GridNewCellEditingApi extends Omit<GridEditingSharedApi, 'getEditRowsModel' | 'setEditRowsModel'>, Pick<GridCellEditingApi, 'getCellMode'> {
+export interface GridNewCellEditingApi extends GridNewEditingSharedApi, Pick<GridCellEditingApi, 'getCellMode'> {
     /**
      * Puts the cell corresponding to the given row id and field into edit mode.
      * @param {GridStartCellEditModeParams} params The row id and field of the cell to edit.
@@ -206,8 +259,15 @@ export interface GridNewCellEditingApi extends Omit<GridEditingSharedApi, 'getEd
      * @ignore - do not document.
      */
     unstable_setCellEditingEditCellValue: (params: GridEditCellValueParams) => Promise<boolean>;
+    /**
+     * Returns the row with the new value that was set by editing the cell.
+     * @param {GridRowId} id The row id being edited.
+     * @param {string} field The field being edited.
+     * @ignore - do not document.
+     */
+    unstable_getRowWithUpdatedValuesFromCellEditing: (id: GridRowId, field: string) => GridRowModel;
 }
-export interface GridNewRowEditingApi extends Omit<GridEditingSharedApi, 'getEditRowsModel' | 'setEditRowsModel'>, Pick<GridRowEditingApi, 'getRowMode'> {
+export interface GridNewRowEditingApi extends GridNewEditingSharedApi, Pick<GridRowEditingApi, 'getRowMode'> {
     /**
      * Puts the row corresponding to the given id into edit mode.
      * @param {GridStartCellEditModeParams} params The row id edit.
@@ -227,6 +287,12 @@ export interface GridNewRowEditingApi extends Omit<GridEditingSharedApi, 'getEdi
      * @ignore - do not document.
      */
     unstable_setRowEditingEditCellValue: (params: GridEditCellValueParams) => Promise<boolean>;
+    /**
+     * Returns the row with the values that were set by editing all cells.
+     * @param {GridRowId} id The row id being edited.
+     * @ignore - do not document.
+     */
+    unstable_getRowWithUpdatedValuesFromRowEditing: (id: GridRowId) => GridRowModel;
 }
 /**
  * The editing API interface that is available in the grid `apiRef`.
@@ -237,4 +303,3 @@ export interface GridOldEditingApi extends GridCellEditingApi, GridRowEditingApi
 }
 export interface GridNewEditingApi extends GridNewCellEditingApi, GridNewRowEditingApi {
 }
-export {};

package/models/api/gridFilterApi.d.ts

@@ -44,4 +44,9 @@ export interface GridFilterApi {
      * @returns {Map<GridRowId, GridRowModel>} The sorted `Map`.
      */
     getVisibleRowModels: () => Map<GridRowId, GridRowModel>;
+    /**
+     * Set the quick filter values ot the one given by `values`
+     * @param {any[]} values The list of element to quick filter
+     */
+    setQuickFilterValues: (values: any[]) => void;
 }

package/models/api/gridFocusApi.d.ts

@@ -20,6 +20,7 @@ export interface GridFocusApi {
      * @param {GridRowId} id The base row id.
      * @param {string} field The base column field.
      * @param {'below' | 'right' | 'left'} direction Which direction is the next cell to focus.
+     * @ignore - do not document.
      */
     unstable_moveFocusToRelativeCell: (id: GridRowId, field: string, direction: 'below' | 'right' | 'left') => void;
 }

package/models/api/gridLocaleTextApi.d.ts

@@ -19,10 +19,14 @@ export interface GridLocaleText {
     toolbarFiltersTooltipHide: React.ReactNode;
     toolbarFiltersTooltipShow: React.ReactNode;
     toolbarFiltersTooltipActive: (count: number) => React.ReactNode;
+    toolbarQuickFilterPlaceholder: string;
+    toolbarQuickFilterLabel: string;
+    toolbarQuickFilterDeleteIconLabel: string;
     toolbarExport: React.ReactNode;
     toolbarExportLabel: string;
     toolbarExportCSV: React.ReactNode;
     toolbarExportPrint: React.ReactNode;
+    toolbarExportExcel: string;
     columnsPanelTextFieldLabel: string;
     columnsPanelTextFieldPlaceholder: string;
     columnsPanelDragIconLabel: string;
@@ -86,6 +90,7 @@ export interface GridLocaleText {
     expandDetailPanel: string;
     collapseDetailPanel: string;
     MuiTablePagination: Omit<ComponentsPropsList['MuiTablePagination'], 'page' | 'count' | 'onChangePage' | 'rowsPerPage' | 'onPageChange'>;
+    rowReorderingHeaderName: string;
 }
 export declare type GridTranslationKeys = keyof GridLocaleText;
 /**

package/models/api/gridRowApi.d.ts

@@ -1,4 +1,25 @@
 import { GridRowModel, GridRowId, GridRowModelUpdate, GridRowTreeNodeConfig, GridValidRowModel } from '../gridRows';
+export interface GridRowGroupChildrenGetterParams {
+    /**
+     * The row id of the group
+     */
+    groupId: GridRowId;
+    /**
+     * If `true`, the method will not return the generated rows generated by the grid (aggregation footers, groups, ...)
+     * @default true
+     */
+    skipAutoGeneratedRows?: boolean;
+    /**
+     * If `true`, the method will only return the rows that are matching the current filters
+     * @default false
+     */
+    applyFiltering?: boolean;
+    /**
+     * If `true`, the method will order the returned rows according to the current sorting rules
+     * @default false
+     */
+    applySorting?: boolean;
+}
 /**
  * The Row API interface that is available in the grid `apiRef`.
  */
@@ -23,6 +44,12 @@ export interface GridRowApi {
      * @param {GridRowModel[]} rows The new rows.
      */
     setRows: (rows: GridRowModel[]) => void;
+    /**
+     * Moves a row from its original position to the position given by `targetIndex`.
+     * @param {GridRowId} rowId The row id
+     * @param {number} targetIndex The new position (0-based).
+     */
+    setRowIndex: (rowId: GridRowId, targetIndex: number) => void;
     /**
      * Allows to updates, insert and delete rows in a single call.
      * @param {GridRowModelUpdate[]} updates An array of rows with an `action` specifying what to do.
@@ -52,4 +79,11 @@ export interface GridRowApi {
      * @returns {number} The index of the row.
      */
     getRowIndexRelativeToVisibleRows: (id: GridRowId) => number;
+    /**
+     * Gets the rows of a grouping criteria.
+     * Only contains the rows provided to the grid, not the rows automatically generated by it.
+     * @param {GridRowGroupChildrenParams} params Object containing parameters for the getter.
+     * @returns {GridRowId[]} The id of each row in the grouping criteria.
+     */
+    getRowGroupChildren: (params: GridRowGroupChildrenGetterParams) => GridRowId[];
 }

package/models/api/index.d.ts

@@ -21,5 +21,5 @@ export * from './gridCallbackDetails';
 export * from './gridScrollApi';
 export * from './gridVirtualScrollerApi';
 export * from './gridApiCommon';
-export type { GridEditingApi, GridOldEditingApi, GridNewEditingApi } from './gridEditingApi';
+export type { GridEditingApi, GridOldEditingApi, GridNewEditingApi, GridCellModesModel, GridRowModesModel, } from './gridEditingApi';
 export declare type GridEditRowApi = GridEditingApi;

package/models/colDef/gridColDef.d.ts

@@ -11,6 +11,7 @@ import { GridValueOptionsParams } from '../params/gridValueOptionsParams';
 import { GridActionsCellItemProps } from '../../components/cell/GridActionsCellItem';
 import { GridEditCellProps } from '../gridEditRowModel';
 import type { GridValidRowModel } from '../gridRows';
+import { GridApiCommunity } from '../api/gridApiCommunity';
 /**
  * Alignment used in position elements in Cells.
  */
@@ -90,12 +91,15 @@ export interface GridColDef<R extends GridValidRowModel = any, V = any, F = V> {
     editable?: boolean;
     /**
      * If `true`, the rows can be grouped based on this column values (pro-plan only).
+     * Only available in DataGridPremium.
+     * TODO: Use module augmentation to move it to `@mui/x-data-grid-premium` (need to modify how we handle column types default values).
      * @default true
      */
     groupable?: boolean;
     /**
      * If `false`, the menu items for column pinning menu will not be rendered.
      * Only available in DataGridPro.
+     * TODO: Use module augmentation to move it to `@mui/x-data-grid-pro` (need to modify how we handle column types default values).
      * @default true
      */
     pinnable?: boolean;
@@ -204,6 +208,15 @@ export interface GridColDef<R extends GridValidRowModel = any, V = any, F = V> {
      * Allows setting the filter operators for this column.
      */
     filterOperators?: GridFilterOperator<R, V, F>[];
+    /**
+     * The callback that generates a filtering function for a given quick filter value.
+     * This function can return `null` to skip filtering for this value and column.
+     * @param {any} value The value with which we want to filter the column.
+     * @param {GridStateColDef} colDef The column from which we want to filter the rows.
+     * @param {React.MutableRefObject<GridApiCommunity>} apiRef Deprecated: The API of the grid.
+     * @returns {null | ((params: GridCellParams) => boolean)} The function to call to check if a row pass this filter value or not.
+     */
+    getApplyQuickFilterFn?: (value: any, colDef: GridStateColDef, apiRef: React.MutableRefObject<GridApiCommunity>) => null | ((params: GridCellParams<V, R, F>) => boolean);
     /**
      * If `true`, this column cannot be reordered.
      * @default false
@@ -214,6 +227,11 @@ export interface GridColDef<R extends GridValidRowModel = any, V = any, F = V> {
      * @default false
      */
     disableExport?: boolean;
+    /**
+     * Number of columns a cell should span.
+     * @default 1
+     */
+    colSpan?: number | ((params: GridCellParams<V, R, F>) => number | undefined);
 }
 export interface GridActionsColDef extends GridColDef {
     /**