gridcn2.0.0
Cheatsheets and messages

Options A to Z

Find the add-on option you need by name, see which hook or component takes it, and open its reference page.

The first table has one row for each option. The Purpose column gives the first sentence of the option documentation. The Used by column names the hook, component, or function that takes it. Each row links to the reference page of that add-on. The second table set groups the options by add-on.

By name

OptionPurposeUsed byPage
acceptFile types the drop zone accepts. Default csv, tsv, xls, and xlsx.DataGridImportButton, DataGridImportDialogImport options
aggregatesWhich aggregates to show, and in which order.DataGridStatusBarStatus bar options
allColumnsOffer every column when adding or changing a sort in place of only the visible columns. Default false.DataGridSortList, DataGridFilterMenuSort list options
allowWhenReadOnlyLet comment writes through on a readOnly grid.useDataGridCommentsComments options
blockSizeRows per request.useDataGridServerRows (scroll mode)Server rows options
bottomRowsRows pinned in a sticky band at the viewport's bottom edge. See UseDataGridPinnedRowsOptions.topRows.useDataGridPinnedRowsPinned rows options
canCreateGate for creating a comment.useDataGridCommentsComments options
canDeleteGate for deleting.useDataGridCommentsComments options
canEditGate for editing.useDataGridCommentsComments options
canResolveGate for resolving and reopening. ctx.action tells them apart.useDataGridCommentsComments options
capacitySets the most entries that the undo stack keeps. The oldest entries drop first. Default 100.useDataGridHistoryUndo and redo options
capacitySets the most entries that the undo stack keeps. The oldest entries drop first. Default 100.useDataGridStateUndo and redo options
cellsFixed cell values by column id, such as the row id and a label.aggregateRowPinned rows options
cellsFixed cell values by column id, such as the row id and a label.serverAggregateRowPinned rows options
cellTypesCustom cell types that parse the imported text, keyed by ColumnDef.type.buildImportedRowsImport options
checkImportChecks the built rows on your server before onImport runs.DataGridImportButton, DataGridImportDialogImport options
childrenHolds the grid that the menu wraps.DataGridContextMenuContext menu options
childrenCustom composition of parts. Omit to render the default layout.DataGridPaginationBarClient pagination options
childrenExtra items, rendered after the aggregates.DataGridStatusBarStatus bar options
childrenRenders the toolbar controls inside the bar.DataGridToolbarToolbar options
classNameAdds a class name to the trigger button.DataGridColumnsMenuToolbar options
classNameAdds a class name to the element that wraps the grid and opens the menu.DataGridContextMenuContext menu options
classNameAdds a class name to the button.DataGridExportButtonExport options
classNameAdds a class name to the trigger button.DataGridFilterMenuToolbar options
classNameMerged into the classes of the menu content.DataGridHeaderDropdownContext menu options
classNameMerged into the class list of the trigger button.DataGridHeaderFilterToolbar options
classNameAdds a class name to the import button.DataGridImportButtonImport options
classNameMerges into the dialog content, which is max-h-[80vh] and sm:max-w-2xl by default.DataGridImportDialogImport options
classNameMerged into the root of the dialog.DataGridKeybindingsDialogShortcut remapping options
classNameAdds a class name to the bar.DataGridPaginationBarClient pagination options
classNameAdds a class name to the print button.DataGridPrintButtonExport options
classNameAdds a class name to the search box wrapper.DataGridSearchToolbar options
classNameAdds a class name to the sort list.DataGridSortListSort list options
classNameAdds a class name to the bar.DataGridStatusBarStatus bar options
classNameAdds a class name to the toolbar bar.DataGridToolbarToolbar options
classNameAdds a class name to the views menu.DataGridViewsSaved views options
classNameClass of the popover root, merged with cn.useDataGridCommentsComments options
classNameMerged into the class list of the panel root.useDataGridFindReplaceFind and replace options
columnThe header's column. The items act on it.DataGridHeaderDropdownContext menu options
columnThe header's column. The popover lists its distinct values, or the fetchFilterValues answer.DataGridHeaderFilterToolbar options
columnFallbackBuilds the header shown for column N when the file has no header row.useDataGridImportPreviewImport options
columnIdsColumns to ask for.serverAggregateRowPinned rows options
columnIdsColumns to ask for.useDataGridServerAggregate, DataGridServerAggregateReporterPinned rows options
columnsThe grid columns that receive the imported values.buildImportedRowsImport options
columnsLists the ids of the columns to export, in order. Default: the visible columns.exportGridExport options
commentsControlled confirmed comments.useDataGridCommentsComments options
createIdDefault: crypto.randomUUID with a fallback outside secure contexts.useDataGridCommentsComments options
createRowBuilds a fresh row for import row index. Required, the dialog never writes to the grid store directly.buildImportedRowsImport options
createRowBuilds a fresh row for import row index. Required.DataGridImportButton, DataGridImportDialogImport options
cssExtra CSS appended after the built-in rules, in a second <style> node.printGridExport options
csvBomPrefix the CSV with a UTF-8 BOM (\uFEFF). Default true.exportGridExport options
csvDelimiterCSV field delimiter. Default ','.exportGridExport options
csvDelimiterOverrides CSV delimiter auto-detection. Ignored for xlsx/xls.parseImportFileImport options
csvEncodingDecodes a CSV file with this TextDecoder label in place of UTF-8.DataGridImportButton, DataGridImportDialogImport options
csvEncodingDecodes a CSV file with this label in place of UTF-8.parseImportFileImport options
csvEncodingDecodes a CSV file with this TextDecoder label in place of UTF-8. See IMPORT_CSV_ENCODINGS for the accepted labels.useDataGridImportPreviewImport options
currentUserThe user who writes.useDataGridCommentsComments options
dataLists the items to page.useDataGridPaginationClient pagination options
dataRowsData rows only.buildImportedRowsImport options
datasetKeyIdentifies the result that the history belongs to. A change between renders clears both stacks, so undo cannot reinsert rows of the old result.useDataGridHistoryUndo and redo options
datasetKeyIdentifies the result that the history belongs to. A change between renders clears both stacks, so undo cannot reinsert rows of the old result.useDataGridStateUndo and redo options
debounceMsDebounce between typing and the store's searchText update.DataGridSearchToolbar options
debounceMsWait in ms before each request starts: on mount, after a filter, quick-search, or columnIds change, and after refresh() and retry().serverAggregateRowPinned rows options
debounceMsWait in ms before each request starts: on mount, after a filter, quick-search, or columnIds change, and after refresh() and retry().useDataGridServerAggregate, DataGridServerAggregateReporterPinned rows options
debounceMsSets the wait in ms after the last keystroke before a request starts. Default: the inputDebounceMs of the grid.lookup cell typeLookup options
defaultCommentsOne-shot seed.useDataGridCommentsComments options
defaultOpenSets the first open state when open is not set.DataGridKeybindingsDialogShortcut remapping options
defaultPageFirst page while page is not controlled.useDataGridPaginationClient pagination options
defaultPageFirst page while page is not controlled.useDataGridServerRows (pages mode)Server rows options
defaultPageSizeFirst page size while pageSize is not controlled.useDataGridPaginationClient pagination options
defaultPageSizeRows per page while pageSize is not controlled.useDataGridServerRows (pages mode)Server rows options
defaultPageSizeOmits pageSize from the URL when it equals this value.useDataGridUrlPaginationURL state options
defaultsPreselection defaults.useDataGridImportPreviewImport options
defaultSpecThe sort, filter, and search while spec is not controlled.useDataGridServerRowsServer rows options
defaultValueFirst active view id when value is not set.useDataGridViews, DataGridViewsSaved views options
detectSeriesReplaces the built-in series detector.useDataGridFillFill handle options
directionReading direction of the printed page.printGridExport options
disabledTurns the fill feature off. The handle hides and fillDown and fillRight do nothing. Default false.useDataGridFillFill handle options
enableDefaultViewOpen the default view after load when the grid still holds its start state and value and defaultValue are unset.useDataGridViews, DataGridViewsSaved views options
enableDeleteShows delete.useDataGridCommentsComments options
enableEditShows edit.useDataGridCommentsComments options
enableNavigationSyncApplies the URL to the grid when the user navigates back or forward (popstate), as applyFromUrl() does.DataGridUrlState, useDataGridUrlStateURL state options
enableResolveShows resolve and reopen.useDataGridCommentsComments options
existingRowsThe rows the import joins.buildImportedRowsImport options
fetchAggregatesResolves { [columnId]: value } for the whole result of spec, not for the rows the grid holds.serverAggregateRowPinned rows options
fetchAggregatesResolves { [columnId]: value } for the whole result of spec, not for the rows the grid holds.useDataGridServerAggregate, DataGridServerAggregateReporterPinned rows options
fetchCommentsLoads the comments of the rendered rows.useDataGridCommentsComments options
fetchOptionsResolves the options that match the typed query.lookup cell typeLookup options
fetchRowsResolves the rows of the requested range or page.useDataGridServerRowsServer rows options
fileA file to load when the dialog opens, as if the user had chosen it.DataGridImportButton, DataGridImportDialogImport options
fileNameDownload file name, without extension. Default 'export'.exportGridExport options
findScopeSets whether Next and Previous step through the loaded rows or the whole server result.useDataGridFindReplaceFind and replace options
format'xlsx' via lazily-imported hucre, or hand-rolled RFC4180 'csv'.exportGridExport options
formatCellReplaces the value of each exported cell after its cell type made the text.exportGridExport options
formatsThe formats the button offers. One format exports on click, several open a menu.DataGridExportButtonExport options
formatValueFormats the shown aggregate values.DataGridStatusBarStatus bar options
getCellMenuItemsReturns the complete item list of the cell menu. It receives the built-in items as defaults.DataGridContextMenuContext menu options
getHeaderMenuItemsResolves the header-surface item set.DataGridContextMenuContext menu options
getHeaderMenuItemsResolves this dropdown's item set the same way DataGridContextMenu's getHeaderMenuItems does.DataGridHeaderDropdownContext menu options
getRowIdThe id validateRow receives for built row index.buildImportedRowsImport options
getRowIdIdentifies a row.useDataGridServerRowsServer rows options
getRowIdRow identity. Defaults to the row's id field, like DataGrid's getRowId.useDataGridStateUndo and redo options
hasMoreTrue when a page after the current one exists.useDataGridServerPagerClient pagination options
headersReplaces the header text of the named columns.exportGridExport options
headersHeader text per column id, replacing the column's label.printGridExport options
hideResolvedHide the markers of resolved-only cells.useDataGridCommentsComments options
importDefaultsConsumer-configurable preselection defaults.DataGridImportButton, DataGridImportDialogImport options
importLimitsSize, row, column, cell, and unpacked-size bounds for the file. Omitted fields use DEFAULT_IMPORT_LIMITS.DataGridImportButton, DataGridImportDialogImport options
includeHeadersWhether to emit a header row. Default true.exportGridExport options
includeHeadersEmit a <thead> header row. Default true.printGridExport options
indexThe column's visible-column index.DataGridHeaderDropdownContext menu options
indexThe column's visible-column index.DataGridHeaderFilterToolbar options
initialAnswerThe answer for the first state (defaultSpec, defaultPage, the first page size), for example from a Server Component.useDataGridServerRowsServer rows options
labelsi18n override for this footer's strings, merged key by key over the enclosing grid's labels.pagination (the built-in defaults outside a DataGridProvider).DataGridPaginationBarClient pagination options
labelsi18n overrides for this bar's strings, merged over labels.statusBar.DataGridStatusBarStatus bar options
labelsOverrides for the menu's strings, merged key by key over the grid's labels.views, which sit over the built-in English defaults.DataGridViewsSaved views options
labelsOverrides the strings of the comments UI.useDataGridCommentsComments options
labelsOverrides the text of the editor.lookup cell typeLookup options
layoutLayout parts synced to the URL under cols (order), hide (hidden), widths, and pins.DataGridUrlState, useDataGridUrlStateURL state options
limitsSize, row, column, cell, and unpacked-size bounds for every parse. Omitted fields use DEFAULT_IMPORT_LIMITS.useDataGridImportPreviewImport options
loadDelayMsMilliseconds a block stays in the wanted range before its request starts.useDataGridServerRows (scroll mode)Server rows options
mappingLists one entry for each file column: the grid column id, or null to skip the file column.buildImportedRowsImport options
matchCaseMakes the match case-sensitive.planReplaceFind and replace options
maxBytesWith source: stop after the slice of rows that passes this many bytes of file text. Default 256 MiB.exportGridExport options
maxCachedRowsUncontrolled fetch cache bound in rows.useDataGridCommentsComments options
maxCommentsDefault 50,000. Ceiling 500,000.useDataGridCommentsComments options
maxCommentsPerCellDefault 50. Ceiling 500.useDataGridCommentsComments options
maxConcurrentFetchesMost block requests in flight at once on a random access source.useDataGridServerRows (scroll mode)Server rows options
maxLoadedRowsMost rows kept loaded on a random access source.useDataGridServerRows (scroll mode)Server rows options
maxRectsSets the most rectangles that one range entry paints.useDataGridPresencePresence options
maxResultsSets the most options that the editor shows. Default 50.lookup cell typeLookup options
maxRowsCaps the number of data rows that the export writes. A larger scope truncates the export and warns in development.exportGridExport options
maxRowsCap on the rows printed. Default 10,000, further cut by the 500,000-cell ceiling.printGridExport options
maxTextLengthDefault 2,000. Ceiling 20,000.useDataGridCommentsComments options
minQueryLengthSets the fewest typed characters that start a request. Default 0.lookup cell typeLookup options
mode"pages" fetches one page per state and drives pager.useDataGridServerRowsServer rows options
normalizeTextApplied to local text before the bounds are checked.useDataGridCommentsComments options
onChangeCalled with the aggregated row whenever it changes, feed it into a useState that becomes a pinned band's topRows/bottomRows entry.DataGridAggregateReporterPinned rows options
onChangeCalled with the aggregated row whenever it changes, feed it into a useState that becomes a pinned band's topRows/bottomRows entry.DataGridServerAggregateReporterPinned rows options
onCommentRejectedCalled once per refused or reverted write.useDataGridCommentsComments options
onCommentSaveSaves one write.useDataGridCommentsComments options
onCommentsChangeState channel: one call per store write, next holds confirmed records only.useDataGridCommentsComments options
onDataChangeFires after the hook keeps an edit, insert, delete, or revert.useDataGridServerRowsServer rows options
onErrorReceives the rejection when an export fails. Without it, the failure logs a dev-only warning.DataGridExportButtonExport options
onErrorCalled once per failed request.serverAggregateRowPinned rows options
onErrorCalled once per failed request.useDataGridServerAggregate, DataGridServerAggregateReporterPinned rows options
onErrorFires after a request fails.useDataGridServerRowsServer rows options
onErrorCalled with a load or save failure.useDataGridViews, DataGridViewsSaved views options
onExcessRectsFires when a range highlight has more rectangles than the cap, with the number kept and the total.useDataGridPresencePresence options
onFetchErrorCalled for a failed fetch request or for records dropped for a bound.useDataGridCommentsComments options
onImportCalled with the fully-built rows on confirm. The consumer decides how to merge.DataGridImportButton, DataGridImportDialogImport options
onImportErrorCalled once when onImport rejects, with the rejection.DataGridImportButton, DataGridImportDialogImport options
onLoadedFires after the rows of a request land, with the range they cover.useDataGridServerRowsServer rows options
onLocalChangeBroadcast seam: fires once per confirmed local write.useDataGridCommentsComments options
onlyLimits the plan to one cell.planReplaceFind and replace options
onOpenChangeFires with the new open state when the dialog opens or closes.DataGridImportDialogImport options
onOpenChangeFires with the new open state after the dialog opens or closes.DataGridKeybindingsDialogShortcut remapping options
onOrphanedCommentsCalled when rows with comments are deleted.useDataGridCommentsComments options
onPageChangeFires with the new page after a page change.useDataGridPaginationClient pagination options
onPageChangeFires with the new page after a page change.useDataGridServerPagerClient pagination options
onPageChangeFires with the new page after a page change. Pair it with page.useDataGridServerRows (pages mode)Server rows options
onPageSizeChangeFires after a page-size change with the new size.useDataGridPaginationClient pagination options
onPageSizeChangeFires after a page-size change with the new size.useDataGridServerPagerClient pagination options
onPageSizeChangeFires with the new page size after a change. Pair it with pageSize.useDataGridServerRows (pages mode)Server rows options
onProgressWith source: called after each batch with the running totals.exportGridExport options
onRenderedRowsChange@internal Present while the source groups: reports the rendered rows so the open groups load their rows.useDataGridServerRows (scroll mode)Server rows options
onSaveSaves a change. Spread to the provider through gridProps.onSave, where it behaves as the DataGridProvider prop of the same name.useDataGridServerRowsServer rows options
onSkipCalled when undo or redo finds a row its change needs missing from data, and applies nothing.useDataGridHistoryUndo and redo options
onSpecChangeFires with the new spec after a sort, filter, or search change. Pair it with spec.useDataGridServerRowsServer rows options
onValueChangeFires with the id of the view that the user picks, or null for no view.useDataGridViews, DataGridViewsSaved views options
openShows the dialog when true.DataGridImportDialogImport options
openControlled open state. Omit for uncontrolled state.DataGridKeybindingsDialogShortcut remapping options
optionsOptions of useDataGridAggregate, such as scope.DataGridAggregateReporterPinned rows options
optionsExport options applied to both formats besides format itself, including columns, formatCell, and output. Default { scope: 'view', includeHeaders: true }.DataGridExportButtonExport options
optionsPrint options applied to the pass. Default { scope: "view", includeHeaders: true }.DataGridPrintButtonExport options
orientationPage orientation. Default: landscape above 6 visible columns, else portrait.printGridExport options
outputReceives the finished file in place of the browser download.exportGridExport options
overscanRows fetched beyond the rendered rows on each side.useDataGridServerRows (scroll mode)Server rows options
pageControls the current page. Pair it with onPageChange.useDataGridPaginationClient pagination options
pageControls the current page. Pair it with onPageChange.useDataGridServerPagerClient pagination options
pageControls the current page. Pair it with onPageChange.useDataGridServerRows (pages mode)Server rows options
pageSizeControls the page size. Pair it with onPageSizeChange.useDataGridPaginationClient pagination options
pageSizeControls the page size. Pair it with onPageSizeChange.useDataGridServerPagerClient pagination options
pageSizeControls the page size. Pair it with onPageSizeChange.useDataGridServerRows (pages mode)Server rows options
pageSizeOptionsPage sizes the select offers.DataGridPaginationBarClient pagination options
pageSizeOptionsPage sizes the select offers.useDataGridPagerClient pagination options
pageSizeOptionsPage sizes the select offers.useDataGridPaginationClient pagination options
pageSizeOptionsPage sizes the select offers.useDataGridServerPagerClient pagination options
pageSizeOptionsPage sizes the footer offers.useDataGridServerRows (pages mode)Server rows options
pageSizeOptionsA pageSize URL value outside this list falls back to defaultPageSize.useDataGridUrlPaginationURL state options
paperSizePaper size of the printed page. Default "A4".printGridExport options
parseFileReads the file in place of the built-in parser.DataGridImportButton, DataGridImportDialogImport options
parseFileReads the file in place of the built-in parser, for every parse.useDataGridImportPreviewImport options
placeholderSets the placeholder text of the search box.DataGridSearchToolbar options
pluginsPlugins the hook mounts after its refresh guard, through gridProps.plugins.useDataGridServerRowsServer rows options
pluginsPlugins the hook mounts after its refresh guard, through gridProps.plugins.useDataGridServerRows (scroll mode)Server rows options
pluginsOther plugins of the grid.useDataGridStateUndo and redo options
prefetchNextPageFetches the page after the current one in the background once the current page has landed.useDataGridServerRows (pages mode)Server rows options
prefixNamespaces the sort/group/filter/join/q URL keys and the layout keys (cols, hide, widths, pins) as <prefix>_<key>, so multiple grids can coexist on one page.DataGridUrlState, useDataGridUrlStateURL state options
prefixNamespaces the page/pageSize URL keys as <prefix>_<key>, so multiple grids can coexist on one page.useDataGridUrlPaginationURL state options
processCellFromTextParses one cell in place of cellType.fromText. Can return a promise, which makes the build asynchronous.buildImportedRowsImport options
processCellFromTextParses one cell in place of the column's fromText.DataGridImportButton, DataGridImportDialogImport options
processFillRuns before a fill writes. Return the text grid to write, or false to cancel the fill.useDataGridFillFill handle options
processImportRowsRewrites or drops the data rows before the grid maps them.DataGridImportButton, DataGridImportDialogImport options
processReplaceRuns after the plan exists and before the grid writes it.useDataGridFindReplaceFind and replace options
readOnlyBlocks every comment write and hides the composer and the actions.useDataGridCommentsComments options
recordSourcesWhich DataChange.source values go on the undo stack.useDataGridHistoryUndo and redo options
refreshAfterSaveThe false | "settled" subset of the server hooks' refreshAfterSave policy.serverAggregateRowPinned rows options
refreshAfterSaveThe false | "settled" subset of the server hooks' refreshAfterSave policy.useDataGridServerAggregate, DataGridServerAggregateReporterPinned rows options
refreshAfterSaveSets when the hook calls refresh() after a save settles: "settled", "each", false, or a function. Default "settled".useDataGridServerRowsServer rows options
replaceAllLimitMost cells one plan targets. Default 10,000, clamped to 1..100,000.planReplaceFind and replace options
replaceAllLimitMost cells one plan targets. Default 10,000, clamped to 1..100,000.useDataGridFindReplaceFind and replace options
reshapeDelayMsMilliseconds to wait after a push marked a row stale before the hook runs a refresh() so the server places the rows again.useDataGridServerRowsServer rows options
revalidateIntervalMsMilliseconds between refresh() calls the hook runs itself while the page is visible.useDataGridServerRowsServer rows options
sanitizeFormulasPrefix formula-like CSV cells (leading =, +, -, @, TAB, or CR. Plain numbers exempt) with a single quote so Excel/LibreOffice/Sheets read them as text in place of executing them. Default true.exportGridExport options
scope"view" reduces over every row the sort and filter leave, all pages of a paged grid.aggregateRowPinned rows options
scopeSets which rows to export: "view", "page", "all", or "selection". Default "view".exportGridExport options
scope"view" covers every visible column of the rows the sort and filter leave, every page of a paged grid. "selection" covers the selected cells.planReplaceFind and replace options
scopeSets which rows to print: "view", "page", "all", or "selection". Default "view".printGridExport options
scope"view" reduces over every row the sort and filter leave, all pages of a paged grid.useDataGridAggregatePinned rows options
scope"view" covers every visible column of the rows the sort and filter leave, every page of a paged grid. "selection" covers the selected cells.useDataGridFindReplaceFind and replace options
setFilterOperatorOperator of the set entry the popover writes.DataGridHeaderFilterToolbar options
sheetNameName of the single sheet inside the xlsx file. Default 'Sheet1'.exportGridExport options
sheetNameFor xlsx/xls: import this sheet by name in place of the first. Rejects when the workbook has no sheet by that name.parseImportFileImport options
signalChecked between chunks on the chunked path (above IMPORT_CHUNK_THRESHOLD_ROWS rows, or with processCellFromText) and after an async createRow. An aborted signal throws "import-cancelled".buildImportedRowsImport options
signalCancels the export.exportGridExport options
signalAborts the file read. An aborted parse rejects with an AbortError.parseImportFileImport options
signalCancels the print: the promise rejects with the signal's reason and no dialog opens.printGridExport options
skipLeaves out the cells it returns true for. A continuation passes the cells an earlier plan replaced.planReplaceFind and replace options
sourceWhere the rows of the whole result come from, for a grid that holds one page or some loaded blocks.exportGridExport options
sourceWhere the rows come from, for a grid that holds one page or some loaded blocks.printGridExport options
sourceSets how the hook fetches rows: "random" by block position, or "sequential" in order.useDataGridServerRows (scroll mode)Server rows options
specView-spec parts synced to the URL: sort (sort), group (group: the groupBy columns. Expanded groups stay out), filter (filter and the top-level join), and search (q).DataGridUrlState, useDataGridUrlStateURL state options
specControls the sort, filter, and search. Pair it with onSpecChange.useDataGridServerRowsServer rows options
specsThe aggregate to compute for each column.DataGridAggregateReporterPinned rows options
statusDims both bands while the server values load, go stale, or fail.useDataGridPinnedRowsPinned rows options
storageWhere views persist.useDataGridViews, DataGridViewsSaved views options
titlePrinted as an <h1> heading and the document title.printGridExport options
topRowsRows pinned in a sticky band directly under the header, a SEPARATE array from data, not indices into it.useDataGridPinnedRowsPinned rows options
totalRowCountRow count across all pages. null when the server sends no count.useDataGridServerPagerClient pagination options
triggerThe core's own ghost-chevron trigger element (styling/aria-label owned by header-cell.tsx).DataGridHeaderDropdownContext menu options
triggerRendered as the dialog's trigger (e.g. a <Button>). Omit to drive open externally only.DataGridKeybindingsDialogShortcut remapping options
unresolvedPasteSets what happens to a pasted text that matches no known option: "reject", "clear", or "keep". Default "reject".lookup cell typeLookup options
validateRowRuns once per built row after the build parses its cells, like the grid's validateRow.buildImportedRowsImport options
valueId of the active view.useDataGridViews, DataGridViewsSaved views options
valueModeFor xlsx/xls: "formatted" renders each cell through its number format. "raw" reads the stored value: a number as String(n), a date as ISO 8601, a boolean as true or false, an error cell as empty.parseImportFileImport options
wholeCellMatches only a cell whose whole text equals the search text.planReplaceFind and replace options
windowSizeHow many numbered page buttons the default layout shows at once (forwarded to DataGridPaginationPages. Ignored with children).DataGridPaginationBarClient pagination options
xlsxWriterHow XLSX is written. Default "buffered".exportGridExport options

