Terms and help
Terms
Read the definitions of the words these docs use for grid concepts.
A term row links to the page that explains it.
Terms
| Term | Meaning | Page |
|---|---|---|
| accessor | The accessorKey or accessorFn that reads a column's value from a row. | ColumnDef |
| active cell | The one cell that has focus and receives typing. | Keyboard navigation |
| add-on | An optional registry item you install, such as data-grid-fill. It ships hooks and components. | Add-ons A to Z |
| aggregate row | A pinned row that aggregateRow or serverAggregateRow declares. The band computes its values and reads them by column id. | Pinned rows |
| all matching | The whole result as the target of a bulk action. selectAllMatching() turns it on and the status bar offers it. | Select server rows |
| anchor | The cell where a selection started. | Selection model |
| anonymous comment | A comment with no author. It comes from a write with no currentUser. Anyone can edit and delete it by default. | Add comments to cells |
| band | A fixed strip of rows above or below the body, such as pinned rows. A group row never enters a band. | Pinned rows |
| blank operand | The empty value ("", ["", ""], []) of a filter row that the user has not filled in. The query layer gives it the meaning the grid gives it. | Query layer reference |
| block | The fixed-size slice of rows that scroll mode requests. | Load rows while scrolling |
| block move | Moving several rows so they land next to each other in their current order: reorderRows(rows, to). moveRowsBy(rows, delta) shifts each row and keeps the gaps. | Row order |
| blocking rule | A column rule that stops the commit of a value it rejects. It is the default of validationMode. | Validation |
| cell type | The kind of value a column holds, for example text or number. | Cell type model |
| change | One onDataChange call: a batch of operations plus its source. | Data change events |
| checked row | A row whose marker checkbox is on, kept in the row channel of the selection. | Checked rows |
| checked rows lifetime | How long the checked rows last: 'until-click', 'until-cleared', or 'across-filters'. Set by the prop checkedRowsLifetime. | Checked rows |
| child list | The rows or the groups that a server grid holds for one open row group, or for the top level. One request reads one child list, named by groupPath. | Group server rows |
clearContents | Empties the selected cells. | Keyboard shortcuts |
| coarse pointer | An input whose (pointer: coarse) media query matches, such as a finger. Hit areas grow under it. | Pointer selection |
| column group | A named set of columns, or of other groups, that share one header above their own headers. columnGroups defines it. | Column headers and groups |
| column map | The list of columns a server request can name, from defineColumnMap. It is the allow-list and the projection. | Query layer |
| comment address | The pair rowId and columnId that names the cell of a comment. A comment never holds a view index. | Add comments to cells |
| comment author | The author of a comment: a snapshot of the writer with an id, and optionally a name and a color. The identity is author.id. | Comments options |
| comment conflict | The state of a comment write that a newer version from another client made stale. The popover offers the text again with Retry, Discard, or Save my version. Not the save conflict of a row. | Add comments to cells |
| comment draft | Text in the composer, an edit, or a delete confirm that the user has not submitted. It stays when the popover closes. | Add comments to cells |
| comment marker | The corner shape on a commented cell: filled for an unresolved comment, a ring for resolved comments only. Not the row marker. | Add comments to cells |
| comments popover | The non-modal dialog that lists the comments of one cell and holds the composer. Shift+F2, the comment marker, or the "Comments…" menu item opens it. | Add comments to cells |
| commit | Check a value with validate and write it to the data. | Validation |
| controlled / uncontrolled | data puts the state in your code. defaultData seeds the grid once. | Event shapes |
| core | The data-grid item. Add-ons build on it. | Install gridcn |
| custom operator | A filter operator a column registers in filter.operators with an id, a label, an input shape, and an optional match. A server vocabulary uses it to name its own filters. | Filtering |
| data index | A row's position in your data array. | State and view index |
| data mode | One way the grid gets its rows, such as a local array or server pages. | Data mode guide |
| drag handle | The control you drag to reorder a row or a sort entry. | Row order |
| driver adapter | The Prisma layer that connects the client to a database driver. It is not an ORM adapter. | Query layer |
| echo | A record that comes back through applyRemote, a fetch answer, or the comments prop with the write id of a pending write. It confirms the write. | Add comments to cells |
| eviction | Unloading loaded rows back to holes, so a hole renders as a skeleton again. maxLoadedRows and evict() do it. | Tune row retention |
| expanded state | { mode, ids }: the row groups that differ from mode, named by group id. It decides which groups show their rows. | Row grouping |
| export source | The function that returns the rows of the whole result for an all-rows export. It gets the spec and a signal. | Export the whole result |
| filter group | A box of filter nodes that match together. Its join is and or or. A group holds one more group at most. not: true negates it: it matches the rows its children do not match. The top level of filterState combines with the filter join. | Filtering |
| filter join | How the top-level entries of filterState combine: and or or. filterJoin sets it. A filter group has its own join. | Filtering |
| filter menu | The toolbar menu where the user builds filters from filter rows and filter groups. DataGridFilterMenu is the built-in one. | Toolbar |
| filter node | One entry of filterState: a filter row or a filter group. | Filtering |
| find and replace | The add-on panel that finds text through the quick search and replaces it in one match or in all matches. A replace writes one change with the source "replace". | Find and replace |
| frame reorder | The reorder: "frame" value of updateCells: the values write at once, and one re-place at the next animation frame covers every patched row. | Push live values |
| gate | A prop function that the grid calls before it acts, for example processPaste or createRow. It returns a value or a promise. | Event shapes |
| gate pending | The state of a gate whose promise has not settled. useDataGridGatePending() reads the gate names. The root carries data-gate-pending. | Gate cancellation and timeouts |
| grid origin | The row that anchors the rows canvas. It trails the first rendered row and moves only when the rendered rows drift far from it. | Virtualization |
| group key | The stored value that the rows of a row group share. null, undefined, and "" form one empty key. | Row grouping |
| group level | The place of a group column in groupBy. The first column is level 0. | Row grouping |
| group path | The group keys from the outermost level down to one row group: one { columnId, key } per level. A server request names the group whose children it reads with groupPath. | Server rows contract |
| group row | The view row that heads a row group. It holds no data. A viewIndex entry below 0 names it. | Row grouping |
| header filter | The filter button in a column header. It opens a popover with the set filter of that column. renderHeaderFilter places it, and DataGridHeaderFilter is the built-in one. | Header filter |
| header row | One level of the header block. Group levels come first, and the column headers fill the last row. | Column headers and groups |
| hidden checked row | A checked row that a filter, a page change, or a window move takes out of the view. checkedRowsLifetime="across-filters" remembers it by row id, outside the row channel. The grid's row operations never act on it. | Checked rows |
| hosted registry | The @gridcn registry that serves the most recent deployment of main. | Install gridcn |
| id swap | Replacing the client id of a row with the id the server assigned, through actions.replaceRowId. | Save edits |
| import check | The server answer to checkImport: the rows it refuses and the counts it reports, read before onImport runs. parseImportRows is the query-layer side. | Import options |
| jump | A scroll of more than the viewport height plus 1,600 px in one scroll tick. After a jump, the grid mounts only the base overscan. | Virtualization |
| keep range | The wanted range grown by one more block on each side. Scroll mode aborts and evicts only blocks outside it. | Tune row retention |
| live region announcement | The text the grid's live region reads to a screen reader: a row move, the number of checked rows, or the result count. The region waits 500 ms after the last change. | Screen reader support |
| long-press | A touch press held for 500 ms without moving more than 10 px. It opens the context menu. | Pointer selection |
| lookup | A cell type whose options a server searches as the user types. | Lookup cell |
moveUpKeepSelection | Moves the active cell and keeps the selection. | Keyboard shortcuts |
| native fragment | A piece of SQL in the type of one ORM, such as the sql fragment of Drizzle. where(plan), orderBy(plan), and customOperators use it. | Query layer |
| operation | One record of a change to one row: insert, update, delete, or move. DataChange.ops holds a batch. | Data change events |
| optimistic write | A comment write that the popover shows at once, at baseVersion + 1, before onCommentSave answers. A refusal reverts it. | Add comments to cells |
| ORM adapter | The add-on that runs a query plan with one ORM, such as createDrizzleGridQuery. Write "ORM adapter" for it and "driver adapter" for the Prisma database driver layer. | Query layer |
| orphaned comments | The comments of a deleted row. They stay in the store, and onOrphanedComments reports them. | Add comments to cells |
| override | A prop or callback that replaces default behavior. | Display override |
| overscan | Extra rows or columns drawn beyond the viewport edge. | Virtualization |
| paged view | A grid with pageSize or defaultPageSize. data stays whole. The sorted and filtered list is the full view, and viewIndex holds the shown page of it. | Client pagination |
| pages mode | The default mode of useDataGridServerRows: the server answers one page per request. | Load rows by page |
| paste result | The value pasteFromClipboard resolves: "ok", "permission-denied", "empty", or "refused". | Clipboard |
| pinned release | A release installed with #<ref> on the GitHub registry path. | Upgrade gridcn |
| plugin | A runtime DataGridPlugin object in the plugins prop. Many add-ons install one. Not every add-on does. | Plugin model |
| prefetch | The pages-mode request for the page after the current one, made before the user asks for it (prefetchNextPage). | Tune page loading |
| push | A change that your code writes from the server: updateCells, updateRows, or deleteRows with source: "stream". A push is not a save: it never reaches onSave. | Push live values |
| push verdict | The UpdateCellsVerdict that updateCells and updateRows return: the count of cells the call wrote, and the patches it skipped with a reason. | Read a push verdict |
| query plan | The checked form of a server request: a filter predicate, an order, a row range, and the columns to read. An ORM adapter runs it. | Query layer |
| quick search | The toolbar search that highlights matches and never filters rows. | Quick search |
| range | A rectangle of selected cells. | Selection model |
| rendered rows | The rows in the DOM. onRenderedRowsChange reports their range. The identifiers windowStart and clampRectToWindow call this range the window. | Column and viewport events |
| request, answer | What fetchRows receives (spec, start, end, cursor, signal, plus page and pageSize in pages mode) and what it resolves (rows, totalRowCount, hasMore, nextCursor). The hook validates every answer. | Server rows contract |
| reshape | A refresh() that asks the server to place pushed rows again. reshape() runs one, and reshapeDelayMs runs one after a push. | Push into a server-ordered view |
| resolved comment | A comment with resolved: true. hideResolved hides the comment marker of a cell that has only resolved comments. | Add comments to cells |
| result | Every row that matches the spec on the server. data holds the loaded rows of it. | Data mode guide |
| result count | The number of rows in the view after a filter or sort change. announceResults turns its announcement on. | Screen reader support |
| revalidation | A refresh() that the hook runs on a timer (revalidateIntervalMs). | Refresh server rows |
| row count | The size of the result. totalRowCount names it on the pager, the pagination hooks, URL pagination, and the provider prop that the hook's gridProps carries. null means unknown. | Load rows by page |
| row group | The rows that share one group key under groupBy. Not a column group and not a filter group. | Row grouping |
| row id | The stable id of a row: its id field, or the value that getRowId returns. Selection, editing, undo, and redo address rows by it. | DataGrid props |
| row marker | The narrow column at the start side that shows a row number, a checkbox, or a drag handle. | Row markers |
| row operation | The source value "row-operation" marks a change from an insert, duplicate, delete, or move of rows. | Data change events |
| row range | RowRange: { start, end } over rows, end excluded. A scroll-mode request asks for one. | Server rows contract |
| row scope | rowScope: equalities on serverOnly columns that every query of a factory adds with AND, such as the tenant. | Query layer |
| save | Sending a change to a server through onSave, or a comment write through onCommentSave. A save is accepted or refused. A refusal is reverted. | Save edits |
| save acknowledgement | The answer of onSave: nothing, { rejected }, or a rejected promise. onCommentSave answers a comment save the same way: nothing, { comment }, { rejected }, or a throw. | Save edits |
| save conflict | A refused save for which the server sent its current row. resolveSaveConflict decides whether the row becomes the server's row, stays as it is, or becomes a merged row. | Handle refused saves |
| save status | "saving" while an onSave promise is pending and "failed" after a refusal. useDataGridRowSaveStatus reads it. | Save edits |
| saved view | A named copy of the sort, filters, search, and column layout, kept by data-grid-views in a storage adapter. It holds no rows and no selection. Not the view index. | Saved views |
| scroll mode | The mode of useDataGridServerRows that fetches the blocks the rendered rows need. | Load rows while scrolling |
| seed | The initial value a default* prop gives once, at mount. | Event shapes |
| selection handle | One of the two circles at the corners of a touch selection. Dragging one extends the range. | Pointer selection |
| sequential source | A scroll-mode source whose first answer carries nextCursor, or neither a count nor a cursor. useDataGridServerRows({ mode: "scroll", source: "sequential" }) asks for it. Blocks load in order, one at a time. The grid shows the loaded rows plus one block of skeleton rows until nextCursor: null or hasMore: false ends it. | Load without row count |
| server aggregate | A value for a band that a server computes for the whole result of the current spec. | Show totals from a server |
| server grid | A grid with sortMode="server" and filterMode="server". Your backend applies the spec and the grid shows the answer. | Data mode guide |
| server mode | How a feature behaves when your server holds the rows, the sort, or the filter: sortMode or filterMode "server", or useDataGridServerRows. The heading of that section on a feature page. | Data mode guide |
| set filter | A filter that keeps or drops rows by a list of values. It uses the isAnyOf or isNoneOf operator. | Header filter |
| set values | The list of values that a header filter or an isAnyOf input offers. They come from the loaded rows, or from fetchFilterValues when the grid has it. Each has a value and a label. | Header filter |
| soft rule | A column rule that commits the value it rejects and flags the cell. validationMode: "warn" turns it on. | Validation |
| sort locale | The BCP 47 tag that orders text compares in a client sort, text range filters, and filter value lists. The sortLocale prop sets it, then locale, then "en-US". | Sorting |
| spec | What the user chose: sort, filter, and search text. ServerSpec ({ sorts, filters, searchText }) carries it to fetchRows. The page or the row range travels beside it. The mode decides who applies it. | Server rows contract |
| stale row | A loaded row that a push changed in a column the server spec reads. It keeps its place and carries data-row-stale until the server places it again. | Push into a server-ordered view |
| Standard Schema | The shared validator interface that Zod and Valibot implement. | Validation |
| start side, end side | The two ends of the inline axis. The start side is the pin: "start" zone, the end side the pin: "end" zone. In a left-to-right page start is left and end is right, in a right-to-left page the reverse. | Column order and pinning |
| tap | A touch press that lifts within 10 px and under 500 ms. A tap selects. Two taps on one cell edit. | Pointer selection |
| tombstone | The record of a deleted comment: an id, an address, and a version, with no text. It blocks an older upsert for 10 minutes. | Comments options |
typeToReplace | Typing over a cell replaces its value. | Keyboard shortcuts |
| unresolved comment | A comment with resolved: false. A cell with one unresolved comment counts as unresolved. | Add comments to cells |
| value query | The text a fetchFilterValues request carries as query. The server lists the values that match it. | Server rows contract |
| view index | A row's position in the sorted and filtered list the user sees, on the shown page of a paged grid. With groupBy, an entry below 0 names a group row. | State and view index |
| virtualization | Draw only the rows and columns in view, plus overscan. | Virtualization |
| wanted range | The rendered rows grown by overscan on each side and rounded out to blocks. Scroll mode loads the blocks of it. | Load rows while scrolling |
| write id | The random id (writeId) that the add-on puts on each comment write. A record with the pending write id is the echo of that write. | Add comments to cells |
Other words for a term
A word in this table names a term from the first table.
| Word | Term | Page |
|---|---|---|
ops | operation | Data change events |
row-op | row operation | Data change events |
id-keyed | row id | DataGrid props |
view space | view index | State and view index |
display index | view index | State and view index |
batched reorder | frame reorder | Push live values |
ticked row | checked row | Checked rows |
source kind | data mode | Data mode guide |
keep checks | checked rows lifetime | Checked rows |
remember checks | checked rows lifetime | Checked rows |
invisible check | hidden checked row | Checked rows |
filtered-out selection | hidden checked row | Checked rows |
bulk move | block move | Row order |
response | request, answer | Server rows contract |
payload | request, answer | Server rows contract |
lazy mode | scroll mode | Load rows while scrolling |
infinite rows | sequential source | Load without row count |
open-ended source | sequential source | Load without row count |
purge | eviction | Tune row retention |
polling | revalidation | Refresh server rows |
auto-refresh | revalidation | Refresh server rows |
preload | prefetch | Tune page loading |
value search | value query | Server rows contract |
result set | result | Data mode guide |
dataset | result | Data mode guide |
row total | row count | Load rows by page |
sliced data | paged view | Client pagination |
page slice | paged view | Client pagination |
select everything | all matching | Select server rows |
interceptor | gate | Event shapes |
gate busy | gate pending | Gate cancellation and timeouts |
gate loading | gate pending | Gate cancellation and timeouts |
stream update | push | Push live values |
live update | push | Push live values |
outdated row | stale row | Push into a server-ordered view |
re-sort request | reshape | Push into a server-ordered view |
deleteContents | clearContents | Keyboard shortcuts |
editReplace | typeToReplace | Keyboard shortcuts |
retainMove* | moveUpKeepSelection | Keyboard shortcuts |
windowing | virtualization | Virtualization |
windowed | virtualization | Virtualization |
row window | virtualization | Virtualization |
visible window | rendered rows | Column and viewport events |
addon | add-on | Add-ons A to Z |
fixed release | pinned release | Upgrade gridcn |
gutter | row marker | Row markers |
grip | drag handle | Row order |
column type | cell type | Cell type model |
totals source | aggregate row | Pinned rows |
column span | column group | Column headers and groups |
super header | column group | Column headers and groups |
left side | start side, end side | Column order and pinning |
right side | start side, end side | Column order and pinning |
pinned left | start side, end side | Column order and pinning |
pinned right | start side, end side | Column order and pinning |
focused cell | active cell | Keyboard navigation |
filter builder | filter menu | Toolbar |
search and replace | find and replace | Find and replace |
import validation | import check | Import options |
dry run | import check | Import options |
value filter | set filter | Header filter |
filter item | filter node | Filtering |
filter entry | filter node | Filtering |
top-level connector | filter join | Filtering |
filter bracket | filter group | Filtering |
nested filter | filter group | Filtering |
join operator | filter group | Filtering |
custom filter type | custom operator | Filtering |
plugin operator | custom operator | Filtering |
value list | set values | Header filter |
facet list | set values | Header filter |
distinct list | set values | Header filter |
column filter popup | header filter | Header filter |
press and hold | long-press | Pointer selection |
tap and hold | long-press | Pointer selection |
range handle | selection handle | Pointer selection |
touch mode | coarse pointer | Pointer selection |
escape hatch | override | Display override |
paste outcome | paste result | Clipboard |
write result | save acknowledgement | Save edits |
save state | save status | Save edits |
edit conflict | save conflict | Handle refused saves |
rekey | id swap | Save edits |
rename id | id swap | Save edits |
comment badge | comment marker | Add comments to cells |
comment flag | comment marker | Add comments to cells |
guest comment | anonymous comment | Add comments to cells |
commenter | comment author | Comments options |
cell key | comment address | Add comments to cells |
comment panel | comments popover | Add comments to cells |
comment thread | comments popover | Add comments to cells |
pending edit | optimistic write | Add comments to cells |
open comment | unresolved comment | Add comments to cells |
closed comment | resolved comment | Add comments to cells |
unsaved comment | comment draft | Add comments to cells |
collision | comment conflict | Add comments to cells |
dangling comments | orphaned comments | Add comments to cells |
request id | write id | Add comments to cells |
deleted marker | tombstone | Comments options |
reflection | echo | Add comments to cells |
loopback | echo | Add comments to cells |
schema | column map | Query layer |
whitelist | column map | Query layer |
tenant filter | row scope | Query layer |
empty value | blank operand | Query layer reference |
Search words
A search word in this table opens the page that answers it.
Related
- Task finder: find a page by the job you want to do
- Message index: the text the library prints