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
<!DOCTYPE html><html><head><title>Sample | Ignite UI | Web Components | infragistics</title><metacharset="UTF-8" /><linkrel="shortcut icon"href="https://static.infragistics.com/xplatform/images/browsers/wc.png" ><linkrel="stylesheet"href="https://fonts.googleapis.com/icon?family=Material+Icons" /><linkrel="stylesheet"href="https://fonts.googleapis.com/css?family=Kanit&display=swap" /><linkrel="stylesheet"href="https://fonts.googleapis.com/css?family=Titillium Web" /><linkrel="stylesheet"href="https://static.infragistics.com/xplatform/css/samples/shared.v8.css" /><linkrel="stylesheet"href="/src/index.css"type="text/css" /></head><body><divid="root"><divclass="container sample ig-typography"><divclass="container fill"><igc-tree-gridauto-generate="false"name="treeGrid"id="treeGrid"id="treeGrid"primary-key="ID"allow-filtering="true"foreign-key="ParentID"><igc-paginatorper-page="10"></igc-paginator><igc-columnfield="Name"data-type="string"editable="true"has-summary="true"></igc-column><igc-columnfield="Title"data-type="string"editable="true"has-summary="true"></igc-column><igc-columnfield="Age"data-type="number"editable="true"has-summary="true"></igc-column><igc-columnfield="HireDate"data-type="date"editable="true"has-summary="true"></igc-column><igc-columnfield="OnPTO"data-type="boolean"editable="true"has-summary="true"width="130px"></igc-column></igc-tree-grid></div></div></div><!-- This script is needed only for parcel and it will be excluded for webpack -->
<% if (false) { %><scriptsrc="src/index.ts"></script><% } %>
</body></html>html
/* shared styles are loaded from: *//* https://static.infragistics.com/xplatform/css/samples */css
Like this sample? Get access to our complete Ignite UI for Web Components toolkit and start building your own apps in minutes. Download it for free.
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:
Another way to update cell is directly through Update method of Cell:
publicupdateCell() {
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:
import'igniteui-webcomponents-grids/grids/combined';
import { ComponentRenderer, WebTreeGridDescriptionModule, WebSelectDescriptionModule } from'igniteui-webcomponents-core';
import { IgcTreeGridComponent, IgcColumnComponent } from'igniteui-webcomponents-grids/grids';
import { RoleplayTreeGridDataItem, RoleplayTreeGridData } from'./RoleplayTreeGridData';
import { IgcCellTemplateContext } from'igniteui-webcomponents-grids/grids';
import { html, nothing } from'lit-html';
import"igniteui-webcomponents-grids/grids/themes/light/bootstrap.css";
import'igniteui-webcomponents/themes/light/bootstrap.css';
import { defineAllComponents } from'igniteui-webcomponents';
defineAllComponents();
import"./index.css";
exportclassSample{
private treeGrid1: IgcTreeGridComponent
private column1: IgcColumnComponent
private column2: IgcColumnComponent
private column3: IgcColumnComponent
private _bind: () =>void;
constructor() {
var treeGrid1 = this.treeGrid1 = document.getElementById('treeGrid1') as IgcTreeGridComponent;
var column1 = this.column1 = document.getElementById('column1') as IgcColumnComponent;
var column2 = this.column2 = document.getElementById('column2') as IgcColumnComponent;
var column3 = this.column3 = document.getElementById('column3') as IgcColumnComponent;
this._bind = () => {
treeGrid1.data = this.roleplayTreeGridData;
column1.inlineEditorTemplate = this.webTreeGridCellEditCellTemplate;
column2.inlineEditorTemplate = this.webTreeGridCellEditCellTemplate;
column3.inlineEditorTemplate = this.webTreeGridCellEditCellTemplate;
}
this._bind();
}
private _roleplayTreeGridData: RoleplayTreeGridData = null;
publicgetroleplayTreeGridData(): RoleplayTreeGridData {
if (this._roleplayTreeGridData == null)
{
this._roleplayTreeGridData = new RoleplayTreeGridData();
}
returnthis._roleplayTreeGridData;
}
private _componentRenderer: ComponentRenderer = null;
publicgetrenderer(): ComponentRenderer {
if (this._componentRenderer == null) {
this._componentRenderer = new ComponentRenderer();
var context = this._componentRenderer.context;
WebTreeGridDescriptionModule.register(context);
WebSelectDescriptionModule.register(context);
}
returnthis._componentRenderer;
}
public webTreeGridCellEditCellTemplate = (ctx: IgcCellTemplateContext) => {
let cellValues: any = [];
let uniqueValues: any = [];
let roleplayData = this.roleplayTreeGridData
for (const i of (roleplayData asany)){
const field: string = ctx.cell.column.field;
if(uniqueValues.indexOf(i[field]) === -1 )
{
if (ctx.cell.value == i[field]) {
cellValues.push(html`<igc-select-itemselectedvalue=${i[field]}>${(i[field])}</igc-select-item>`);
} else cellValues.push(html`<igc-select-itemvalue=${i[field]}>${(i[field])}</igc-select-item>`);
uniqueValues.push(i[field]);
}
}
return html`<igc-selectstyle="width:100%; height:100%; --ig-size: var(--ig-size-large);" @igcChange=${(e: any) => ctx.cell.editValue = e.detail.value}>${cellValues}</igc-select>
`;
}
}
new Sample();
ts
<!DOCTYPE html><html><head><title>Sample | Ignite UI | Web Components | infragistics</title><metacharset="UTF-8" /><linkrel="shortcut icon"href="https://static.infragistics.com/xplatform/images/browsers/wc.png" ><linkrel="stylesheet"href="https://fonts.googleapis.com/icon?family=Material+Icons" /><linkrel="stylesheet"href="https://fonts.googleapis.com/css?family=Kanit&display=swap" /><linkrel="stylesheet"href="https://fonts.googleapis.com/css?family=Titillium Web" /><linkrel="stylesheet"href="https://static.infragistics.com/xplatform/css/samples/shared.v8.css" /><linkrel="stylesheet"href="/src/index.css"type="text/css" /></head><body><divid="root"><divclass="container sample ig-typography"><divclass="container fill"><igc-tree-gridauto-generate="false"name="treeGrid1"id="treeGrid1"id="treeGrid1"primary-key="ID"foreign-key="ParentID"><igc-columnfield="Name"header="Character Name"data-type="string"></igc-column><igc-columnfield="Race"header="Race"data-type="string"editable="true"name="column1"id="column1"></igc-column><igc-columnfield="Class"header="Class"data-type="string"editable="true"name="column2"id="column2"></igc-column><igc-columnfield="Age"header="Age"data-type="string"editable="true"></igc-column><igc-columnfield="Alignment"header="Alignment"data-type="string"editable="true"name="column3"id="column3"></igc-column></igc-tree-grid></div></div></div><!-- This script is needed only for parcel and it will be excluded for webpack -->
<% if (false) { %><scriptsrc="src/index.ts"></script><% } %>
</body></html>html
/* shared styles are loaded from: *//* https://static.infragistics.com/xplatform/css/samples */css
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.
publicaddNewChildRow() {
// 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 rowthis.treeGrid.updateRow(newData, this.selectedCell.cellID.rowID);
// Just a particular cell through the Tree Grid APIthis.treeGrid.updateCell(newData, this.selectedCell.cellID.rowID, this.selectedCell.column.field);
// Directly using the cell `update` methodthis.selectedCell.update(newData);
// Directly using the row `update` methodconst 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 APIthis.treeGrid.deleteRow(this.selectedCell.cellID.rowID);
// Delete row through row objectconst row = this.treeGrid.getRowByIndex(rowIndex);
row.delete();
typescript
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!');
}
} elseif (column.field === 'HireDate') {
if (event.detail.newValue > newDate().getTime()) {
event.detail.cancel = true;
alert('The employee hire date must be in the past!');
}
}
}
typescript
If the value entered in a cell under the Age column is below 18 or the value in the HireDate column is in the future, the editing will be cancelled and the user will be alerted to the cancellation.
The result of the above validation being applied to our IgcTreeGridComponent can be seen in the below demo:
import'igniteui-webcomponents-grids/grids/combined';
import { ComponentRenderer, WebTreeGridDescriptionModule } from'igniteui-webcomponents-core';
import { IgcTreeGridComponent } from'igniteui-webcomponents-grids/grids';
import { EmployeesNestedTreeDataItem, EmployeesNestedTreeData } from'./EmployeesNestedTreeData';
import { IgcGridComponent, IgcGridEditEventArgs } from'igniteui-webcomponents-grids/grids';
import"igniteui-webcomponents-grids/grids/themes/light/bootstrap.css";
import"./index.css";
exportclassSample{
private treeGrid: IgcTreeGridComponent
private _bind: () =>void;
constructor() {
var treeGrid = this.treeGrid = document.getElementById('treeGrid') as IgcTreeGridComponent;
this.webTreeGridCellEdit = this.webTreeGridCellEdit.bind(this);
this._bind = () => {
treeGrid.data = this.employeesNestedTreeData;
treeGrid.addEventListener("cellEdit", this.webTreeGridCellEdit);
}
this._bind();
}
private _employeesNestedTreeData: EmployeesNestedTreeData = null;
publicgetemployeesNestedTreeData(): EmployeesNestedTreeData {
if (this._employeesNestedTreeData == null)
{
this._employeesNestedTreeData = new EmployeesNestedTreeData();
}
returnthis._employeesNestedTreeData;
}
private _componentRenderer: ComponentRenderer = null;
publicgetrenderer(): ComponentRenderer {
if (this._componentRenderer == null) {
this._componentRenderer = new ComponentRenderer();
var context = this._componentRenderer.context;
WebTreeGridDescriptionModule.register(context);
}
returnthis._componentRenderer;
}
public webTreeGridCellEdit(args: CustomEvent<IgcGridEditEventArgs>): void {
const column = args.detail.column;
if (column.field === 'Age') {
if (args.detail.newValue < 18) {
args.detail.cancel = true;
alert('Employees must be at least 18 years old!');
}
} elseif (column.field === 'HireDate') {
if (args.detail.newValue > newDate().getTime()) {
args.detail.cancel = true;
alert('The employee hire date must be in the past!');
}
}
}
}
new Sample();
ts
<!DOCTYPE html><html><head><title>Sample | Ignite UI | Web Components | infragistics</title><metacharset="UTF-8" /><linkrel="shortcut icon"href="https://static.infragistics.com/xplatform/images/browsers/wc.png" ><linkrel="stylesheet"href="https://fonts.googleapis.com/icon?family=Material+Icons" /><linkrel="stylesheet"href="https://fonts.googleapis.com/css?family=Kanit&display=swap" /><linkrel="stylesheet"href="https://fonts.googleapis.com/css?family=Titillium Web" /><linkrel="stylesheet"href="https://static.infragistics.com/xplatform/css/samples/shared.v8.css" /><linkrel="stylesheet"href="/src/index.css"type="text/css" /></head><body><divid="root"><divclass="container sample ig-typography"><divclass="container fill"><igc-tree-gridauto-generate="false"name="treeGrid"id="treeGrid"id="treeGrid"primary-key="ID"foreign-key="ParentID"><igc-columnfield="Name"data-type="string"></igc-column><igc-columnfield="Title"data-type="string"></igc-column><igc-columnfield="Age"data-type="number"editable="true"></igc-column><igc-columnfield="HireDate"data-type="date"editable="true"></igc-column></igc-tree-grid></div></div></div><!-- This script is needed only for parcel and it will be excluded for webpack -->
<% if (false) { %><scriptsrc="src/index.ts"></script><% } %>
</body></html>html
/* shared styles are loaded from: *//* https://static.infragistics.com/xplatform/css/samples */css
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:
<!DOCTYPE html><html><head><title>Sample | Ignite UI | Web Components | infragistics</title><metacharset="UTF-8" /><linkrel="shortcut icon"href="https://static.infragistics.com/xplatform/images/browsers/wc.png" ><linkrel="stylesheet"href="https://fonts.googleapis.com/icon?family=Material+Icons" /><linkrel="stylesheet"href="https://fonts.googleapis.com/css?family=Kanit&display=swap" /><linkrel="stylesheet"href="https://fonts.googleapis.com/css?family=Titillium Web" /><linkrel="stylesheet"href="https://static.infragistics.com/xplatform/css/samples/shared.v8.css" /><linkrel="stylesheet"href="/src/index.css"type="text/css" /></head><body><divid="root"><divclass="container sample ig-typography"><divclass="container fill"><igc-tree-gridauto-generate="false"name="treeGrid"id="treeGrid"id="treeGrid"primary-key="ID"allow-filtering="true"foreign-key="ParentID"><igc-paginatorper-page="10"></igc-paginator><igc-columnfield="Name"data-type="string"editable="true"></igc-column><igc-columnfield="Title"data-type="string"editable="true"></igc-column><igc-columnfield="Age"data-type="number"editable="true"></igc-column><igc-columnfield="HireDate"data-type="date"editable="true"></igc-column><igc-columnfield="OnPTO"data-type="boolean"editable="true"width="130px"></igc-column></igc-tree-grid></div></div></div><!-- This script is needed only for parcel and it will be excluded for webpack -->
<% if (false) { %><scriptsrc="src/index.ts"></script><% } %>
</body></html>html