By add-on

Options of the sort, filter, search, saved views, and URL add-ons.

OptionsUsed byPage
allColumnsDataGridSortList, DataGridFilterMenuSort list options
debounceMs, placeholder, classNameDataGridSearchToolbar options
classNameDataGridFilterMenuToolbar options
className, childrenDataGridToolbarToolbar options
classNameDataGridColumnsMenuToolbar options
classNameDataGridSortListSort list options
column, index, className, setFilterOperatorDataGridHeaderFilterToolbar options
scope, replaceAllLimit, processReplace, findScope, classNameuseDataGridFindReplaceFind and replace options
matchCase, wholeCell, only, skip, scope, replaceAllLimitplanReplaceFind and replace options
storage, value, defaultValue, onValueChange, enableDefaultView, onErroruseDataGridViews, DataGridViewsSaved views options
className, labelsDataGridViewsSaved views options
prefix, spec, layout, enableNavigationSyncDataGridUrlState, useDataGridUrlStateURL state options
prefix, defaultPageSize, pageSizeOptionsuseDataGridUrlPaginationURL state options

Clipboard and undo

Options of the fill handle and the history add-ons.

OptionsUsed byPage
disabled, processFill, detectSeriesuseDataGridFillFill handle options
getRowId, capacity, datasetKey, pluginsuseDataGridStateUndo and redo options
capacity, datasetKey, recordSources, onSkipuseDataGridHistoryUndo and redo options

