Web Components Tree Grid Cell Editing

    The Ignite UI for Web Components Cell Editing in Web Components Tree Grid provides a great data manipulation capability of the content of individual cells within the Web Components Tree Grid component and comes with powerful API for React CRUD operations. It is a fundamental feature in apps like spreadsheets, data tables, and data grids, allowing users to add, edit, or update data within specific cells. By default, the Grid in Ignite UI for Web Components is used in cell editing. And due to the default cell editing template, there will be different editors based on the column data type Top of Form.

    In addition, you can define your own custom templates for update-data actions and to override the default behavior for committing and discarding any changes.

    Web Components Tree Grid Cell Editing and Edit Templates Example

    EXAMPLE
    DATA
    TS
    HTML
    CSS
    Edit in:

    Cell Editing

    Editing through UI

    You can enter edit mode for specific cell, when an editable cell is focused in one of the following ways:

    • on double click;
    • on single click - Single click will enter edit mode only if the previously selected cell was in edit mode and currently selected cell is editable. If the previously selected cell was not in edit mode, single click will select the cell without entering edit mode;
    • on key press Enter;
    • on key press F2;

    You can exit edit mode without committing the changes in one of the following ways:

    • on key press Escape;
    • when you perform sorting, filtering, searching and hiding operations;

    You can exit edit mode and commit the changes in one of the following ways:

    • on key press Enter;
    • on key press F2;
    • on key press Tab;
    • on single click to another cell - when you click on another cell in the IgcTreeGridComponent, your changes will be submitted.
    • operations like paging, resize, pin or move will exit edit mode and changes will be submitted.

    The cell remains in edit mode when you scroll vertically or horizontally or click outside the IgcTreeGridComponent. This is valid for both cell editing and row editing.

    Editing through API

    You can also modify the cell value through the IgcTreeGridComponent API but only if primary key is defined:

    public updateCell() {
    this.treeGrid.updateCell(newValue, rowID, 'Age');
}
typescript

    Another way to update cell is directly through Update method of Cell:

    public updateCell() {
    const cell = this.treeGrid.getCellByColumn(rowIndex, 'Age');
    // You can also get cell by rowID if primary key is defined
    // const cell = this.treeGrid.getCellByKey(rowID, 'Age');
    cell.update(9999);
}
typescript

    Cell Editing Templates

    You can see and learn more for default cell editing templates in the general editing topic.

    If you want to provide a custom template which will be applied to a cell, you can pass such template either to the cell itself, or to its header. First create the column as you usually would:

    <igc-column
    field="Category"
    data-type="string"
    editable="true"
    id="column1">
</igc-column>
html

    and pass the templates to this column in the index.ts file:

    
constructor() {
    var treeGrid = document.getElementById('treeGrid') as IgcTreeGridComponent;
    var column1 = document.getElementById('column1') as IgcColumnComponent;

    treeGrid.data = this.webGridCellEditSampleRoleplay;
    column1.inlineEditorTemplate = this.webGridCellEditCellTemplate;
    column2.inlineEditorTemplate = this.webGridCellEditCellTemplate;
    column3.inlineEditorTemplate = this.webGridCellEditCellTemplate;
}

