gridcn2.0.0
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

TermMeaningPage
accessorThe accessorKey or accessorFn that reads a column's value from a row.ColumnDef
active cellThe one cell that has focus and receives typing.Keyboard navigation
add-onAn optional registry item you install, such as data-grid-fill. It ships hooks and components.Add-ons A to Z
aggregate rowA pinned row that aggregateRow or serverAggregateRow declares. The band computes its values and reads them by column id.Pinned rows
all matchingThe whole result as the target of a bulk action. selectAllMatching() turns it on and the status bar offers it.Select server rows
anchorThe cell where a selection started.Selection model
anonymous commentA comment with no author. It comes from a write with no currentUser. Anyone can edit and delete it by default.Add comments to cells
bandA fixed strip of rows above or below the body, such as pinned rows. A group row never enters a band.Pinned rows
blank operandThe 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
blockThe fixed-size slice of rows that scroll mode requests.Load rows while scrolling
block moveMoving 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 ruleA column rule that stops the commit of a value it rejects. It is the default of validationMode.Validation
cell typeThe kind of value a column holds, for example text or number.Cell type model
changeOne onDataChange call: a batch of operations plus its source.Data change events
checked rowA row whose marker checkbox is on, kept in the row channel of the selection.Checked rows
checked rows lifetimeHow long the checked rows last: 'until-click', 'until-cleared', or 'across-filters'. Set by the prop checkedRowsLifetime.Checked rows
child listThe 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
clearContentsEmpties the selected cells.Keyboard shortcuts
coarse pointerAn input whose (pointer: coarse) media query matches, such as a finger. Hit areas grow under it.Pointer selection
column groupA named set of columns, or of other groups, that share one header above their own headers. columnGroups defines it.Column headers and groups
column mapThe list of columns a server request can name, from defineColumnMap. It is the allow-list and the projection.Query layer
comment addressThe pair rowId and columnId that names the cell of a comment. A comment never holds a view index.Add comments to cells
comment authorThe 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 conflictThe 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 draftText 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 markerThe 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 popoverThe 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
commitCheck a value with validate and write it to the data.Validation
controlled / uncontrolleddata puts the state in your code. defaultData seeds the grid once.Event shapes
coreThe data-grid item. Add-ons build on it.Install gridcn
custom operatorA 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 indexA row's position in your data array.State and view index
data modeOne way the grid gets its rows, such as a local array or server pages.Data mode guide
drag handleThe control you drag to reorder a row or a sort entry.Row order
driver adapterThe Prisma layer that connects the client to a database driver. It is not an ORM adapter.Query layer
echoA 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
evictionUnloading 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 sourceThe 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 groupA 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 joinHow the top-level entries of filterState combine: and or or. filterJoin sets it. A filter group has its own join.Filtering
filter menuThe toolbar menu where the user builds filters from filter rows and filter groups. DataGridFilterMenu is the built-in one.Toolbar
filter nodeOne entry of filterState: a filter row or a filter group.Filtering
find and replaceThe 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 reorderThe 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
gateA prop function that the grid calls before it acts, for example processPaste or createRow. It returns a value or a promise.Event shapes
gate pendingThe 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 originThe 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 keyThe stored value that the rows of a row group share. null, undefined, and "" form one empty key.Row grouping
group levelThe place of a group column in groupBy. The first column is level 0.Row grouping
group pathThe 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 rowThe view row that heads a row group. It holds no data. A viewIndex entry below 0 names it.Row grouping
header filterThe 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 rowOne level of the header block. Group levels come first, and the column headers fill the last row.Column headers and groups
hidden checked rowA 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 registryThe @gridcn registry that serves the most recent deployment of main.Install gridcn
id swapReplacing the client id of a row with the id the server assigned, through actions.replaceRowId.Save edits
import checkThe 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
jumpA 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 rangeThe wanted range grown by one more block on each side. Scroll mode aborts and evicts only blocks outside it.Tune row retention
live region announcementThe 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-pressA touch press held for 500 ms without moving more than 10 px. It opens the context menu.Pointer selection
lookupA cell type whose options a server searches as the user types.Lookup cell
moveUpKeepSelectionMoves the active cell and keeps the selection.Keyboard shortcuts
native fragmentA 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
operationOne record of a change to one row: insert, update, delete, or move. DataChange.ops holds a batch.Data change events
optimistic writeA comment write that the popover shows at once, at baseVersion + 1, before onCommentSave answers. A refusal reverts it.Add comments to cells
ORM adapterThe 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 commentsThe comments of a deleted row. They stay in the store, and onOrphanedComments reports them.Add comments to cells
overrideA prop or callback that replaces default behavior.Display override
overscanExtra rows or columns drawn beyond the viewport edge.Virtualization
paged viewA 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 modeThe default mode of useDataGridServerRows: the server answers one page per request.Load rows by page
paste resultThe value pasteFromClipboard resolves: "ok", "permission-denied", "empty", or "refused".Clipboard
pinned releaseA release installed with #<ref> on the GitHub registry path.Upgrade gridcn
pluginA runtime DataGridPlugin object in the plugins prop. Many add-ons install one. Not every add-on does.Plugin model
prefetchThe pages-mode request for the page after the current one, made before the user asks for it (prefetchNextPage).Tune page loading
pushA 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 verdictThe 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 planThe 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 searchThe toolbar search that highlights matches and never filters rows.Quick search
rangeA rectangle of selected cells.Selection model
rendered rowsThe rows in the DOM. onRenderedRowsChange reports their range. The identifiers windowStart and clampRectToWindow call this range the window.Column and viewport events
request, answerWhat 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
reshapeA 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 commentA comment with resolved: true. hideResolved hides the comment marker of a cell that has only resolved comments.Add comments to cells
resultEvery row that matches the spec on the server. data holds the loaded rows of it.Data mode guide
result countThe number of rows in the view after a filter or sort change. announceResults turns its announcement on.Screen reader support
revalidationA refresh() that the hook runs on a timer (revalidateIntervalMs).Refresh server rows
row countThe 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 groupThe rows that share one group key under groupBy. Not a column group and not a filter group.Row grouping
row idThe 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 markerThe narrow column at the start side that shows a row number, a checkbox, or a drag handle.Row markers
row operationThe source value "row-operation" marks a change from an insert, duplicate, delete, or move of rows.Data change events
row rangeRowRange: { start, end } over rows, end excluded. A scroll-mode request asks for one.Server rows contract
row scoperowScope: equalities on serverOnly columns that every query of a factory adds with AND, such as the tenant.Query layer
saveSending 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 acknowledgementThe 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 conflictA 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 viewA 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 modeThe mode of useDataGridServerRows that fetches the blocks the rendered rows need.Load rows while scrolling
seedThe initial value a default* prop gives once, at mount.Event shapes
selection handleOne of the two circles at the corners of a touch selection. Dragging one extends the range.Pointer selection
sequential sourceA 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 aggregateA value for a band that a server computes for the whole result of the current spec.Show totals from a server
server gridA grid with sortMode="server" and filterMode="server". Your backend applies the spec and the grid shows the answer.Data mode guide
server modeHow 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 filterA filter that keeps or drops rows by a list of values. It uses the isAnyOf or isNoneOf operator.Header filter
set valuesThe 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 ruleA column rule that commits the value it rejects and flags the cell. validationMode: "warn" turns it on.Validation
sort localeThe 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
specWhat 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 rowA 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 SchemaThe shared validator interface that Zod and Valibot implement.Validation
start side, end sideThe 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
tapA touch press that lifts within 10 px and under 500 ms. A tap selects. Two taps on one cell edit.Pointer selection
tombstoneThe 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
typeToReplaceTyping over a cell replaces its value.Keyboard shortcuts
unresolved commentA comment with resolved: false. A cell with one unresolved comment counts as unresolved.Add comments to cells
value queryThe text a fetchFilterValues request carries as query. The server lists the values that match it.Server rows contract
view indexA 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
virtualizationDraw only the rows and columns in view, plus overscan.Virtualization
wanted rangeThe 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 idThe 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.