Editing cells

Options of the lookup cell type. A lookup column takes them in its options field.

OptionsUsed byPage
fetchOptions, debounceMs, minQueryLength, maxResults, unresolvedPaste, labelslookup cell typeLookup options

Import, export, and print

Options of the file add-ons.

OptionsUsed byPage
formats, options, onError, classNameDataGridExportButtonExport options
format, scope, includeHeaders, csvDelimiter, csvBom, sanitizeFormulas, fileName, sheetName, maxRows, xlsxWriterexportGridExport options
columns, formatCell, output, headersexportGridExport options
source, maxBytes, signal, onProgressexportGridExport options
scope, title, includeHeaders, orientation, maxRows, paperSize, direction, source, headers, css, signalprintGridExport options
options, classNameDataGridPrintButtonExport options
classNameDataGridImportButtonImport options
open, onOpenChange, classNameDataGridImportDialogImport options
csvDelimiter, sheetName, csvEncoding, signal, valueModeparseImportFileImport options
dataRows, mapping, columns, cellTypes, createRow, processCellFromText, signal, existingRows, validateRow, getRowIdbuildImportedRowsImport options
createRow, onImport, importDefaults, importLimitsDataGridImportButton, DataGridImportDialogImport options
onImportError, parseFile, accept, csvEncoding, processImportRows, processCellFromText, file, checkImportDataGridImportButton, DataGridImportDialogImport options
columnFallback, defaults, limits, parseFile, csvEncodinguseDataGridImportPreviewImport options

