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

TaskConfigureFrom codeHear of it
Change recordstransaction, setRowschanged (exact old and new values)
Save changes to your backenddata.savedata.save()getStatus().data
Validate a change before it landsdata.rulesdata.check()writeBlocked
Say who may change whatcapabilitiescan, canEditwriteBlocked
Show a change for approval, then apply itprepare, then commit
Act on records ("Approve", "Assign to me")compose.commandsgetCommands, runCommandwriteBlocked (source action)
Total or export every matching recordrecords('matching'), exportCsv
Show a record wherever it isrevealRecord

Selection and navigation

TaskConfigureFrom codeHear of it
Let people select rowsrowSelectionsetState({ selectedRowIds })rowSelectionChanged
Act on the selectionactionsrecords('selected')rowSelectionChanged
Someone presses a linked recordrecordOpenRequested
Scroll to a row already on displayscrollToRow, scrollToCell

Layout and views

TaskConfigureFrom codeHear of it
Pin columnscolumn pinnedsetState({ columnState })
Show records as a board or calendarworkspace, presentationsetState({ presentation })onPresentationChange
Save and restore the layoutstoragegetState, setState
Translate the gridmessagesgetMessages
Edit on GitHub

Last updated on

On this page