public webGridCellEditCellTemplate = (ctx: IgcCellTemplateContext) => {
    let cellValues: any = [];
    let uniqueValues: any = [];
    for(const i of (this.webGridCellEditSampleRoleplay as any)){
        const field: string = ctx.cell.column.field;
        if(uniqueValues.indexOf(i[field]) === -1 )
        {
            cellValues.push(html`<igc-select-item value=${i[field]}>${(i[field])}</igc-select-item>`);
            uniqueValues.push(i[field]);
        }
    }
    return html`
    <igc-select style="width:100%; height:100%" size="large" @igcChange=${(e: any) => ctx.cell.editValue = e.detail.value}>
            ${cellValues}
    </igc-select>
    `;
}
ts

    Working sample of the above can be found here for further reference:

    EXAMPLE
    DATA
    TS
    HTML
    CSS
    Edit in:

    CRUD operations

    Please keep in mind that when you perform some CRUD operation all of the applied pipes like filtering, sorting and grouping will be re-applied and your view will be automatically updated.

    The IgcTreeGridComponent provides a straightforward API for basic CRUD operations.

    Adding a new record

    The IgcTreeGridComponent component exposes the addRow method which will add the provided data to the data source itself.

    public addNewChildRow() {
    // Adding a new record
    // Assuming we have a `getNewRecord` method returning the new row data
    // And specifying the parentRowID.
    const record = this.getNewRecord();
    this.treeGrid.addRow(record, 1);
}
typescript

    Updating data in the Tree Grid

    Updating data in the Tree Grid is achieved through UpdateRow and UpdateCell methods but only if the PrimaryKey for the grid is defined. You can also directly update a cell and/or a row value through their respective update methods.

    // Updating the whole row
this.treeGrid.updateRow(newData, this.selectedCell.cellID.rowID);

// Just a particular cell through the Tree Grid API
this.treeGrid.updateCell(newData, this.selectedCell.cellID.rowID, this.selectedCell.column.field);

// Directly using the cell `update` method
this.selectedCell.update(newData);

// Directly using the row `update` method
const row = this.treeGrid.getRowByKey(rowID);
row.update(newData);
typescript

    Deleting data from the Tree Grid

    Please keep in mind that DeleteRow method will remove the specified row only if a PrimaryKey is defined.

    // Delete row through Tree Grid API
this.treeGrid.deleteRow(this.selectedCell.cellID.rowID);
// Delete row through row object
const row = this.treeGrid.getRowByIndex(rowIndex);
row.delete();
typescript

    Cell Validation on Edit Event

    Using the IgcTreeGridComponent's editing events, we can alter how the user interacts with the IgcTreeGridComponent.

    In this example, we'll validate a cell based on the data entered in it by binding to the CellEdit event. If the new value of the cell does not meet our predefined criteria, we'll prevent it from reaching the data source by cancelling the event.

    The first thing we need to do is bind to the grid's event:

    constructor() {
    var treeGrid = document.getElementById('treeGrid') as IgcTreeGridComponent;
    this.webTreeGridCellEdit = this.webTreeGridCellEdit.bind(this);
    treeGrid.addEventListener("cellEdit", this.webTreeGridCellEdit);
}
typescript

    The CellEdit emits whenever any cell's value is about to be committed. In our CellEdit definition, we need to make sure that we check for our specific column before taking any action:

    public webTreeGridCellEdit(event: CustomEvent<IgcGridEditEventArgs>): void {
    const column = event.detail.column;
    		
    if (column.field === 'Age') {
        if (event.detail.newValue < 18) {
            event.detail.cancel = true;
            alert('Employees must be at least 18 years old!');
        }
    } else if (column.field === 'HireDate') {
        if (event.detail.newValue > new Date().getTime()) {
            event.detail.cancel = true;
            alert('The employee hire date must be in the past!');
        }
    }
}

typescript

    The result of the above validation being applied to our IgcTreeGridComponent can be seen in the below demo:

    EXAMPLE
    DATA
    TS
    HTML
    CSS
    Edit in:

    Styling

    In addition to the predefined themes, the grid could be further customized by setting some of the available CSS properties. In case you would like to change some of the colors, you need to set a class for the grid first:

    <igc-tree-grid class="treeGrid"></igc-tree-grid>
html

    Then set the related CSS properties for that class:

    .treeGrid {
    --ig-grid-edit-mode-color: orange;
    --ig-grid-cell-editing-background: lightblue;
}
css

    Styling Example

    EXAMPLE
    DATA
    TS
    HTML
    CSS
    Edit in:

    API References

    Additional Resources