Rows, pages, and menus

Options of the pagination, pinned rows, and menu add-ons.

OptionsUsed byPage
data, defaultPageSize, pageSize, pageSizeOptions, defaultPage, page, onPageChange, onPageSizeChangeuseDataGridPaginationClient pagination options
page, pageSize, totalRowCount, hasMore, onPageChange, pageSizeOptions, onPageSizeChangeuseDataGridServerPagerClient pagination options
pageSizeOptionsuseDataGridPagerClient pagination options
className, labels, windowSize, children, pageSizeOptions, the fields of the pagerDataGridPaginationBarClient pagination options
column, index, trigger, getHeaderMenuItems, classNameDataGridHeaderDropdownContext menu options
getCellMenuItems, getHeaderMenuItems, className, childrenDataGridContextMenuContext menu options
topRows, bottomRows, statususeDataGridPinnedRowsPinned rows options
fetchAggregates, columnIds, debounceMs, refreshAfterSave, onErroruseDataGridServerAggregate, DataGridServerAggregateReporterPinned rows options
specs, options, onChangeDataGridAggregateReporterPinned rows options
onChangeDataGridServerAggregateReporterPinned rows options
scope, cellsaggregateRowPinned rows options
fetchAggregates, columnIds, debounceMs, onError, cells, refreshAfterSaveserverAggregateRowPinned rows options
scopeuseDataGridAggregatePinned rows options

