The grid comes with some cell editors provided out of the box. These cell editors are listed here.
- Text Cell Editor
- Large Text Cell Editor
- Select Cell Editor
- Rich Select Cell Editor (e)
- Formula Cell Editor (e)
There are also some additional cell editors that are generally used with Cell Data Types:
Example - Provided Cell Editors Copy Link
import {
ClientSideRowModelModule,
ColDef,
GridApi,
GridOptions,
ILargeTextEditorParams,
IRichCellEditorParams,
ISelectCellEditorParams,
ITextCellEditorParams,
LargeTextEditorModule,
ModuleRegistry,
SelectEditorModule,
TextEditorModule,
createGrid,
enableDevValidations,
} from "ag-grid-community";
import { RichSelectModule } from "ag-grid-enterprise";
import { colors } from "./colors";
import { ColourCellRenderer } from "./colourCellRenderer";
// Enable extended validations only for development
if (process.env.NODE_ENV !== "production") {
enableDevValidations();
}
ModuleRegistry.registerModules([
ClientSideRowModelModule,
RichSelectModule,
SelectEditorModule,
TextEditorModule,
LargeTextEditorModule,
]);
const columnDefs: ColDef[] = [
{
headerName: "Text Editor",
field: "color1",
cellRenderer: ColourCellRenderer,
cellEditor: "agTextCellEditor",
cellEditorParams: {
maxLength: 20,
} as ITextCellEditorParams,
},
{
headerName: "Select Editor",
field: "color2",
cellRenderer: ColourCellRenderer,
cellEditor: "agSelectCellEditor",
cellEditorParams: {
values: colors,
} as ISelectCellEditorParams,
},
{
headerName: "Rich Select Editor",
field: "color3",
cellRenderer: ColourCellRenderer,
cellEditor: "agRichSelectCellEditor",
cellEditorParams: {
values: colors,
cellRenderer: ColourCellRenderer,
filterList: true,
searchType: "match",
allowTyping: true,
valueListMaxHeight: 220,
} as IRichCellEditorParams,
},
{
headerName: "Large Text Editor",
field: "description",
cellEditorPopup: true,
cellEditor: "agLargeTextCellEditor",
cellEditorParams: {
maxLength: 250,
rows: 10,
cols: 50,
} as ILargeTextEditorParams,
flex: 2,
},
];
function getRandomNumber(min: number, max: number) {
// min and max included
return Math.floor(window.agRandom() * (max - min + 1) + min);
}
const data = Array.from(Array(20).keys()).map(() => {
const color = colors[getRandomNumber(0, colors.length - 1)];
return {
color1: color,
color2: color,
color3: color,
description:
"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
};
});
let gridApi: GridApi;
const gridOptions: GridOptions = {
defaultColDef: {
flex: 1,
editable: true,
},
columnDefs: columnDefs,
rowData: data,
};
const gridDiv = document.querySelector<HTMLElement>("#myGrid")!;
gridApi = createGrid(gridDiv, gridOptions);
export const colors: string[] = [
'AliceBlue',
'AntiqueWhite',
'Aqua',
'Aquamarine',
'Azure',
'Beige',
'Bisque',
'Black',
'BlanchedAlmond',
'Blue',
'BlueViolet',
'Brown',
'BurlyWood',
'CadetBlue',
'Chartreuse',
'Chocolate',
'Coral',
'CornflowerBlue',
'Cornsilk',
'Crimson',
'Cyan',
'DarkBlue',
'DarkCyan',
'DarkGoldenrod',
'DarkGray',
'DarkGreen',
'DarkGrey',
'DarkKhaki',
'DarkMagenta',
'DarkOliveGreen',
'DarkOrange',
'DarkOrchid',
'DarkRed',
'DarkSalmon',
'DarkSeaGreen',
'DarkSlateBlue',
'DarkSlateGray',
'DarkSlateGrey',
'DarkTurquoise',
'DarkViolet',
'DeepPink',
'DeepSkyBlue',
'DimGray',
'DodgerBlue',
'FireBrick',
'FloralWhite',
'ForestGreen',
'Fuchsia',
'Gainsboro',
'GhostWhite',
'Gold',
'Goldenrod',
'Gray',
'Green',
'GreenYellow',
'Grey',
'Honeydew',
'HotPink',
'IndianRed',
'Indigo',
'Ivory',
'Khaki',
'Lavender',
'LavenderBlush',
'LawnGreen',
'LemonChiffon',
'LightBlue',
'LightCoral',
'LightCyan',
'LightGoldenrodYellow',
'LightGray',
'LightGreen',
'LightGrey',
'LightPink',
'LightSalmon',
'LightSeaGreen',
'LightSkyBlue',
'LightSlateGray',
'LightSlateGrey',
'LightSteelBlue',
'LightYellow',
'Lime',
'LimeGreen',
'Linen',
'Magenta',
'Maroon',
'MediumAquamarine',
'MediumBlue',
'MediumOrchid',
'MediumPurple',
'MediumSeaGreen',
'MediumSlateBlue',
'MediumSpringGreen',
'MediumTurquoise',
'MediumVioletRed',
'MidnightBlue',
'MintCream',
'MistyRose',
'Moccasin',
'NavajoWhite',
'Navy',
'OldLace',
'Olive',
'OliveDrab',
'Orange',
'OrangeRed',
'Orchid',
'PaleGoldenrod',
'PaleGreen',
'PaleTurquoise',
'PaleVioletRed',
'PapayaWhip',
'PeachPuff',
'Peru',
'Pink',
'Plum',
'PowderBlue',
'Purple',
'Rebeccapurple',
'Red',
'RosyBrown',
'RoyalBlue',
'SaddleBrown',
'Salmon',
'SandyBrown',
'SeaGreen',
'Seashell',
'Sienna',
'Silver',
'SkyBlue',
'SlateBlue',
'SlateGray',
'SlateGrey',
'Snow',
'SpringGreen',
'SteelBlue',
'Tan',
'Teal',
'Thistle',
'Tomato',
'Turquoise',
'Violet',
'Wheat',
'White',
'WhiteSmoke',
'Yellow',
'YellowGreen',
];
import type { ICellRendererComp, ICellRendererParams } from 'ag-grid-community';
export class ColourCellRenderer implements ICellRendererComp {
eGui!: HTMLDivElement;
init(params: ICellRendererParams) {
const eGui = (this.eGui = document.createElement('div'));
eGui.style.overflow = 'hidden';
eGui.style.textOverflow = 'ellipsis';
const { value } = params;
const colorSpan = document.createElement('span');
const text = document.createTextNode(value || '');
if (value != null) {
colorSpan.style.borderLeft = '10px solid ' + params.value;
colorSpan.style.paddingRight = '5px';
}
eGui.appendChild(colorSpan);
eGui.append(text);
}
getGui() {
return this.eGui;
}
refresh() {
return false;
}
}
<div id="myGrid" style="height: 100%"></div>
Example - Cell Data Types Cell Editors Copy Link
import {
CheckboxEditorModule,
ClientSideRowModelModule,
ColDef,
DateEditorModule,
GridApi,
GridOptions,
INumberCellEditorParams,
ModuleRegistry,
NumberEditorModule,
ValueFormatterParams,
createGrid,
enableDevValidations,
} from "ag-grid-community";
// Enable extended validations only for development
if (process.env.NODE_ENV !== "production") {
enableDevValidations();
}
ModuleRegistry.registerModules([
ClientSideRowModelModule,
NumberEditorModule,
DateEditorModule,
CheckboxEditorModule,
]);
const columnDefs: ColDef[] = [
{
headerName: "Number Editor",
field: "number",
cellEditor: "agNumberCellEditor",
cellEditorParams: {
precision: 0,
} as INumberCellEditorParams,
},
{
headerName: "Date Editor",
field: "date",
valueFormatter: (params: ValueFormatterParams<any, Date>) => {
if (!params.value) {
return "";
}
const month = params.value.getMonth() + 1;
const day = params.value.getDate();
return `${params.value.getFullYear()}-${month < 10 ? "0" + month : month}-${day < 10 ? "0" + day : day}`;
},
cellEditor: "agDateCellEditor",
},
{
headerName: "Date as String Editor",
field: "dateString",
cellEditor: "agDateStringCellEditor",
},
{
headerName: "Checkbox Cell Editor",
field: "boolean",
cellEditor: "agCheckboxCellEditor",
},
];
const data = Array.from(Array(20).keys()).map((val: any, index: number) => ({
number: index,
date: new Date(2023, 5, index + 1),
dateString: `2023-06-${index < 9 ? "0" + (index + 1) : index + 1}`,
boolean: !!(index % 2),
}));
let gridApi: GridApi;
const gridOptions: GridOptions = {
defaultColDef: {
flex: 1,
editable: true,
},
columnDefs: columnDefs,
rowData: data,
};
const gridDiv = document.querySelector<HTMLElement>("#myGrid")!;
gridApi = createGrid(gridDiv, gridOptions);
<div id="myGrid" style="height: 100%"></div>