Skip to content

Commit 976fb70

Browse files
zdrawkuzdrawku
authored
Merge pull request #9920 from IgniteUI/hanastasov/cellID-to-id-m
fix(grid): change cellID to id in CellType interface
2 parents 26901f1 + 3f30dfc commit 976fb70

File tree

14 files changed

+139
-186
lines changed

14 files changed

+139
-186
lines changed

‎projects/igniteui-angular/src/lib/grids/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -510,7 +510,7 @@ import {
510510
|`active`|boolean|Yes|No|Returns if the cell is active (focused).|
511511
|`editable`|boolean|Yes|No|Returns if the cell can enter edit mode).|
512512
|`editMode`|boolean|Yes|Yes|Gets/Sets the cell in edit mode.|
513-
|`cellID`|object|Yes|No|An object describing the cell with `rowID`, `columnID` and `rowIndex`.|
513+
|`id`|object|Yes|No|An object describing the cell with `rowID`, `columnID` and `rowIndex`.|
514514
|`editMode`|boolean|Yes|Yes|Gets/Sets the cell in edit mode.|
515515

516516
### Methods

‎projects/igniteui-angular/src/lib/grids/common/cell.interface.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export interface CellType {
1414
column: IgxColumnComponent;
1515
row: RowType;
1616
grid: IgxGridComponent | IgxTreeGridComponent | IgxHierarchicalGridComponent;
17-
cellID: { rowID: any; columnID: number; rowIndex: number };
17+
id: { rowID: any; columnID: number; rowIndex: number };
1818
width: string;
1919
update: (value: any) => void;
2020
}

