gridcn2.0.0
Cheatsheets and messages

Events A to Z

Find a grid callback by name, read when it fires, and open the page that explains it.

Each row is a callback prop of the grid. Add-on callbacks are on Options A to Z.

CallbackPurposePage
onActiveCellChangeThe active cell becomes a different cell, or clears.Selection and cell events
onBeforeDeleteRowsRuns before a row delete and can cancel it.Data change events
onBeforeEditStartAn editor is about to open.Edit and validation events
onCellClickA click lands on a cell.Selection and cell events
onCellContextMenuA right-click lands on a cell.Selection and cell events
onCellDoubleClickA double-click lands on a cell.Selection and cell events
onColumnLayoutChangeFires with the full layout after a committed change.Column and viewport events
onColumnResizingFires on each live width write during a resize drag.Column and viewport events
onDataChangeFires once per change with the next array and the operations.Data change events
onEditEndA session ends, or validation refuses a commit attempt.Edit and validation events
onExpandedChangeFires after the user (or toggleGroup, expandAll, collapseAll) changes the open groups.DataGrid props
onFilterChangeFires with the next filter tree.Sort and filter events
onFilterJoinChangeFires with the next join of the top-level filters.Sort and filter events
onGateAbortedFires once for every async gate that the grid stopped waiting for, with its name and the reason.Gate cancellation and timeouts
onGroupByChangeFires after the user (or setGroupBy, toggleGroupBy) changes the group columns.DataGrid props
onPageChangeFires with the new page after a page change, and with 1 after a filter change.Client pagination
onPageSizeChangeFires with the new page size after a change of the page size.Client pagination
onRenderedRowsChangeFires with the range of rendered view rows.Column and viewport events
onRetryRuns on a press of the Retry button.DataGrid props
onRowActionSkippedFires when a row action (insertRows, duplicateRows, deleteRows, moveRows) does nothing, with its name and the reason. The insert, duplicate, and delete actions also return { ok: false, reason }. reorderRows and moveRowsBy (both report as moveRows) return false.Handle row action results
onSaveSends a change to a server.Data change events
onSaveRejectedFires after the grid reverted a refused change, or kept it for keep: true.Data change events
onSearchTextChangeFires with the next text.Sort and filter events
onSelectionChangeA committed selection change alters the selection.Selection and cell events
onSortChangeFires with the next sort.Sort and filter events
onValidationErrorA bulk write settles with at least one refused cell.Edit and validation events

On this page