Skip to content

Commit 2b6764a

Browse files
committed
add more descriptions
1 parent 86f807a commit 2b6764a

File tree

2 files changed

+18
-3
lines changed

2 files changed

+18
-3
lines changed

packages/grid/x-data-grid/src/internals/models/params/gridEditCellParams.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ export interface GridCellEditStartParams<
6464
Api extends GridApiCommon = GridApiCommunity,
6565
> extends GridCellParams<V, R, F, Api> {
6666
/**
67-
* How this event was triggered.
67+
* The reason for this event to be triggered.
6868
*/
6969
reason: GridCellEditStartReasons;
7070
}
@@ -85,7 +85,7 @@ export interface GridCellEditStopParams<
8585
Api extends GridApiCommon = GridApiCommunity,
8686
> extends GridCellParams<V, R, F, Api> {
8787
/**
88-
* How this event was triggered.
88+
* The reason for this event to be triggered.
8989
*/
9090
reason: GridCellEditStopReasons;
9191
}

packages/grid/x-data-grid/src/internals/models/params/gridRowParams.ts

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,18 @@ export enum GridRowEditStartReasons {
5050
deleteKeyDown = 'deleteKeyDown',
5151
}
5252

53+
/**
54+
* Params passed to the `rowEditStart` event.
55+
*/
5356
export interface GridRowEditStartParams<R extends GridRowModel = GridRowModel>
5457
extends GridRowParams<R> {
58+
/**
59+
* Which field triggered this event.
60+
*/
5561
field: string;
62+
/**
63+
* The reason for this event to be triggered.
64+
*/
5665
reason: GridRowEditStartReasons;
5766
}
5867

@@ -64,6 +73,12 @@ export enum GridRowEditStopReasons {
6473

6574
export interface GridRowEditStopParams<R extends GridRowModel = GridRowModel>
6675
extends GridRowParams<R> {
67-
reason: GridRowEditStopReasons;
76+
/**
77+
* Which field triggered this event.
78+
*/
6879
field: string;
80+
/**
81+
* The reason for this event to be triggered.
82+
*/
83+
reason: GridRowEditStopReasons;
6984
}

0 commit comments

Comments
 (0)