Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DataGrid] Add missing api property to GridCallbackDetails #12742

Merged
merged 5 commits into from
Apr 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
Original file line number Diff line number Diff line change
@@ -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>>
Expand Down Expand Up @@ -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) {
Expand All @@ -106,7 +102,7 @@ export const useGridStateInitialization = <PrivateApi extends GridPrivateApiComm

return !ignoreSetState;
},
[apiRef, props.signature],
[apiRef],
);

const updateControlState = React.useCallback<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
5 changes: 5 additions & 0 deletions packages/x-data-grid/src/models/api/gridCallbackDetails.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { GridControlledStateReasonLookup } from '../events/gridEventLookup';
import { GridApiCommunity } from './gridApiCommunity';

/**
* Additional details passed to the callbacks
Expand All @@ -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;
Comment on lines +12 to +15
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sidenote but I don't like that we don't have a strict convention of either always apiRef or always api. Sometimes we need to do awkward conversions like { current: api } to create a new "ref".

}