Skip to content

Commit 75e138d

Browse files
committed
docs(igx-grid): update docs and changlog #2530
1 parent 00fb04f commit 75e138d

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

Diff for: CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ For more detailed information, see the [README](https://github.com/IgniteUI/igni
3232
- `igxGrid`:
3333
- **Breaking change** `onGroupingDone` - The array of `ISortingExpression` can now be accessed through the `expressions` event property. Two new properties have been added to the event arguments - `groupedColumns` and `ungroupedColumns`. They provide references to arrays of `IgxColumnComponent` that hold the columns which have changed their state because of the **last** grouping/ungrouping operation.
3434

35+
- **Breaking change** `onEditDone` is renamed to `onCellEdit` and new cell editing events are introduced: `onCellEditEnter` and `onCellEditCancel`. When row editing is enabled, the corresponding events are emitted by the grid - `onRowEditEnter`, `onRowEdit`, `onRowEditCancel`. All these events have arguments that are using the `IGridEditEventArgs` interface.
36+
3537
- Row editing - allows modification of several cells in the row, before submitting, at once, all those changes to the grid's data source. Leverages the pending changes functionality of the new transaction provider.
3638

3739
```html

Diff for: projects/igniteui-angular/src/lib/grids/README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -190,9 +190,12 @@ A list of the events emitted by the **igx-grid**:
190190
|Name|Description|
191191
|--- |--- |
192192
|_Event emitters_|_Notify for a change_|
193-
|`onEditDone`|Emitted when a cell value changes. Returns `{ currentValue: any, newValue: any }`|
194-
|`onRowEditDone`|Emitted when a row value is submitted. Returns `{ state: State }`|
195-
|`onRowEditCancel`|Emitted when a row value is submitted. Returns `{ state: State }`|
193+
|`onCellEditEnter`|Emitted when cell enters edit mode.|
194+
|`onCellEdit`|Emitted when cell editing has been performed in the grid and the value has been submitted.|
195+
|`onCellEditCancel`|Emitted when cell editing has been performed in the grid and the value has **not** been submitted.|
196+
|`onRowEditEnter`|Emitted when row enters edit mode.|
197+
|`onRowEdit`|Emitted when row editing has been performed in the grid and the value has been submitted.|
198+
|`onRowEditCancel`|Emitted when row editing has been performed in the grid and the value has **not** been submitted.|
196199
|`onCellClick`|Emitted when a cell is clicked. Returns the cell object.|
197200
|`onColumnMoving`|Emitted when a column is moved. Returns the source and target columns objects. This event is cancelable.|
198201
|`onColumnMovingEnd`|Emitted when a column moving ends. Returns the source and target columns objects. This event is cancelable.|

0 commit comments

Comments
 (0)