Common tasks
What you want to do, and the prop, method or event that does it.
Each row names where a task lives: a prop or option to configure it, a method to do it from code, an event to hear of it. The invoice review example builds an approvals screen from these alone.
Records
| Task | Configure | From code | Hear of it |
|---|---|---|---|
| Change records | transaction, setRows | changed (exact old and new values) | |
| Save changes to your backend | data.save | data.save() | getStatus().data |
| Validate a change before it lands | data.rules | data.check() | writeBlocked |
| Say who may change what | capabilities | can, canEdit | writeBlocked |
| Show a change for approval, then apply it | prepare, then commit | ||
| Act on records ("Approve", "Assign to me") | compose.commands | getCommands, runCommand | writeBlocked (source action) |
| Total or export every matching record | records('matching'), exportCsv | ||
| Show a record wherever it is | revealRecord |
Selection and navigation
| Task | Configure | From code | Hear of it |
|---|---|---|---|
| Let people select rows | rowSelection | setState({ selectedRowIds }) | rowSelectionChanged |
| Act on the selection | actions | records('selected') | rowSelectionChanged |
| Someone presses a linked record | recordOpenRequested | ||
| Scroll to a row already on display | scrollToRow, scrollToCell |
Layout and views
| Task | Configure | From code | Hear of it |
|---|---|---|---|
| Pin columns | column pinned | setState({ columnState }) | |
| Show records as a board or calendar | workspace, presentation | setState({ presentation }) | onPresentationChange |
| Save and restore the layout | storage | getState, setState | |
| Translate the grid | messages | getMessages |
Edit on GitHub
Last updated on