WordTermPage
opsoperationData change events
row-oprow operationData change events
id-keyedrow idDataGrid props
view spaceview indexState and view index
display indexview indexState and view index
batched reorderframe reorderPush live values
ticked rowchecked rowChecked rows
source kinddata modeData mode guide
keep checkschecked rows lifetimeChecked rows
remember checkschecked rows lifetimeChecked rows
invisible checkhidden checked rowChecked rows
filtered-out selectionhidden checked rowChecked rows
bulk moveblock moveRow order
responserequest, answerServer rows contract
payloadrequest, answerServer rows contract
lazy modescroll modeLoad rows while scrolling
infinite rowssequential sourceLoad without row count
open-ended sourcesequential sourceLoad without row count
purgeevictionTune row retention
pollingrevalidationRefresh server rows
auto-refreshrevalidationRefresh server rows
preloadprefetchTune page loading
value searchvalue queryServer rows contract
result setresultData mode guide
datasetresultData mode guide
row totalrow countLoad rows by page
sliced datapaged viewClient pagination
page slicepaged viewClient pagination
select everythingall matchingSelect server rows
interceptorgateEvent shapes
gate busygate pendingGate cancellation and timeouts
gate loadinggate pendingGate cancellation and timeouts
stream updatepushPush live values
live updatepushPush live values
outdated rowstale rowPush into a server-ordered view
re-sort requestreshapePush into a server-ordered view
deleteContentsclearContentsKeyboard shortcuts
editReplacetypeToReplaceKeyboard shortcuts
retainMove*moveUpKeepSelectionKeyboard shortcuts
windowingvirtualizationVirtualization
windowedvirtualizationVirtualization
row windowvirtualizationVirtualization
visible windowrendered rowsColumn and viewport events
addonadd-onAdd-ons A to Z
fixed releasepinned releaseUpgrade gridcn
gutterrow markerRow markers
gripdrag handleRow order
column typecell typeCell type model
totals sourceaggregate rowPinned rows
column spancolumn groupColumn headers and groups
super headercolumn groupColumn headers and groups
left sidestart side, end sideColumn order and pinning
right sidestart side, end sideColumn order and pinning
pinned leftstart side, end sideColumn order and pinning
pinned rightstart side, end sideColumn order and pinning
focused cellactive cellKeyboard navigation
filter builderfilter menuToolbar
search and replacefind and replaceFind and replace
import validationimport checkImport options
dry runimport checkImport options
value filterset filterHeader filter
filter itemfilter nodeFiltering
filter entryfilter nodeFiltering
top-level connectorfilter joinFiltering
filter bracketfilter groupFiltering
nested filterfilter groupFiltering
join operatorfilter groupFiltering
custom filter typecustom operatorFiltering
plugin operatorcustom operatorFiltering
value listset valuesHeader filter
facet listset valuesHeader filter
distinct listset valuesHeader filter
column filter popupheader filterHeader filter
press and holdlong-pressPointer selection
tap and holdlong-pressPointer selection
range handleselection handlePointer selection
touch modecoarse pointerPointer selection
escape hatchoverrideDisplay override
paste outcomepaste resultClipboard
write resultsave acknowledgementSave edits
save statesave statusSave edits
edit conflictsave conflictHandle refused saves
rekeyid swapSave edits
rename idid swapSave edits
comment badgecomment markerAdd comments to cells
comment flagcomment markerAdd comments to cells
guest commentanonymous commentAdd comments to cells
commentercomment authorComments options
cell keycomment addressAdd comments to cells
comment panelcomments popoverAdd comments to cells
comment threadcomments popoverAdd comments to cells
pending editoptimistic writeAdd comments to cells
open commentunresolved commentAdd comments to cells
closed commentresolved commentAdd comments to cells
unsaved commentcomment draftAdd comments to cells
collisioncomment conflictAdd comments to cells
dangling commentsorphaned commentsAdd comments to cells
request idwrite idAdd comments to cells
deleted markertombstoneComments options
reflectionechoAdd comments to cells
loopbackechoAdd comments to cells
schemacolumn mapQuery layer
whitelistcolumn mapQuery layer
tenant filterrow scopeQuery layer
empty valueblank operandQuery layer reference