‎projects/igniteui-angular/src/lib/grids/common/crud.service.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ export class IgxCellCrudState {
118118
// 2. cell is an instance of IgxGridCell
119119
// Note: if at some point we are going to get rid of using 1), then see test 'should allow adding row to empty grid':
120120
// cell.row.data will return a { data; rowID } object here, and test will fail
121-
return this.cell = new IgxCell(cell.cellID, cell.row.index, cell.column, cell.value, cell.value,
121+
return this.cell = new IgxCell(cell.cellID || cell.id, cell.row.index, cell.column, cell.value, cell.value,
122122
cell.rowData ?? cell.row.data, cell.grid);
123123
}
124124

‎projects/igniteui-angular/src/lib/grids/grid-public-cell.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -140,19 +140,19 @@ export class IgxGridCell implements CellType {
140140
}
141141

142142
/**
143-
* Gets the cellID key.
143+
* Gets the cell id.
144144
* A cell in the grid is identified by:
145145
* - rowID - primaryKey data value or the whole rowData, if the primaryKey is omitted.
146146
* - rowIndex - the row index
147147
* - columnID - column index
148148
*
149149
* ```typescript
150-
* let rowKey = row.key;
150+
* let cellID = cell.id;
151151
* ```
152152
*
153153
* @memberof IgxGridCell
154154
*/
155-
public get cellID(): any {
155+
public get id(): any {
156156
const primaryKey = this.grid.primaryKey;
157157
const rowID = primaryKey ? this.row?.data[primaryKey] : this.row?.data;
158158
return { rowID, columnID: this.column.index, rowIndex: this._rowIndex || this.row?.index };
@@ -269,9 +269,9 @@ export class IgxGridCell implements CellType {
269269
private isCellInEditMode(): boolean {
270270
if (this.grid.crudService.cellInEditMode) {
271271
const cellInEditMode = this.grid.crudService.cell.id;
272-
const isCurrentCell = cellInEditMode.rowID === this.cellID.rowID &&
273-
cellInEditMode.rowIndex === this.cellID.rowIndex &&
274-
cellInEditMode.columnID === this.cellID.columnID;
272+
const isCurrentCell = cellInEditMode.rowID === this.id.rowID &&
273+
cellInEditMode.rowIndex === this.id.rowIndex &&
274+
cellInEditMode.columnID === this.id.columnID;
275275
return isCurrentCell;
276276
}
277277
return false;

‎projects/igniteui-angular/src/lib/grids/grid/grid-cell-editing.spec.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -595,7 +595,7 @@ describe('IgxGrid - Cell Editing #grid', () => {
595595
const cell2 = grid.getCellByColumn(0, 'age');
596596
initialRowData = {...cell2.row.data};
597597
cellArgs = {
598-
cellID: cell2.cellID,
598+
cellID: cell2.id,
599599
rowID: cell2.row.key,
600600
rowData: initialRowData,
601601
oldValue: 20,
@@ -930,7 +930,7 @@ describe('IgxGrid - Cell Editing #grid', () => {
930930
expect(cell.value).toBe(newValue);
931931

932932
const cellArgs: IGridEditDoneEventArgs = {
933-
cellID: cell.cellID,
933+
cellID: cell.id,
934934
rowID: cell.row.key,
935935
rowData: updatedRowData, // fixture is with transactions & without rowEditing
936936
oldValue: initialValue,
@@ -998,7 +998,7 @@ describe('IgxGrid - Cell Editing #grid', () => {
998998
fixture.detectChanges();
999999

10001000
cellArgs = {
1001-
cellID: cell.cellID,
1001+
cellID: cell.id,
10021002
rowID: cell.row.key,
10031003
rowData: updatedRowData, // fixture is without rowEditing and without transactions
10041004
oldValue: 'John Brown',
@@ -1022,7 +1022,7 @@ describe('IgxGrid - Cell Editing #grid', () => {
10221022

10231023
updatedRowData = Object.assign({}, cell.row.data, { age: secondNewValue });
10241024
cellArgs = {
1025-
cellID: cell.cellID,
1025+
cellID: cell.id,
10261026
rowID: cell.row.key,
10271027
rowData: cell.row.data, // fixture is without rowEditing and without transactions
10281028
oldValue: 20,

‎projects/igniteui-angular/src/lib/grids/grid/grid-row-editing.spec.ts‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ describe('IgxGrid - Row Editing #grid', () => {
147147
fix.detectChanges();
148148
expect(row.inEditMode).toBe(true);
149149
const cellEditArgs: IGridEditEventArgs = {
150-
cellID: cell.cellID,
150+
cellID: cell.id,
151151
rowID: cell.row.key,
152152
rowData: cell.row.data,
153153
oldValue: cell.value,
@@ -174,7 +174,7 @@ describe('IgxGrid - Row Editing #grid', () => {
174174

175175
expect(row.inEditMode).toBe(false);
176176
let cellEditExitArgs: IGridEditDoneEventArgs = {
177-
cellID: cell.cellID,
177+
cellID: cell.id,
178178
rowID: cell.row.rowID,
179179
rowData: cell.row.data,
180180
oldValue: cell.value,
@@ -206,7 +206,7 @@ describe('IgxGrid - Row Editing #grid', () => {
206206
fix.detectChanges();
207207

208208
cellEditExitArgs = {
209-
cellID: cell.cellID,
209+
cellID: cell.id,
210210
rowID: cell.row.key,
211211
rowData: Object.assign({}, row.rowData, { ProductName: newCellValue }),
212212
oldValue: cell.value,
@@ -232,7 +232,7 @@ describe('IgxGrid - Row Editing #grid', () => {
232232

233233
const cellDoneArgs: IGridEditDoneEventArgs = {
234234
rowID: cell.row.key,
235-
cellID: cell.cellID,
235+
cellID: cell.id,
236236
rowData: updatedRowData, // with rowEditable - IgxGridRowEditingComponent
237237
oldValue: cell.value,
238238
newValue: newCellValue,
@@ -578,7 +578,7 @@ describe('IgxGrid - Row Editing #grid', () => {
578578
}));
579579

580580
it(`Should skip non-editable columns`, () => {
581-
const cellID = grid.gridAPI.get_cell_by_index(0, 'ID');
581+
const cell = grid.gridAPI.get_cell_by_index(0, 'ID');
582582
const cellReleaseDate = grid.gridAPI.get_cell_by_index(0, 'ReleaseDate');
583583
targetCell = grid.gridAPI.get_cell_by_index(0, 'Downloads');
584584
targetCellDebug = GridFunctions.getRowCells(fix, 0)[0];
@@ -593,14 +593,14 @@ describe('IgxGrid - Row Editing #grid', () => {
593593
fix.detectChanges();
594594

595595
expect(targetCell.editMode).toBeFalsy();
596-
expect(cellID.editMode).toBeFalsy();
596+
expect(cell.editMode).toBeFalsy();
597597
expect(cellReleaseDate.editMode).toBeTruthy();
598598

599599
UIInteractions.triggerEventHandlerKeyDown('tab', gridContent, false, true);
600600

601601
fix.detectChanges();
602602
expect(targetCell.editMode).toBeTruthy();
603-
expect(cellID.editMode).toBeFalsy();
603+
expect(cell.editMode).toBeFalsy();
604604
expect(cellReleaseDate.editMode).toBeFalsy();
605605
});
606606

@@ -1953,7 +1953,7 @@ describe('IgxGrid - Row Editing #grid', () => {
19531953
spyOn(grid.cellEdit, 'emit').and.callThrough();
19541954
// TODO: cellEdit should emit updated rowData - issue #7304
19551955
const cellArgs = {
1956-
cellID: cell.cellID,
1956+
cellID: cell.id,
19571957
rowID: cell.row.key,
19581958
rowData: cell.row.data,
19591959
oldValue: 'Chai',
@@ -2161,7 +2161,7 @@ describe('IgxGrid - Row Editing #grid', () => {
21612161

21622162
const cellDoneArgs: IGridEditDoneEventArgs = {
21632163
rowID: cell.row.key,
2164-
cellID: cell.cellID,
2164+
cellID: cell.id,
21652165
rowData: updatedRowData, // with rowEditable&Transactions - IgxGridRowEditingTransactionComponent
21662166
oldValue: cell.value,
21672167
newValue: newCellValue,

‎projects/igniteui-angular/src/lib/grids/grid/grid.nested.props.spec.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,7 @@ describe('Edit cell with data of type Array #grid', () => {
533533

534534
const cellArgs: IGridEditEventArgs = {
535535
rowID: cell.row.key,
536-
cellID: cell.cellID,
536+
cellID: cell.id,
537537
rowData: initialRowData,
538538
oldValue: initialRowData.locations,
539539
cancel: false,
@@ -595,7 +595,7 @@ describe('Edit cell with data of type Array #grid', () => {
595595

596596
const cellArgs: IGridEditEventArgs = {
597597
rowID: cell.row.key,
598-
cellID: cell.cellID,
598+
cellID: cell.id,
599599
rowData: initialRowData,
600600
oldValue: initialRowData.locations,
601601
cancel: false,

‎projects/igniteui-angular/src/lib/grids/grid/grid.pinning.spec.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -248,15 +248,15 @@ describe('IgxGrid - Column Pinning #grid', () => {
248248
await wait(DEBOUNCETIME);
249249
fix.detectChanges();
250250

251-
const cellID = grid.gridAPI.get_cell_by_index(0, 'ID');
252-
expect(cellID.active).toBe(true);
251+
const cell = grid.gridAPI.get_cell_by_index(0, 'ID');
252+
expect(cell.active).toBe(true);
253253
expect(cellContactName.active).toBe(false);
254254

255255
grid.navigation.dispatchEvent(UIInteractions.getKeyboardEvent('keydown', 'ArrowLeft'));
256256
await wait(DEBOUNCETIME);
257257
fix.detectChanges();
258258

259-
expect(cellID.active).toBe(false);
259+
expect(cell.active).toBe(false);
260260
expect(cellContactName.active).toBe(true);
261261
}));
262262
});
@@ -656,15 +656,15 @@ describe('IgxGrid - Column Pinning #grid', () => {
656656
grid.navigation.dispatchEvent(UIInteractions.getKeyboardEvent('keydown', 'ArrowLeft', false, false, true));
657657
await wait(DEBOUNCETIME);
658658
fix.detectChanges();
659-
const cellID = grid.gridAPI.get_cell_by_index(0, 'ID');
660-
expect(cellID.active).toBe(true);
659+
const cell = grid.gridAPI.get_cell_by_index(0, 'ID');
660+
expect(cell.active).toBe(true);
661661
expect(cellCompanyName.active).toBe(false);
662662

663663
grid.navigation.dispatchEvent(UIInteractions.getKeyboardEvent('keydown', 'ArrowRight', false, false, true));
664664
await wait(DEBOUNCETIME);
665665
fix.detectChanges();
666666
const cellContactName = grid.gridAPI.get_cell_by_index(0, 'ContactName');
667-
expect(cellID.active).toBe(false);
667+
expect(cell.active).toBe(false);
668668
expect(cellContactName.active).toBe(true);
669669
}));
670670
});

‎projects/igniteui-angular/src/lib/grids/hierarchical-grid/hierarchical-grid.navigation.spec.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -587,8 +587,8 @@ describe('IgxHierarchicalGrid Basic Navigation #hGrid', () => {
587587
await wait(50);
588588
fixture.detectChanges();
589589

590-
const cellID = hierarchicalGrid.gridAPI.get_cell_by_index(0, 'ID');
591-
GridFunctions.focusCell(fixture, cellID);
590+
const cellElem = hierarchicalGrid.gridAPI.get_cell_by_index(0, 'ID');
591+
GridFunctions.focusCell(fixture, cellElem);
592592
fixture.detectChanges();
593593

594594
UIInteractions.triggerEventHandlerKeyDown('end', baseHGridContent, false, false, false);

‎projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-selection.spec.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -996,7 +996,7 @@ describe('IgxTreeGrid - Selection #tGrid', () => {
996996
treeGrid.rowEditable = true;
997997

998998
// select the second row
999-
treeGrid.selectRows([targetCell.cellID.rowID], true);
999+
treeGrid.selectRows([targetCell.id.rowID], true);
10001000
tick(16);
10011001
fix.detectChanges();
10021002

0 commit comments

Comments
 (0)