@mui/x-data-grid 9.10.1 → 9.12.0

package/models/controlStateItem.d.mts

@@ -1,14 +1,15 @@
 import type { RefObject } from '@mui/x-internals/types';
 import type { GridCallbackDetails } from "./api/gridCallbackDetails.mjs";
+import type { GridApiCommon } from "./api/gridApiCommon.mjs";
 import type { GridEventLookup, GridControlledStateEventLookup } from "./events/index.mjs";
 import type { OutputSelector } from "../utils/createSelector.mjs";
 import type { GridStateCommunity } from "./gridStateCommunity.mjs";
-export interface GridControlStateItem<State extends GridStateCommunity, Args, E extends keyof GridControlledStateEventLookup> {
+export interface GridControlStateItem<State extends GridStateCommunity, Args, E extends keyof GridControlledStateEventLookup, Api extends GridApiCommon = GridApiCommon> {
   stateId: string;
   propModel?: GridEventLookup[E]['params'];
   stateSelector: OutputSelector<State, Args, GridControlledStateEventLookup[E]['params']> | ((apiRef: RefObject<{
     state: State;
   }>) => GridControlledStateEventLookup[E]['params']);
-  propOnChange?: (model: GridControlledStateEventLookup[E]['params'], details: GridCallbackDetails) => void;
+  propOnChange?: (model: GridControlledStateEventLookup[E]['params'], details: GridCallbackDetails<any, Api>) => void;
   changeEvent: E;
 }

package/models/controlStateItem.d.ts

@@ -1,14 +1,15 @@
 import type { RefObject } from '@mui/x-internals/types';
 import type { GridCallbackDetails } from "./api/gridCallbackDetails.js";
+import type { GridApiCommon } from "./api/gridApiCommon.js";
 import type { GridEventLookup, GridControlledStateEventLookup } from "./events/index.js";
 import type { OutputSelector } from "../utils/createSelector.js";
 import type { GridStateCommunity } from "./gridStateCommunity.js";
-export interface GridControlStateItem<State extends GridStateCommunity, Args, E extends keyof GridControlledStateEventLookup> {
+export interface GridControlStateItem<State extends GridStateCommunity, Args, E extends keyof GridControlledStateEventLookup, Api extends GridApiCommon = GridApiCommon> {
   stateId: string;
   propModel?: GridEventLookup[E]['params'];
   stateSelector: OutputSelector<State, Args, GridControlledStateEventLookup[E]['params']> | ((apiRef: RefObject<{
     state: State;
   }>) => GridControlledStateEventLookup[E]['params']);
-  propOnChange?: (model: GridControlledStateEventLookup[E]['params'], details: GridCallbackDetails) => void;
+  propOnChange?: (model: GridControlledStateEventLookup[E]['params'], details: GridCallbackDetails<any, Api>) => void;
   changeEvent: E;
 }

package/models/events/gridEventListener.d.mts

@@ -1,8 +1,9 @@
 import type { MuiBaseEvent, MuiEvent } from '@mui/x-internals/types';
 import type { GridCallbackDetails } from "../api/gridCallbackDetails.mjs";
+import type { GridApiCommon } from "../api/gridApiCommon.mjs";
 import type { GridEventLookup, GridEvents } from "./gridEventLookup.mjs";
-export type GridEventListener<E extends GridEvents> = (params: GridEventLookup[E] extends {
+export type GridEventListener<E extends GridEvents, Api extends GridApiCommon = GridApiCommon> = (params: GridEventLookup[E] extends {
   params: any;
 } ? GridEventLookup[E]['params'] : undefined, event: GridEventLookup[E] extends {
   event: MuiBaseEvent;
-} ? MuiEvent<GridEventLookup[E]['event']> : MuiEvent<{}>, details: GridCallbackDetails) => void;
+} ? MuiEvent<GridEventLookup[E]['event']> : MuiEvent<{}>, details: GridCallbackDetails<any, Api>) => void;

package/models/events/gridEventListener.d.ts

@@ -1,8 +1,9 @@
 import type { MuiBaseEvent, MuiEvent } from '@mui/x-internals/types';
 import type { GridCallbackDetails } from "../api/gridCallbackDetails.js";
+import type { GridApiCommon } from "../api/gridApiCommon.js";
 import type { GridEventLookup, GridEvents } from "./gridEventLookup.js";
-export type GridEventListener<E extends GridEvents> = (params: GridEventLookup[E] extends {
+export type GridEventListener<E extends GridEvents, Api extends GridApiCommon = GridApiCommon> = (params: GridEventLookup[E] extends {
   params: any;
 } ? GridEventLookup[E]['params'] : undefined, event: GridEventLookup[E] extends {
   event: MuiBaseEvent;
-} ? MuiEvent<GridEventLookup[E]['event']> : MuiEvent<{}>, details: GridCallbackDetails) => void;
+} ? MuiEvent<GridEventLookup[E]['event']> : MuiEvent<{}>, details: GridCallbackDetails<any, Api>) => void;

package/models/props/DataGridProps.d.mts

@@ -12,6 +12,7 @@ import type { GridRowId, GridRowIdGetter, GridRowsProp, GridValidRowModel } from
 import type { GridEventListener } from "../events/index.mjs";
 import type { GridCallbackDetails, GridLocaleText } from "../api/index.mjs";
 import type { GridApiCommunity } from "../api/gridApiCommunity.mjs";
+import type { GridApiCommon } from "../api/gridApiCommon.mjs";
 import type { GridColDef, GridListViewColDef, GridCheckboxSelectionColDef } from "../colDef/gridColDef.mjs";
 import type { GridClasses } from "../../constants/gridClasses.mjs";
 import type { GridRowHeightParams, GridRowHeightReturnValue, GridRowParams, GridRowSpacing, GridRowSpacingParams, GridRowClassNameParams } from "../params/index.mjs";
@@ -414,7 +415,7 @@ export interface DataGridPropsWithDefaultValues<R extends GridValidRowModel = an
 /**
  * The Data Grid props with no default value.
  */
-export interface DataGridPropsWithoutDefaultValue<R extends GridValidRowModel = any> extends CommonProps {
+export interface DataGridPropsWithoutDefaultValue<R extends GridValidRowModel = any, Api extends GridApiCommon = GridApiCommunity> extends CommonProps {
   /**
    * The ref object that allows Data Grid manipulation. Can be instantiated with `useGridApiRef()`.
    */
@@ -513,13 +514,13 @@ export interface DataGridPropsWithoutDefaultValue<R extends GridValidRowModel =
    * @param {GridCellParams} params With all properties from [[GridCellParams]].
    * @param {MuiEvent<React.KeyboardEvent | React.MouseEvent>} event The event that caused this prop to be called.
    */
-  onCellEditStart?: GridEventListener<'cellEditStart'>;
+  onCellEditStart?: GridEventListener<'cellEditStart', Api>;
   /**
    * Callback fired when the cell turns to view mode.
    * @param {GridCellParams} params With all properties from [[GridCellParams]].
    * @param {MuiEvent<MuiBaseEvent>} event The event that caused this prop to be called.
    */
-  onCellEditStop?: GridEventListener<'cellEditStop'>;
+  onCellEditStop?: GridEventListener<'cellEditStop', Api>;
   /**
    * Callback fired when a data source request fails.
    * @param {GridGetRowsError | GridUpdateRowError} error The data source error object.
@@ -530,89 +531,89 @@ export interface DataGridPropsWithoutDefaultValue<R extends GridValidRowModel =
    * @param {GridRowParams} params With all properties from [[GridRowParams]].
    * @param {MuiEvent<React.KeyboardEvent | React.MouseEvent>} event The event that caused this prop to be called.
    */
-  onRowEditStart?: GridEventListener<'rowEditStart'>;
+  onRowEditStart?: GridEventListener<'rowEditStart', Api>;
   /**
    * Callback fired when the row turns to view mode.
    * @param {GridRowParams} params With all properties from [[GridRowParams]].
    * @param {MuiEvent<MuiBaseEvent>} event The event that caused this prop to be called.
    */
-  onRowEditStop?: GridEventListener<'rowEditStop'>;
+  onRowEditStop?: GridEventListener<'rowEditStop', Api>;
   /**
    * Callback fired when any cell is clicked.
    * @param {GridCellParams} params With all properties from [[GridCellParams]].
    * @param {MuiEvent<React.MouseEvent>} event The event object.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onCellClick?: GridEventListener<'cellClick'>;
+  onCellClick?: GridEventListener<'cellClick', Api>;
   /**
    * Callback fired when a double click event comes from a cell element.
    * @param {GridCellParams} params With all properties from [[GridCellParams]].
    * @param {MuiEvent<React.MouseEvent>} event The event object.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onCellDoubleClick?: GridEventListener<'cellDoubleClick'>;
+  onCellDoubleClick?: GridEventListener<'cellDoubleClick', Api>;
   /**
    * Callback fired when a keydown event comes from a cell element.
    * @param {GridCellParams} params With all properties from [[GridCellParams]].
    * @param {MuiEvent<React.KeyboardEvent>} event The event object.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onCellKeyDown?: GridEventListener<'cellKeyDown'>;
+  onCellKeyDown?: GridEventListener<'cellKeyDown', Api>;
   /**
    * Callback fired when a click event comes from a column header element.
    * @param {GridColumnHeaderParams} params With all properties from [[GridColumnHeaderParams]].
    * @param {MuiEvent<React.MouseEvent>} event The event object.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onColumnHeaderClick?: GridEventListener<'columnHeaderClick'>;
+  onColumnHeaderClick?: GridEventListener<'columnHeaderClick', Api>;
   /**
    * Callback fired when a contextmenu event comes from a column header element.
    * @param {GridColumnHeaderParams} params With all properties from [[GridColumnHeaderParams]].
    * @param {MuiEvent<React.MouseEvent>} event The event object.
    */
-  onColumnHeaderContextMenu?: GridEventListener<'columnHeaderContextMenu'>;
+  onColumnHeaderContextMenu?: GridEventListener<'columnHeaderContextMenu', Api>;
   /**
    * Callback fired when a double click event comes from a column header element.
    * @param {GridColumnHeaderParams} params With all properties from [[GridColumnHeaderParams]].
    * @param {MuiEvent<React.MouseEvent>} event The event object.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onColumnHeaderDoubleClick?: GridEventListener<'columnHeaderDoubleClick'>;
+  onColumnHeaderDoubleClick?: GridEventListener<'columnHeaderDoubleClick', Api>;
   /**
    * Callback fired when a mouseover event comes from a column header element.
    * @param {GridColumnHeaderParams} params With all properties from [[GridColumnHeaderParams]].
    * @param {MuiEvent<React.MouseEvent>} event The event object.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onColumnHeaderOver?: GridEventListener<'columnHeaderOver'>;
+  onColumnHeaderOver?: GridEventListener<'columnHeaderOver', Api>;
   /**
    * Callback fired when a mouseout event comes from a column header element.
    * @param {GridColumnHeaderParams} params With all properties from [[GridColumnHeaderParams]].
    * @param {MuiEvent<React.MouseEvent>} event The event object.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onColumnHeaderOut?: GridEventListener<'columnHeaderOut'>;
+  onColumnHeaderOut?: GridEventListener<'columnHeaderOut', Api>;
   /**
    * Callback fired when a mouse enter event comes from a column header element.
    * @param {GridColumnHeaderParams} params With all properties from [[GridColumnHeaderParams]].
    * @param {MuiEvent<React.MouseEvent>} event The event object.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onColumnHeaderEnter?: GridEventListener<'columnHeaderEnter'>;
+  onColumnHeaderEnter?: GridEventListener<'columnHeaderEnter', Api>;
   /**
    * Callback fired when a mouse leave event comes from a column header element.
    * @param {GridColumnHeaderParams} params With all properties from [[GridColumnHeaderParams]].
    * @param {MuiEvent<React.MouseEvent>} event The event object.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onColumnHeaderLeave?: GridEventListener<'columnHeaderLeave'>;
+  onColumnHeaderLeave?: GridEventListener<'columnHeaderLeave', Api>;
   /**
    * Callback fired when a column is reordered.
    * @param {GridColumnOrderChangeParams} params With all properties from [[GridColumnOrderChangeParams]].
    * @param {MuiEvent<{}>} event The event object.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onColumnOrderChange?: GridEventListener<'columnOrderChange'>;
+  onColumnOrderChange?: GridEventListener<'columnOrderChange', Api>;
   /**
    * Callback fired when the density changes.
    * @param {GridDensity} density New density value.
@@ -625,21 +626,21 @@ export interface DataGridPropsWithoutDefaultValue<R extends GridValidRowModel =
    * @param {MuiEvent<React.MouseEvent>} event The event object.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onRowClick?: GridEventListener<'rowClick'>;
+  onRowClick?: GridEventListener<'rowClick', Api>;
   /**
    * Callback fired when a double click event comes from a row container element.
    * @param {GridRowParams} params With all properties from [[RowParams]].
    * @param {MuiEvent<React.MouseEvent>} event The event object.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onRowDoubleClick?: GridEventListener<'rowDoubleClick'>;
+  onRowDoubleClick?: GridEventListener<'rowDoubleClick', Api>;
   /**
    * Callback fired when the Data Grid is resized.
    * @param {ElementSize} containerSize With all properties from [[ElementSize]].
    * @param {MuiEvent<{}>} event The event object.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onResize?: GridEventListener<'debouncedResize'>;
+  onResize?: GridEventListener<'debouncedResize', Api>;
   /**
    * Callback fired when the state of the Data Grid is updated.
    * @param {GridState} state The new state.
@@ -647,7 +648,7 @@ export interface DataGridPropsWithoutDefaultValue<R extends GridValidRowModel =
    * @param {GridCallbackDetails} details Additional details for this callback.
    * @ignore - do not document.
    */
-  onStateChange?: GridEventListener<'stateChange'>;
+  onStateChange?: GridEventListener<'stateChange', Api>;
   /**
    * The pagination model of type [[GridPaginationModel]] which refers to current `page` and `pageSize`.
    */
@@ -662,7 +663,7 @@ export interface DataGridPropsWithoutDefaultValue<R extends GridValidRowModel =
    * @param {GridPaginationModel} model Updated pagination model.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onPaginationModelChange?: (model: GridPaginationModel, details: GridCallbackDetails<'pagination'>) => void;
+  onPaginationModelChange?: (model: GridPaginationModel, details: GridCallbackDetails<'pagination', Api>) => void;
   /**
    * Callback fired when the row count has changed.
    * @param {number} count Updated row count.
@@ -679,28 +680,28 @@ export interface DataGridPropsWithoutDefaultValue<R extends GridValidRowModel =
    * @param {MuiEvent<{}>} event The event object.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onPreferencePanelClose?: GridEventListener<'preferencePanelClose'>;
+  onPreferencePanelClose?: GridEventListener<'preferencePanelClose', Api>;
   /**
    * Callback fired when the preferences panel is opened.
    * @param {GridPreferencePanelParams} params With all properties from [[GridPreferencePanelParams]].
    * @param {MuiEvent<{}>} event The event object.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onPreferencePanelOpen?: GridEventListener<'preferencePanelOpen'>;
+  onPreferencePanelOpen?: GridEventListener<'preferencePanelOpen', Api>;
   /**
    * Callback fired when the menu is opened.
    * @param {GridMenuParams} params With all properties from [[GridMenuParams]].
    * @param {MuiEvent<{}>} event The event object.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onMenuOpen?: GridEventListener<'menuOpen'>;
+  onMenuOpen?: GridEventListener<'menuOpen', Api>;
   /**
    * Callback fired when the menu is closed.
    * @param {GridMenuParams} params With all properties from [[GridMenuParams]].
    * @param {MuiEvent<{}>} event The event object.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onMenuClose?: GridEventListener<'menuClose'>;
+  onMenuClose?: GridEventListener<'menuClose', Api>;
   /**
    * Controls the modes of the cells.
    */
@@ -710,7 +711,7 @@ export interface DataGridPropsWithoutDefaultValue<R extends GridValidRowModel =
    * @param {GridCellModesModel} cellModesModel Object containing which cells are in "edit" mode.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onCellModesModelChange?: (cellModesModel: GridCellModesModel, details: GridCallbackDetails) => void;
+  onCellModesModelChange?: (cellModesModel: GridCellModesModel, details: GridCallbackDetails<any, Api>) => void;
   /**
    * Controls the modes of the rows.
    */
@@ -720,7 +721,7 @@ export interface DataGridPropsWithoutDefaultValue<R extends GridValidRowModel =
    * @param {GridRowModesModel} rowModesModel Object containing which rows are in "edit" mode.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onRowModesModelChange?: (rowModesModel: GridRowModesModel, details: GridCallbackDetails) => void;
+  onRowModesModelChange?: (rowModesModel: GridRowModesModel, details: GridCallbackDetails<any, Api>) => void;
   /**
    * Set the filter model of the Data Grid.
    */
@@ -730,7 +731,7 @@ export interface DataGridPropsWithoutDefaultValue<R extends GridValidRowModel =
    * @param {GridFilterModel} model With all properties from [[GridFilterModel]].
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onFilterModelChange?: (model: GridFilterModel, details: GridCallbackDetails<'filter'>) => void;
+  onFilterModelChange?: (model: GridFilterModel, details: GridCallbackDetails<'filter', Api>) => void;
   /**
    * Sets the row selection model of the Data Grid.
    */
@@ -740,7 +741,7 @@ export interface DataGridPropsWithoutDefaultValue<R extends GridValidRowModel =
    * @param {GridRowSelectionModel} rowSelectionModel With all the row ids [[GridSelectionModel]].
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onRowSelectionModelChange?: (rowSelectionModel: GridRowSelectionModel, details: GridCallbackDetails) => void;
+  onRowSelectionModelChange?: (rowSelectionModel: GridRowSelectionModel, details: GridCallbackDetails<any, Api>) => void;
   /**
    * Set the column visibility model of the Data Grid.
    * If defined, the Data Grid will ignore the `hide` property in [[GridColDef]].
@@ -751,7 +752,7 @@ export interface DataGridPropsWithoutDefaultValue<R extends GridValidRowModel =
    * @param {GridColumnVisibilityModel} model The new model.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onColumnVisibilityModelChange?: (model: GridColumnVisibilityModel, details: GridCallbackDetails) => void;
+  onColumnVisibilityModelChange?: (model: GridColumnVisibilityModel, details: GridCallbackDetails<any, Api>) => void;
   /**
    * Set the sort model of the Data Grid.
    */
@@ -761,7 +762,7 @@ export interface DataGridPropsWithoutDefaultValue<R extends GridValidRowModel =
    * @param {GridSortModel} model With all properties from [[GridSortModel]].
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onSortModelChange?: (model: GridSortModel, details: GridCallbackDetails) => void;
+  onSortModelChange?: (model: GridSortModel, details: GridCallbackDetails<any, Api>) => void;
   /**
    * The `aria-label` of the Data Grid.
    */
@@ -835,7 +836,7 @@ export interface DataGridPropsWithoutDefaultValue<R extends GridValidRowModel =
    * Callback called when the data is copied to the clipboard.
    * @param {string} data The data copied to the clipboard.
    */
-  onClipboardCopy?: GridEventListener<'clipboardCopy'>;
+  onClipboardCopy?: GridEventListener<'clipboardCopy', Api>;
   /**
    * The options for autosize when user-initiated.
    */
@@ -855,14 +856,14 @@ export interface DataGridPropsWithoutDefaultValue<R extends GridValidRowModel =
    * @param {MuiEvent<React.MouseEvent>} event The event object.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onColumnResize?: GridEventListener<'columnResize'>;
+  onColumnResize?: GridEventListener<'columnResize', Api>;
   /**
    * Callback fired when the width of a column is changed.
    * @param {GridColumnResizeParams} params With all properties from [[GridColumnResizeParams]].
    * @param {MuiEvent<React.MouseEvent>} event The event object.
    * @param {GridCallbackDetails} details Additional details for this callback.
    */
-  onColumnWidthChange?: GridEventListener<'columnWidthChange'>;
+  onColumnWidthChange?: GridEventListener<'columnWidthChange', Api>;
 }
 export interface DataGridProSharedPropsWithDefaultValue {
   /**
@@ -926,6 +927,8 @@ export interface DataGridPremiumSharedPropsWithDefaultValue {
 }
 /**
  * The props of the Data Grid component after the pre-processing phase.
+ * `Api` defaults to `any` so that the internals, which are shared across packages,
+ * accept props typed with any of the three API types.
  */
-export interface DataGridProcessedProps<R extends GridValidRowModel = any> extends DataGridPropsWithDefaultValues, DataGridPropsWithComplexDefaultValueAfterProcessing, DataGridPropsWithoutDefaultValue<R>, DataGridProSharedPropsWithoutDefaultValue, Partial<DataGridProSharedPropsWithDefaultValue>, Partial<DataGridPremiumSharedPropsWithDefaultValue> {}
+export interface DataGridProcessedProps<R extends GridValidRowModel = any, Api extends GridApiCommon = any> extends DataGridPropsWithDefaultValues, DataGridPropsWithComplexDefaultValueAfterProcessing, DataGridPropsWithoutDefaultValue<R, Api>, DataGridProSharedPropsWithoutDefaultValue, Partial<DataGridProSharedPropsWithDefaultValue>, Partial<DataGridPremiumSharedPropsWithDefaultValue> {}
 export {};