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.
| Callback | Purpose | Page |
|---|---|---|
onActiveCellChange | The active cell becomes a different cell, or clears. | Selection and cell events |
onBeforeDeleteRows | Runs before a row delete and can cancel it. | Data change events |
onBeforeEditStart | An editor is about to open. | Edit and validation events |
onCellClick | A click lands on a cell. | Selection and cell events |
onCellContextMenu | A right-click lands on a cell. | Selection and cell events |
onCellDoubleClick | A double-click lands on a cell. | Selection and cell events |
onColumnLayoutChange | Fires with the full layout after a committed change. | Column and viewport events |
onColumnResizing | Fires on each live width write during a resize drag. | Column and viewport events |
onDataChange | Fires once per change with the next array and the operations. | Data change events |
onEditEnd | A session ends, or validation refuses a commit attempt. | Edit and validation events |
onExpandedChange | Fires after the user (or toggleGroup, expandAll, collapseAll) changes the open groups. | DataGrid props |
onFilterChange | Fires with the next filter tree. | Sort and filter events |
onFilterJoinChange | Fires with the next join of the top-level filters. | Sort and filter events |
onGateAborted | Fires once for every async gate that the grid stopped waiting for, with its name and the reason. | Gate cancellation and timeouts |
onGroupByChange | Fires after the user (or setGroupBy, toggleGroupBy) changes the group columns. | DataGrid props |
onPageChange | Fires with the new page after a page change, and with 1 after a filter change. | Client pagination |
onPageSizeChange | Fires with the new page size after a change of the page size. | Client pagination |
onRenderedRowsChange | Fires with the range of rendered view rows. | Column and viewport events |
onRetry | Runs on a press of the Retry button. | DataGrid props |
onRowActionSkipped | Fires 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 |
onSave | Sends a change to a server. | Data change events |
onSaveRejected | Fires after the grid reverted a refused change, or kept it for keep: true. | Data change events |
onSearchTextChange | Fires with the next text. | Sort and filter events |
onSelectionChange | A committed selection change alters the selection. | Selection and cell events |
onSortChange | Fires with the next sort. | Sort and filter events |
onValidationError | A bulk write settles with at least one refused cell. | Edit and validation events |
Related
- Event shapes: which callback fits which event
- Props A to Z: props by name
- Hooks A to Z: hooks by name