Search words

A search word in this table opens the page that answers it.

WordPage
100000 rowsPerformance guidance
100k rowsPerformance guidance
2.0 add-on breaking changes2.0 add-on breaking changes
2.0 breaking changes2.0 breaking changes
429Recover from load errors
a11yScreen reader support
abort signalGate cancellation and timeouts
access controlLock cells by role
accessibilityScreen reader support
action columnRow actions example
active cell and rangeSelection model
add a columnDefine columns
add a rowRow operations
add-on breaking changes2.0 add-on breaking changes
add-on optionsOptions A to Z
after reloadRemember filters and layout
aggregate optionsPinned rows options
aggregates propStatus bar options
aggregationFeature matrix
align columnStyle overrides
all add-onsAdd-ons A to Z
all propsProps A to Z
already existsFix install problems
and or filterFiltering
annotationsAdd comments to cells
announcementsLive region messages
announceResults exampleScreen reader announcements example
api.actionsActions A to Z
apply changeOperation engine contract
applyRemoteComments options
arrow keysKeyboard navigation
asian language typingisComposingKey
assistive technologyScreen reader support
async selectLookup cell
async validationRow validation and async checks
auth gated cellsLock cells by role
auto size columnsColumn sizing
autocomplete cellLookup cell
autofillFill handle
autofill optionsFill handle options
autosizeColumn sizing
backend contractServer rows contract
badgeDisplay override
bind a key from a pluginPlugin commands and shortcuts
blank gridFix install problems
block failedRecover from load errors
blocksizeServer rows options
bookmark viewURL state
boolean columnBuilt-in cell types
border radiusColors and radius
brand colorColors and radius
breaking changes2.0 breaking changes
bug reportVersion policy and changelog
bulk replaceFind and replace
bundle costBundle size
bundle sizeBundle size
button barToolbar
button columnRow actions example
callback logEvent log example
callbacksEvents A to Z
cancel paste requestGate cancellation and timeouts
cell classStyle overrides
cell clickSelection and cell events
cell commentsAdd comments to cells
cell countStatus bar options
cell editorEditable columns
cell menuContext menu
cell notesAdd comments to cells
cell notes optionsComments options
cell refExported types
cell rendererDisplay override
cell type apiCellType contract
cell type interfaceCellType contract
cell type rulesCell type model
center columnStyle overrides
change keyboard shortcutShortcut remapping
changed rowsStyle overrides
checkbox columnBuilt-in cell types
checkbox selectionChecked rows
checked row idsChecked rows
checked rows across pagesSelect server rows
childKindGroup server rows
cjk enter keyisComposingKey
client paginationClient pagination
client to serverMove from client rows to server rows
collaborator selectionPresence options
collapse allRow grouping
color blindAccessibility gaps
color cellStyle overrides
color rows by valueStyle overrides
colorblindAccessibility gaps
colourStyle overrides
colspanColumn headers and groups
column actionsContext menu
column configColumnDef
column definitionColumnDef
column filterHeader filter
column header clickPointer selection
column header textColumn headers and groups
column layout typeLayout and display types
column mapQuery layer
column menuContext menu
column optionsColumnDef
column stateColumn and viewport events
column widthColumn sizing
comment keyboard shortcutsComments labels and hooks
comment labelsComments labels and hooks
comment marker classComments labels and hooks
comment optionsComments options
comments translationComments labels and hooks
commit on pauseuseDebouncedInput
compactDensity and small screens
compatibilityBrowser and framework support
compose gridDataGridProvider
conditional formattingStyle overrides
conditional stylingStyle overrides
conflictHandle refused saves
console warningMessage index
controlled dataData change events
controlled filterSort and filter events
controlled modeData change events
controlled propsEvent shapes
controlled sortSort and filter events
copy cellsClipboard
copy pasteClipboard
copy rowRow operations
copy to excelClipboard
cross field validationRow validation and async checks
css variablesStyle contract
csv exportExport
csv importImport
csv import optionsImport options
csv injectionExport
csv optionsExport options
csv uploadImport
csvEncodingControl the import
ctrl hFind and replace
ctrl zUndo and redo
currencyBuilt-in cell types
cursor eventSelection and cell events
cursor pagingTune page loading
cursorsShow presence
custom cell typeWrite a cell type
custom cell type checklistCell type model
custom column renderer rulesCell type model
custom commandsShortcut remapping options
custom copy formatChange copy and paste
custom cssStyle overrides
custom displayDisplay override
custom editorEditable columns
custom headerColumn headers and groups
custom menu itemsContext menu options
dark modeColors and radius
data attributesStyle contract
data change observerPlugin events
data-grid-lazy removedMigrate to 2.0
data-grid-viewsSaved views
data-row-stalePush into a server-ordered view
DataGridHeaderDataGridProvider
DataGridPlugin typePlugin API
DataGridViewsStorageSaved views options
dataset keyUndo and redo options
date pickerBuilt-in cell types
debounce text fielduseDebouncedInput
debounced inputuseDebouncedInput
declare moduleTypeScript generics
deep link pageKeep pages in URL
default keymapKeyboard navigation
default keysKeyboard shortcuts
default skip columnsImport options
default viewSaved views
delay a valueuseDebounce
delete did nothingHandle row action results
delete rowsRow operations
density modeLayout and display types
dirty rowStyle overrides
disable editingEditable columns
disable selectionSelection model
display indexState and view index
dom attributesStyle contract
double click to editEditable columns
drag and drop rowsRow order
drag fillFill handle
drag rowsRow order
drag to selectPointer selection
draw over cellsPlugin overlays
drizzleQuery layer
dropdownBuilt-in cell types
dropdown columnBuilt-in cell types
dropped framesPerformance guidance
durationDisplay override
edit activationEditable columns
edit conflictHandle refused saves
edit formEdit rows in forms
edit row in dialogEdit rows in forms
editor rulesCell type model
empty gridFix install problems
empty stateLoading state
empty state reasonLayout and display types
emptyStateLoading state
error from apiShow errors on cells
error messageMessage index
error message in cellValidation
event inspectorEvent log example
event listEvent shapes
event namesEvents A to Z
event payloadsEvent log example
evict rowsTune row retention
existing tableAdopt the grid in an existing table
expand allRow grouping
expand rowOpen a detail panel
export all rowsExport the whole result
export breaking changes2.0 add-on breaking changes
export button propsExport options
export columnsShape the export file
export formatCellShape the export file
export outputShape the export file
export server rowsExport the whole result
export sourceExport the whole result
exportRowsShape the export file
extension pointPlugin model
fetch data from apiLoad server rows
fetchAggregatesShow totals from a server
fetchCommentsComments options
fetchoptionsLookup options
fetchrows answerServer rows contract
fetchRows serverQuery layer
fill optionsFill handle options
filterFiltering
filter by columnHeader filter
filter dropdownHeader filter
filter groupsFiltering
filter menu itemsContext menu items example
filter menu propsToolbar options
filter operatorsFiltering
filter rowsFiltering
find in gridQuick search
fixed headerColumn headers and groups
footer partsClient pagination options
foreign key columnLookup cell
formEdit rows in forms
formula injectionExport
freeze columnsColumn order and pinning
freeze headerColumn headers and groups
freeze top rowColumn headers and groups
from 1.3Migrate to 2.0
frozen columnsColumn order and pinning
gate pendingHandle row action results
gate timeoutGate cancellation and timeouts
gateTimeoutMsHandle row action results
genericsTypeScript generics
getCellMenuItemsContext menu items example
getrowidDataGrid props
getting startedInstall gridcn
github issuesVersion policy and changelog
github registryFix install problems
grid contextDataGridProvider
grid directionLayout and display types
grid rectExported types
grid shows nothingFix install problems
group answerGroup server rows
group byRow grouping
group rowsRow grouping
grouped server rowsGroup server rows
groupingRow grouping
groupPathGroup server rows
gzip sizeBundle size
header cellColumn headers and groups
header menuContext menu
header menu itemsContext menu options
hello worldRender your first grid
hide columnsColumn visibility
highlight a rangePlugin overlays
highlight cellStyle overrides
highlight matchesQuick search
highlight overdue dateStyle overrides
highlight pluginWrite a plugin
history optionsUndo and redo options
hollow actionsPlugin commands and shortcuts
hooksHooks A to Z
hotkey editorShortcut remapping
hotkeysGlobal shortcuts
how fastBenchmark results
how styling worksStyling model
how to installInstall gridcn
huge dataPerformance guidance
hydrationRender the grid on the server
hydration mismatchRender the grid on the server
i18n exampleRight-to-left example
icon in cellDisplay override
id from apiChange server rows
image in cellDisplay override
ime enter submitsisComposingKey
import breaking changes2.0 add-on breaking changes
import encodingControl the import
import file size limitImport options
import hooksControl the import
import server gridImport into a server grid
import server rowsImport into a server grid
import to serverImport into a server grid
import totalRowCountImport into a server grid
incremental adoptionAdopt the grid in an existing table
infinite scrollLoad rows while scrolling
insert on serverChange server rows
invalid valueValidation
invert changeOperation engine contract
jsdomTest a grid in your app
keep editsKeep edits in state
keep layoutRemember filters and layout
key binding syntaxShortcut remapping options
key bindingsKeyboard shortcuts
keybindingsShortcut remapping
keybindings dialog propsShortcut remapping options
keyboard shortcuts in the gridKeyboard navigation
keyset paginationTune page loading
keyset pagingLoad without row count
kilobytesBundle size
known issuesAccessibility gaps
kyselyQuery layer
laggyPerformance guidance
languageLabels and i18n
large datasetPerformance guidance
lazy loading rowsLoad rows while scrolling
lift storeDataGridProvider
limitationsAccessibility gaps
line numbersRow markers
linked gridsLink multiple grids
list of add-onsAdd-ons A to Z
live region demoScreen reader announcements example
live updatesPush live values
load data from an apiLoad server rows
load moreLoad rows while scrolling
loading spinnerLoading state
localizationLabels
localizeLabels and i18n
lookupoptionsLookup options
make a column editableEditable columns
manual row orderRow order
many rowsPerformance guidance
mark edited rowsStyle overrides
master detailOpen a detail panel
master detail gridsLink multiple grids
max rowsRow limits
memory limitTune row retention
menu idsContext menu options
migrate to 2.0Migrate to 2.0
migrate to server rowsMove from client rows to server rows
migrationUpgrade gridcn
mobileDensity and small screens
module augmentationTypeScript generics
monorepoFix install problems
mouse selectionPointer selection
multi row actionRun bulk actions
multi selectBuilt-in cell types
multi sortSorting
multi-column sortSorting
multi-field editEdit rows in forms
multi-select cellsSelection model
multiplayerShow presence
named viewSaved views
new rowRow operations
next cursorTune page loading
next tokenLoad without row count
next.js app routerInstall gridcn
no data messageLoading state
no rowsFix install problems
no rows messageLoading state
noResults announcementLive region messages
nothing rendersFix install problems
number cellBuilt-in cell types
number formatBuilt-in cell types
nuqsURL state options
observe editsPlugin events
ok falseHandle row action results
onbeforeeditstartEdit and validation events
onCommentSaveComments options
ondatachangeData change events
one million rowsRow limits
oneditendEdit and validation events
oneditstartEdit and validation events
onGateAbortedHandle row action results
oninvalidEdit and validation events
onRowActionSkippedHandle row action results
onsaveSave edits
onsaverejectedSave edits
onvalidationerrorEdit and validation events
optimistic updateRevert or refetch after a save
option namesOptions A to Z
ormQuery layer
overdueStyle overrides
overlay contextPlugin overlays
override grid classesStyling model
overwriteFix install problems
page in urlKeep pages in URL
page navigationClient pagination
page query paramKeep pages in URL
page sizeClient pagination
page size optionsClient pagination options
pagerClient pagination
pager propsClient pagination options
paginationClient pagination
pagingClient pagination
paint over cellsPlugin overlays
parseFileControl the import
partial saveHandle refused saves
past dueStyle overrides
paste from a spreadsheetClipboard
patch rowsOperation engine contract
pdf page sizePrint example
percentBuilt-in cell types
performance numbersBenchmark results
permissionsLock cells by role
persist column layoutSave a column layout
persist layoutRemember filters and layout
persist sort and filterURL state
photoDisplay override
pin leftColumn order and pinning
pin rowsPinned rows
pin rows to the edgePlugin overlays
playwrightTest a grid in your app
plugin apiPlugin API
plugin commandsPlugin commands and shortcuts
plugin hotkeysPlugin commands and shortcuts
plugin identityPlugin model
plugin interfacePlugin API
plugin membersPlugin model
plugin object typePlugin model
plugin onDataChangePlugin events
pnpm workspaceFix install problems
prefetchNextPageTune page loading
presence highlightPresence options
printExport
print buttonPrint example
print optionsExport options
processcellforclipboardChange copy and paste
processcellfromclipboardChange copy and paste
processCellFromTextControl the import
processFill contextFill handle options
processImportRowsControl the import
processpasteChange copy and paste
programmatic row actionsRow operations
programmatic undoUndo for code changes
progress barDisplay override
prop namesProps A to Z
propsDataGrid props
push deletePush into a server-ordered view
query planQuery layer
query stringURL state
quick startRender your first grid
range stackSelection model
rate limitRecover from load errors
ratingDisplay override
react queryFetch with a cache
react to data changesPlugin events
read only columnEditable columns
read-only gridEditable columns
realtimePush live values
rearrange rowsRow order
rebind keysShortcut remapping
record sourcesUndo and redo options
refetch rowsRefresh server rows
refreshRefresh server rows
refused saveHandle refused saves
release notesVersion policy and changelog
reload rowsRefresh server rows
remap shortcutsShortcut remapping
remember column layoutRemember filters and layout
remember column orderSave a column layout
remember viewSaved views
remembered checksChecked rows
remote cursorsPresence options
remove rowsRow operations
removed in 2.02.0 breaking changes
renamed in 2.02.0 breaking changes
rendercellDisplay override
reorder rowsRow order
replace a tableAdopt the grid in an existing table
replace allFind and replace options
replace in cellsFind and replace options
report a bug privatelySecurity policy
report an issueVersion policy and changelog
request specServer rows options
required fieldValidation
reshapePush into a server-ordered view
resize columnsColumn sizing
responsiveDensity and small screens
restore viewRemember filters and layout
restyle the gridStyling model
retry failed fetchRecover from load errors
revalidateIntervalMsTune page loading
revert editUndo and redo
review commentsAdd comments to cells
right alignStyle overrides
right click menuContext menu
right to leftLabels and i18n
right-click menuContext menu options
roll backRevert or refetch after a save
rollbackRevert or refetch after a save
rounded cornersColors and radius
row buttonsRow actions example
row ceilingRow limits
row checkboxesRow markers
row colorStyle overrides
row formEdit rows in forms
row groupRow grouping
row headerRow markers
row heightDensity and small screens
row idDataGrid props
row indexState and view index
row markers modeLayout and display types
row not deletedHandle row action results
row numberRow markers
row numbersRow markers
row positionState and view index
row scopeQuery layer
row selectorRow markers
RowActionResultHandle row action results
rows per pageClient pagination
rtlLabels and i18n
rtl gridRight-to-left example
save changesSave edits
save column layoutColumn and viewport events
save column widthsSave a column layout
save new rowChange server rows
save statusSave edits
save to databaseSave edits
saved viewSaved views
saveRejectedLive region messages
schemaValidation
scroll eventColumn and viewport events
scroll to cellStore hooks
scroll to rowStore hooks
search all columnsQuick search
search and replaceFind and replace
search boxQuick search
search propsToolbar options
searchtextQuery server rows
select a rangePointer selection
select all pagesSelect server rows
select cellBuilt-in cell types
select every rowSelect server rows
select rowsChecked rows
selected rowsChecked rows
selection callbackSelection and cell events
selection follows rowsSelection model
selection statsStatus bar
selection sumStatus bar options
selection summaryStatus bar
selection totalStatus bar
selector hooksStore hooks
self-host registryFix install problems
semverVersion policy and changelog
send selectionBroadcast your selection
series descriptorFill handle options
server aggregatesShow totals from a server
server componentsRender the grid on the server
server contractServer rows contract
server errorShow errors on cells
server filterQuery server rows
server grid problemTroubleshoot server data
server group byGroup server rows
server groupingGroup server rows
server htmlRender the grid on the server
server optionsLookup cell
server paginationLoad rows by page
server refreshRefresh server rows
server row operationsChange server rows
server rowsServer rows contract
server rows not loadingTroubleshoot server data
server rows optionsServer rows options
server searchQuery server rows
server selectionSelect server rows
server side paginationLoad rows by page
server side sortingQuery server rows
server sortQuery server rows
server totalsShow totals from a server
shadcnInstall gridcn
share a linkURL state options
share selectionBroadcast your selection
share viewURL state
shortcut does nothingHandle row action results
shortcut listKeyboard shortcuts
shortcuts dialogShortcut remapping
shortcuts outside the gridGlobal shortcuts
show columnsColumn visibility
since versionFeature matrix
skeletonLoading state
skip reasonRead a push verdict
skipped patchesRead a push verdict
slow gridPerformance guidance
slow scrollingPerformance guidance
sort by columnSorting
sort by defaultSorting
sort listSorting
sort popoverSort list options
sortmodeQuery server rows
speedBenchmark results
spreadsheet filter listHeader filter
spreadsheet pasteClipboard
sql injectionQuery layer
ssrRender the grid on the server
stale indexState and view index
stale rowPush into a server-ordered view
star ratingDisplay override
state hooksStore hooks
sticky columnsColumn order and pinning
sticky headerColumn headers and groups
sticky rowsPinned rows
store actionsActions A to Z
stutterPerformance guidance
sum of selected cellsStatus bar
summary rowPinned rows
supported browsersBrowser and framework support
switch to server dataMove from client rows to server rows
swrFetch with a cache
sync gridsLink multiple grids
system requirementsBrowser and framework support
tab keyKeyboard navigation
tab orderKeyboard test coverage
tagsBuilt-in cell types
tailwindInstall gridcn
tanstack queryFetch with a cache
tap to selectPointer selection
tdataTypeScript generics
tenantQuery layer
test matrixKeyboard test coverage
test the gridTest a grid in your app
testing libraryTest a grid in your app
text alignStyle overrides
themeColors and radius
theme the gridStyling model
theme tokensStyle contract
throttle valueuseDebounce
tick rowsChecked rows
time of dayBuilt-in cell types
time pickerBuilt-in cell types
toolbar slotsToolbar
tooltip providerFix install problems
totals bandPinned rows options
totals band serverShow totals from a server
totals rowPinned rows
totals row optionsPinned rows options
toText fromTextCell type model
translateLabels and i18n
translate labelsRight-to-left example
translate the uiLabels and i18n
translationLabels and i18n
translation keysLabels
tree dataFeature matrix
tree shakingBundle size
trim menu itemsContext menu items example
tsvClipboard
two peopleHandle refused saves
type argumentsTypeScript generics
type definitionsExported types
typescript typesExported types
ui textLabels
undoUndo and redo
undo apiUndo for code changes
undo capacityUndo and redo options
undo from toolbarGlobal shortcuts
undo saveUndo with server data
undo scroll modeUndo with server data
unique value checkRow validation and async checks
unit testTest a grid in your app
unknown registryFix install problems
unknown totalLoad without row count
unsaved rowsStyle overrides
update versionUpgrade gridcn
updateCells resultRead a push verdict
UpdateCellsVerdictRead a push verdict
upgrade to 2.0Migrate to 2.0
upload exportShape the export file
use data grid hooksStore hooks
useDataGridActionsActions A to Z
usedatagridclipboardClipboard
usedatagridserverrowsServer rows options
useDataGridViewsSaved views options
usestateKeep edits in state
validate cellValidation
validate emailValidation
validate rowRow validation and async checks
validaterowRow validation and async checks
validation errorEdit and validation events
validation from serverShow errors on cells
veto a pasteChange copy and paste
veto editEdit and validation events
view coordExported types
view importSaved views
view storageSaved views options
ViewCoordState and view index
viewsSaved views
views optionsSaved views options
viewStalePush into a server-ordered view
virtual scrollVirtualization
viteInstall gridcn
vitestTest a grid in your app
wait for typinguseDebounce
warningMessage index
wcag auditAccessibility gaps
websocketPush live values
which callbackEvent shapes
who is onlineShow presence
window keydownGlobal shortcuts
write a pluginWrite a plugin
wrong page countTroubleshoot server data
xlsx downloadExport
xlsx exportExport
xlsx importImport
xlsx optionsExport options
zip bombImport options
zodValidation
zod refineRow validation and async checks

On this page