Selection and shortcuts

Options of the status bar and the key dialog.

OptionsUsed byPage
aggregates, formatValue, labels, className, childrenDataGridStatusBarStatus bar options
open, onOpenChange, defaultOpen, trigger, classNameDataGridKeybindingsDialogShortcut remapping options

Server

Options of the server rows, presence, and comments add-ons.

OptionsUsed byPage
mode, getRowId, fetchRows, defaultSpec, spec, onSpecChange, onError, onLoaded, onDataChange, revalidateIntervalMs, reshapeDelayMs, plugins, initialAnsweruseDataGridServerRowsServer rows options
onSave, refreshAfterSaveuseDataGridServerRowsServer rows options
page, defaultPage, pageSize, defaultPageSize, pageSizeOptions, onPageChange, onPageSizeChange, prefetchNextPageuseDataGridServerRows (pages mode)Server rows options
source, blockSize, overscan, loadDelayMs, maxConcurrentFetches, maxLoadedRows, plugins, onRenderedRowsChangeuseDataGridServerRows (scroll mode)Server rows options
maxRects, onExcessRectsuseDataGridPresencePresence options
currentUser, comments, defaultComments, onCommentsChange, onCommentSave, onCommentRejected, onLocalChange, canCreate, canEdit, canDelete, canResolveuseDataGridCommentsComments options
fetchComments, onFetchError, onOrphanedComments, createId, normalizeText, maxTextLength, maxCommentsPerCell, maxComments, maxCachedRows, allowWhenReadOnly, readOnly, enableResolve, enableEdit, enableDelete, hideResolved, labels, classNameuseDataGridCommentsComments options

On this page