[DataGrid] Add missing api property to GridCallbackDetails (#12742)

mui · Apr 11, 2024 · 9f6f609 · 9f6f609
1 parent dd77454
commit 9f6f609
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 12 deletions.
diff --git a/packages/x-data-grid/src/hooks/core/useGridInitialization.ts b/packages/x-data-grid/src/hooks/core/useGridInitialization.ts
@@ -25,7 +25,7 @@ export const useGridInitialization = <
   useGridRefs(privateApiRef);
   useGridTheme(privateApiRef);
   useGridLoggerFactory(privateApiRef, props);
-  useGridStateInitialization(privateApiRef, props);
+  useGridStateInitialization(privateApiRef);
   useGridPipeProcessing(privateApiRef);
   useGridStrategyProcessing(privateApiRef);
   useGridLocaleText(privateApiRef, props);

diff --git a/packages/x-data-grid/src/hooks/core/useGridStateInitialization.ts b/packages/x-data-grid/src/hooks/core/useGridStateInitialization.ts
@@ -1,15 +1,12 @@
 import * as React from 'react';
-import { DataGridProcessedProps } from '../../models/props/DataGridProps';
 import type { GridPrivateApiCommon } from '../../models/api/gridApiCommon';
 import { GridStateApi, GridStatePrivateApi } from '../../models/api/gridStateApi';
 import { GridControlStateItem } from '../../models/controlStateItem';
-import { GridSignature } from '../utils/useGridApiEventHandler';
 import { useGridApiMethod } from '../utils';
 import { isFunction } from '../../utils/utils';
 
 export const useGridStateInitialization = <PrivateApi extends GridPrivateApiCommon>(
   apiRef: React.MutableRefObject<PrivateApi>,
-  props: Pick<DataGridProcessedProps, 'signature'>,
 ) => {
   const controlStateMapRef = React.useRef<
     Record<string, GridControlStateItem<PrivateApi['state'], any>>
@@ -92,11 +89,10 @@ export const useGridStateInitialization = <PrivateApi extends GridPrivateApiComm
         const model = controlState.stateSelector(newState, apiRef.current.instanceId);
 
         if (controlState.propOnChange && hasPropChanged) {
-          const details =
-            props.signature === GridSignature.DataGridPro
-              ? { api: apiRef.current, reason }
-              : { reason };
-          controlState.propOnChange(model, details);
+          controlState.propOnChange(model, {
+            reason,
+            api: apiRef.current,
+          });
         }
 
         if (!ignoreSetState) {
@@ -106,7 +102,7 @@ export const useGridStateInitialization = <PrivateApi extends GridPrivateApiComm
 
       return !ignoreSetState;
     },
-    [apiRef, props.signature],
+    [apiRef],
   );
 
   const updateControlState = React.useCallback<

diff --git a/packages/x-data-grid/src/hooks/features/editing/useGridCellEditing.ts b/packages/x-data-grid/src/hooks/features/editing/useGridCellEditing.ts
@@ -257,7 +257,9 @@ export const useGridCellEditing = (
     const isNewModelDifferentFromProp = newModel !== props.cellModesModel;
 
     if (onCellModesModelChange && isNewModelDifferentFromProp) {
-      onCellModesModelChange(newModel, {});
+      onCellModesModelChange(newModel, {
+        api: apiRef.current,
+      });
     }
 
     if (props.cellModesModel && isNewModelDifferentFromProp) {

diff --git a/packages/x-data-grid/src/hooks/features/editing/useGridRowEditing.ts b/packages/x-data-grid/src/hooks/features/editing/useGridRowEditing.ts
@@ -349,7 +349,9 @@ export const useGridRowEditing = (
     const isNewModelDifferentFromProp = newModel !== props.rowModesModel;
 
     if (onRowModesModelChange && isNewModelDifferentFromProp) {
-      onRowModesModelChange(newModel, {});
+      onRowModesModelChange(newModel, {
+        api: apiRef.current,
+      });
     }
 
     if (props.rowModesModel && isNewModelDifferentFromProp) {

diff --git a/packages/x-data-grid/src/models/api/gridCallbackDetails.ts b/packages/x-data-grid/src/models/api/gridCallbackDetails.ts
@@ -1,4 +1,5 @@
 import { GridControlledStateReasonLookup } from '../events/gridEventLookup';
+import { GridApiCommunity } from './gridApiCommunity';
 
 /**
  * Additional details passed to the callbacks
@@ -8,4 +9,8 @@ export interface GridCallbackDetails<K extends keyof GridControlledStateReasonLo
    * The reason for this callback to have been called.
    */
   reason?: GridControlledStateReasonLookup[K];
+  /**
+   * GridApi that let you manipulate the grid.
+   */
+  api: GridApiCommunity;
 }