@mui/x-data-grid 5.6.0 → 5.8.0

package/models/gridFilterOperator.d.ts

@@ -5,10 +5,11 @@ import { GridFilterInputMultipleSingleSelectProps } from '../components/panel/fi
 import { GridFilterItem } from './gridFilterItem';
 import { GridCellParams } from './params/gridCellParams';
 import type { GridStateColDef } from './colDef/gridColDef';
+import type { GridValidRowModel } from './gridRows';
 /**
  * Filter operator definition interface.
  */
-export interface GridFilterOperator {
+export interface GridFilterOperator<R extends GridValidRowModel = any, V = any, F = V> {
     /**
      * The label of the filter operator.
      */
@@ -25,7 +26,7 @@ export interface GridFilterOperator {
      * @param {GridStateColDef} column The column from which we want to filter the rows.
      * @returns {null | ((params: GridCellParams) => boolean)} The function to call to check if a row poss this filter item or not.
      */
-    getApplyFilterFn: (filterItem: GridFilterItem, column: GridStateColDef) => null | ((params: GridCellParams) => boolean);
+    getApplyFilterFn: (filterItem: GridFilterItem, column: GridStateColDef<R, V, F>) => null | ((params: GridCellParams<V, R, F>) => boolean);
     /**
      * The input component to render in the filter panel for this filter operator.
      */

package/models/gridRows.d.ts

@@ -1,17 +1,16 @@
 import type { GridKeyValue } from './colDef/gridColDef';
-export declare type GridRowsProp = Readonly<GridRowModel[]>;
+export declare type GridValidRowModel = {
+    [key: string]: any;
+};
+export declare type GridRowsProp<R = any> = Readonly<GridRowModel<R>[]>;
 /**
  * @deprecated prefer GridRowModel.
  */
-export declare type GridRowData<T = {
-    [key: string]: any;
-}> = T;
+export declare type GridRowData = GridValidRowModel;
 /**
  * The key value object representing the data of a row.
  */
-export declare type GridRowModel<T = {
-    [key: string]: any;
-}> = T;
+export declare type GridRowModel<R extends GridValidRowModel = any> = R;
 export declare type GridUpdateAction = 'delete';
 export interface GridRowModelUpdate extends GridRowModel {
     _action?: GridUpdateAction;
@@ -68,23 +67,22 @@ export interface GridRowsMeta {
     positions: number[];
 }
 export declare type GridRowTreeConfig = Record<GridRowId, GridRowTreeNodeConfig>;
-export declare type GridRowsLookup = Record<GridRowId, GridRowModel>;
+export declare type GridRowsLookup<R extends GridValidRowModel = any> = Record<GridRowId, R>;
 /**
  * The type of Id supported by the grid.
  */
 export declare type GridRowId = string | number;
-export declare type GridRowEntry = {
+export interface GridRowEntry<R extends GridValidRowModel = any> {
+    /**
+     * The row id.
+     */
     id: GridRowId;
-    model: GridRowModel;
-};
+    /**
+     * The row model.
+     */
+    model: R;
+}
 /**
  * The function to retrieve the id of a [[GridRowModel]].
  */
-export declare type GridRowIdGetter = (row: GridRowModel) => GridRowId;
-/**
- * An 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 declare function checkGridRowIdIsValid(id: GridRowId, row: GridRowModel | Partial<GridRowModel>, detailErrorMessage?: string): void;
+export declare type GridRowIdGetter<R extends GridValidRowModel = any> = (row: R) => GridRowId;

package/models/gridRows.js

@@ -1,31 +1 @@
-/**
- * @deprecated prefer GridRowModel.
- */
-
-/**
- * The key value object representing the data of a row.
- */
-
-/**
- * The grid rows total height and row positions.
- */
-
-/**
- * The type of Id supported by the grid.
- */
-
-/**
- * The function to retrieve the id of a [[GridRowModel]].
- */
-
-/**
- * An 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'));
-  }
-}
+export {};

package/models/gridSlotsComponent.d.ts

@@ -50,6 +50,11 @@ export interface GridSlotsComponent extends GridIconSlotsComponent {
      * @default GridCell
      */
     Cell: React.JSXElementConstructor<any>;
+    /**
+     * Filter icon component rendered in each column header.
+     * @default GridColumnHeaderFilterIconButton
+     */
+    ColumnHeaderFilterIconButton: React.JSXElementConstructor<any>;
     /**
      * Column menu component rendered by clicking on the 3 dots "kebab" icon in column headers.
      * @default GridColumnMenu

package/models/gridSlotsComponentsProps.d.ts

@@ -11,6 +11,7 @@ export interface GridSlotsComponentsProps {
     basePopper?: any;
     baseTooltip?: any;
     cell?: any;
+    columnHeaderFilterIconButton?: any;
     columnMenu?: any;
     columnsPanel?: any;
     errorOverlay?: any;

package/models/gridSortModel.d.ts

@@ -1,10 +1,9 @@
-import { GridCellValue } from './gridCell';
 import { GridRowId, GridRowTreeNodeConfig } from './gridRows';
 export declare type GridSortDirection = 'asc' | 'desc' | null | undefined;
-export interface GridSortCellParams {
+export interface GridSortCellParams<V = any> {
     id: GridRowId;
     field: string;
-    value: GridCellValue;
+    value: V;
     rowNode: GridRowTreeNodeConfig;
     /**
      * @deprecated Use the `apiRef` returned by `useGridApiContext` or `useGridApiRef` (only available in `@mui/x-data-grid-pro`)
@@ -14,7 +13,7 @@ export interface GridSortCellParams {
 /**
  * The type of the sort comparison function.
  */
-export declare type GridComparatorFn = (v1: GridCellValue, v2: GridCellValue, cellParams1: GridSortCellParams, cellParams2: GridSortCellParams) => number;
+export declare type GridComparatorFn<V = any> = (v1: V, v2: V, cellParams1: GridSortCellParams<V>, cellParams2: GridSortCellParams<V>) => number;
 /**
  * Object that represents the column sorted data, part of the [[GridSortModel]].
  */

package/models/index.d.ts

@@ -5,7 +5,6 @@ export * from './gridEditRowModel';
 export * from './gridFeatureMode';
 export * from './gridFilterItem';
 export * from './gridFilterModel';
-export * from './gridFilterOperator';
 export * from './gridRootContainerRef';
 export * from './gridRenderContextProps';
 export * from './gridRows';
@@ -24,3 +23,4 @@ export * from './logger';
 export * from './muiEvent';
 export * from './events';
 export * from './gridSortModel';
+export * from './gridFilterOperator';

package/models/index.js

@@ -5,7 +5,6 @@ export * from './gridEditRowModel';
 export * from './gridFeatureMode';
 export * from './gridFilterItem';
 export * from './gridFilterModel';
-export * from './gridFilterOperator';
 export * from './gridRootContainerRef';
 export * from './gridRenderContextProps';
 export * from './gridRows';
@@ -23,4 +22,5 @@ export * from './gridExport';
 export * from './logger';
 export * from './muiEvent';
 export * from './events';
-export * from './gridSortModel';
+export * from './gridSortModel';
+export * from './gridFilterOperator';

package/models/params/gridCellParams.d.ts

@@ -1,11 +1,11 @@
-import { GridCellMode, GridCellValue } from '../gridCell';
-import { GridRowId, GridRowModel, GridRowTreeNodeConfig } from '../gridRows';
+import { GridCellMode } from '../gridCell';
+import { GridRowId, GridRowModel, GridRowTreeNodeConfig, GridValidRowModel } from '../gridRows';
 import type { GridStateColDef } from '../colDef/gridColDef';
 import { GridEditCellProps } from '../gridEditRowModel';
 /**
  * Object passed as parameter in the column [[GridColDef]] cell renderer.
  */
-export interface GridCellParams<V = any, R = any, F = V> {
+export interface GridCellParams<V = any, R extends GridValidRowModel = any, F = V> {
     /**
      * The grid row id.
      */
@@ -17,7 +17,7 @@ export interface GridCellParams<V = any, R = any, F = V> {
     /**
      * The cell value, but if the column has valueGetter, use getValue.
      */
-    value: V;
+    value: V | undefined;
     /**
      * The cell value formatted with the column valueFormatter.
      */
@@ -54,15 +54,15 @@ export interface GridCellParams<V = any, R = any, F = V> {
      * Get the cell value of a row and field.
      * @param {GridRowId} id The row id.
      * @param {string} field The field.
-     * @returns {GridCellValue} The cell value.
+     * @returns {any} The cell value.
      * @deprecated Use `params.row` to directly access the fields you want instead.
      */
-    getValue: (id: GridRowId, field: string) => GridCellValue;
+    getValue: (id: GridRowId, field: string) => any;
 }
 /**
  * GridCellParams containing api.
  */
-export interface GridRenderCellParams<V = any, R = any, F = V> extends GridCellParams<V, R, F> {
+export interface GridRenderCellParams<V = any, R extends GridValidRowModel = any, F = V> extends GridCellParams<V, R, F> {
     /**
      * GridApi that let you manipulate the grid.
      * @deprecated Use the `apiRef` returned by `useGridApiContext` or `useGridApiRef` (only available in `@mui/x-data-grid-pro`)
@@ -72,7 +72,7 @@ export interface GridRenderCellParams<V = any, R = any, F = V> extends GridCellP
 /**
  * GridEditCellProps containing api.
  */
-export interface GridRenderEditCellParams extends GridEditCellProps {
+export interface GridRenderEditCellParams<V = any, R extends GridValidRowModel = any, F = V> extends GridCellParams<V, R, F>, GridEditCellProps<V> {
     /**
      * GridApi that let you manipulate the grid.
      * @deprecated Use the `apiRef` returned by `useGridApiContext` or `useGridApiRef` (only available in `@mui/x-data-grid-pro`)
@@ -92,24 +92,24 @@ export interface GridValueGetterParams<V = any, R = any> extends Omit<GridCellPa
 /**
  * @deprecated Use `GridValueGetterParams` instead.
  */
-export declare type GridValueGetterFullParams<V = any, R = any> = GridValueGetterParams<V, R>;
+export declare type GridValueGetterFullParams<V = any, R extends GridValidRowModel = any> = GridValueGetterParams<V, R>;
 /**
  * Object passed as parameter in the column [[GridColDef]] value setter callback.
  */
-export interface GridValueSetterParams {
+export interface GridValueSetterParams<R extends GridValidRowModel = any, V = any> {
     /**
      * The new cell value.
      */
-    value: GridCellValue;
+    value: V;
     /**
      * The row that is being edited.
      */
-    row: GridRowModel;
+    row: R;
 }
 /**
  * Object passed as parameter in the column [[GridColDef]] value formatter callback.
  */
-export interface GridValueFormatterParams {
+export interface GridValueFormatterParams<V = any> {
     /**
      * The grid row id.
      * It is not available when the value formatter is called by the filter panel.
@@ -122,7 +122,7 @@ export interface GridValueFormatterParams {
     /**
      * The cell value, if the column has valueGetter it is the value returned by it.
      */
-    value: GridCellValue;
+    value: V;
     /**
      * GridApi that let you manipulate the grid.
      * @deprecated Use the `apiRef` returned by `useGridApiContext` or `useGridApiRef` (only available in `@mui/x-data-grid-pro`)
@@ -145,4 +145,13 @@ export interface GridPreProcessEditCellProps {
      * The edit cell props.
      */
     props: GridEditCellProps;
+    /**
+     * Whether the new value is different from the stored value or not.
+     */
+    hasChanged?: boolean;
+    /**
+     * Object containing the props of the other fields.
+     * Only available for row editing and when using the new editing API.
+     */
+    otherFieldsProps?: Record<string, GridEditCellProps>;
 }

package/models/params/gridColumnHeaderParams.d.ts

@@ -1,8 +1,9 @@
 import type { GridStateColDef } from '../colDef/gridColDef';
+import { GridValidRowModel } from '../gridRows';
 /**
  * Object passed as parameter in the column [[GridColDef]] header renderer.
  */
-export interface GridColumnHeaderParams {
+export interface GridColumnHeaderParams<V = any, R extends GridValidRowModel = GridValidRowModel, F = V> {
     /**
      * The column field of the column that triggered the event
      */
@@ -10,5 +11,5 @@ export interface GridColumnHeaderParams {
     /**
      * The column of the current header component.
      */
-    colDef: GridStateColDef;
+    colDef: GridStateColDef<R, V, F>;
 }

package/models/params/gridEditCellParams.d.ts

@@ -1,15 +1,30 @@
-import { GridCellValue } from '../gridCell';
 import { GridEditCellProps } from '../gridEditRowModel';
 import { GridRowId } from '../gridRows';
+import { GridCellParams } from './gridCellParams';
 export interface GridEditCellPropsParams {
     id: GridRowId;
     field: string;
     props: GridEditCellProps;
 }
+/**
+ * Params passed to `apiRef.current.setEditCellValue`.
+ */
 export interface GridEditCellValueParams {
+    /**
+     * The row id.
+     */
     id: GridRowId;
+    /**
+     * The field.
+     */
     field: string;
-    value: GridCellValue;
+    /**
+     * The new value for the cell.
+     */
+    value: any;
+    /**
+     * The debounce time in milliseconds.
+     */
     debounceMs?: number;
 }
 export interface GridCommitCellChangeParams {
@@ -19,5 +34,39 @@ export interface GridCommitCellChangeParams {
 export interface GridCellEditCommitParams {
     id: GridRowId;
     field: string;
-    value: GridCellValue;
+    value: any;
 }
+declare enum GridCellEditStartReasons {
+    enterKeyDown = "enterKeyDown",
+    cellDoubleClick = "cellDoubleClick",
+    printableKeyDown = "printableKeyDown",
+    deleteKeyDown = "deleteKeyDown"
+}
+/**
+ * Params passed to the `cellEditStart` event.
+ */
+export interface GridCellEditStartParams<V = any, R = any, F = V> extends GridCellParams<V, R, F> {
+    /**
+     * The reason for this event to be triggered.
+     * Only applied if `props.experimentalFeatures.newEditingApi: true`.
+     */
+    reason?: GridCellEditStartReasons;
+}
+declare enum GridCellEditStopReasons {
+    cellFocusOut = "cellFocusOut",
+    escapeKeyDown = "escapeKeyDown",
+    enterKeyDown = "enterKeyDown",
+    tabKeyDown = "tabKeyDown",
+    shiftTabKeyDown = "shiftTabKeyDown"
+}
+/**
+ * Params passed to the `cellEditStop event.
+ */
+export interface GridCellEditStopParams<V = any, R = any, F = V> extends GridCellParams<V, R, F> {
+    /**
+     * The reason for this event to be triggered.
+     * Only available if `props.experimentalFeatures.newEditingApi: true`.
+     */
+    reason?: GridCellEditStopReasons;
+}
+export { GridCellEditStartReasons, GridCellEditStopReasons };

package/models/params/gridEditCellParams.js

@@ -1 +1,34 @@
-export {};
+// TODO v6 - remove
+
+/**
+ * Params passed to `apiRef.current.setEditCellValue`.
+ */
+// TODO v6 - remove
+// TODO v6 - remove
+var GridCellEditStartReasons;
+/**
+ * Params passed to the `cellEditStart` event.
+ */
+
+(function (GridCellEditStartReasons) {
+  GridCellEditStartReasons["enterKeyDown"] = "enterKeyDown";
+  GridCellEditStartReasons["cellDoubleClick"] = "cellDoubleClick";
+  GridCellEditStartReasons["printableKeyDown"] = "printableKeyDown";
+  GridCellEditStartReasons["deleteKeyDown"] = "deleteKeyDown";
+})(GridCellEditStartReasons || (GridCellEditStartReasons = {}));
+
+var GridCellEditStopReasons;
+/**
+ * Params passed to the `cellEditStop event.
+ */
+
+(function (GridCellEditStopReasons) {
+  GridCellEditStopReasons["cellFocusOut"] = "cellFocusOut";
+  GridCellEditStopReasons["escapeKeyDown"] = "escapeKeyDown";
+  GridCellEditStopReasons["enterKeyDown"] = "enterKeyDown";
+  GridCellEditStopReasons["tabKeyDown"] = "tabKeyDown";
+  GridCellEditStopReasons["shiftTabKeyDown"] = "shiftTabKeyDown";
+})(GridCellEditStopReasons || (GridCellEditStopReasons = {}));
+
+// https://github.com/mui/mui-x/pull/3738#discussion_r798504277
+export { GridCellEditStartReasons, GridCellEditStopReasons };

package/models/params/gridPreferencePanelParams.d.ts

@@ -0,0 +1,3 @@
+import { GridPreferencePanelState } from '../../hooks/features/preferencesPanel/gridPreferencePanelState';
+export interface GridPreferencePanelParams extends Omit<GridPreferencePanelState, 'open'> {
+}

package/models/params/gridRowParams.d.ts

@@ -1,10 +1,9 @@
-import { GridCellValue } from '../gridCell';
-import { GridRowEntry, GridRowId, GridRowModel } from '../gridRows';
+import { GridValidRowModel, GridRowEntry, GridRowId } from '../gridRows';
 import type { GridColumns } from '../colDef/gridColDef';
 /**
  * Object passed as parameter in the row callbacks.
  */
-export interface GridRowParams<R extends GridRowModel = GridRowModel> {
+export interface GridRowParams<R extends GridValidRowModel = any> {
     /**
      * The grid row id.
      */
@@ -21,13 +20,28 @@ export interface GridRowParams<R extends GridRowModel = GridRowModel> {
      * Get the cell value of a row and field.
      * @param {GridRowId} id The row id.
      * @param {string} field The field.
-     * @returns {GridCellValue} The cell value.
+     * @returns {any} The cell value.
      * @deprecated Use `params.row` to directly access the fields you want instead.
      */
-    getValue: (id: GridRowId, field: string) => GridCellValue;
+    getValue: (id: GridRowId, field: string) => any;
+}
+interface GridRowVisibilityParams {
+    /**
+     * Whether this row is the first visible or not.
+     */
+    isFirstVisible: boolean;
+    /**
+     * Whether this row is the last visible or not.
+     */
+    isLastVisible: boolean;
+}
+/**
+ * Object passed as parameter in the row `getRowClassName` callback prop.
+ */
+export interface GridRowClassNameParams<R extends GridValidRowModel = any> extends GridRowParams<R>, GridRowVisibilityParams {
 }
 /**
- * Object passed as parameter in the row getRowHeight callback.
+ * Object passed as parameter in the row `getRowHeight` callback prop.
  */
 export interface GridRowHeightParams extends GridRowEntry {
     /**
@@ -39,3 +53,56 @@ export interface GridRowHeightParams extends GridRowEntry {
  * The getRowHeight return value.
  */
 export declare type GridRowHeightReturnValue = number | null | undefined;
+declare enum GridRowEditStartReasons {
+    enterKeyDown = "enterKeyDown",
+    cellDoubleClick = "cellDoubleClick",
+    printableKeyDown = "printableKeyDown",
+    deleteKeyDown = "deleteKeyDown"
+}
+/**
+ * Params passed to the `rowEditStart` event.
+ */
+export interface GridRowEditStartParams<R extends GridValidRowModel = any> extends GridRowParams<R> {
+    /**
+     * Which field triggered this event.
+     * Only applied if `props.experimentalFeatures.newEditingApi: true`.
+     */
+    field?: string;
+    /**
+     * The reason for this event to be triggered.
+     * Only applied if `props.experimentalFeatures.newEditingApi: true`.
+     */
+    reason?: GridRowEditStartReasons;
+}
+declare enum GridRowEditStopReasons {
+    rowFocusOut = "rowFocusOut",
+    escapeKeyDown = "escapeKeyDown",
+    enterKeyDown = "enterKeyDown",
+    tabKeyDown = "tabKeyDown",
+    shiftTabKeyDown = "shiftTabKeyDown"
+}
+export interface GridRowEditStopParams<R extends GridValidRowModel = any> extends GridRowParams<R> {
+    /**
+     * Which field triggered this event.
+     * Only applied if `props.experimentalFeatures.newEditingApi: true`.
+     */
+    field?: string;
+    /**
+     * The reason for this event to be triggered.
+     * Only applied if `props.experimentalFeatures.newEditingApi: true`.
+     */
+    reason?: GridRowEditStopReasons;
+}
+/**
+ * Object passed as parameter in the row `getRowSpacing` callback prop.
+ */
+export interface GridRowSpacingParams extends GridRowEntry, GridRowVisibilityParams {
+}
+/**
+ * The getRowSpacing return value.
+ */
+export interface GridRowSpacing {
+    top?: number;
+    bottom?: number;
+}
+export { GridRowEditStartReasons, GridRowEditStopReasons };

package/models/params/gridRowParams.js

@@ -1 +1,39 @@
-export {};
+/**
+ * Object passed as parameter in the row callbacks.
+ */
+
+/**
+ * Object passed as parameter in the row `getRowClassName` callback prop.
+ */
+
+/**
+ * Object passed as parameter in the row `getRowHeight` callback prop.
+ */
+
+/**
+ * The getRowHeight return value.
+ */
+var GridRowEditStartReasons;
+/**
+ * Params passed to the `rowEditStart` event.
+ */
+
+(function (GridRowEditStartReasons) {
+  GridRowEditStartReasons["enterKeyDown"] = "enterKeyDown";
+  GridRowEditStartReasons["cellDoubleClick"] = "cellDoubleClick";
+  GridRowEditStartReasons["printableKeyDown"] = "printableKeyDown";
+  GridRowEditStartReasons["deleteKeyDown"] = "deleteKeyDown";
+})(GridRowEditStartReasons || (GridRowEditStartReasons = {}));
+
+var GridRowEditStopReasons;
+
+(function (GridRowEditStopReasons) {
+  GridRowEditStopReasons["rowFocusOut"] = "rowFocusOut";
+  GridRowEditStopReasons["escapeKeyDown"] = "escapeKeyDown";
+  GridRowEditStopReasons["enterKeyDown"] = "enterKeyDown";
+  GridRowEditStopReasons["tabKeyDown"] = "tabKeyDown";
+  GridRowEditStopReasons["shiftTabKeyDown"] = "shiftTabKeyDown";
+})(GridRowEditStopReasons || (GridRowEditStopReasons = {}));
+
+// https://github.com/mui/mui-x/pull/3738#discussion_r798504277
+export { GridRowEditStartReasons, GridRowEditStopReasons };

package/models/params/gridValueOptionsParams.d.ts

@@ -1,8 +1,8 @@
-import { GridRowModel, GridRowId } from '../gridRows';
+import { GridRowId, GridValidRowModel } from '../gridRows';
 /**
  * Object passed as parameter of the valueOptions function for singleSelect column.
  */
-export interface GridValueOptionsParams {
+export interface GridValueOptionsParams<R extends GridValidRowModel = any> {
     /**
      * The field of the column to which options will be provided
      */
@@ -14,5 +14,5 @@ export interface GridValueOptionsParams {
     /**
      * The row model of the row that the current cell belongs to.
      */
-    row?: GridRowModel;
+    row?: R;
 }

package/models/params/index.d.ts

@@ -10,3 +10,4 @@ export * from './gridHeaderSelectionCheckboxParams';
 export * from './gridValueOptionsParams';
 export * from './gridCellParams';
 export * from './gridSortModelParams';
+export * from './gridPreferencePanelParams';

package/models/params/index.js

@@ -9,4 +9,5 @@ export * from './gridRowSelectionCheckboxParams';
 export * from './gridHeaderSelectionCheckboxParams';
 export * from './gridValueOptionsParams';
 export * from './gridCellParams';
-export * from './gridSortModelParams';
+export * from './gridSortModelParams';
+export * from './gridPreferencePanelParams';