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
| Option | Purpose | Used by | Page |
|---|---|---|---|
accept | File types the drop zone accepts. Default csv, tsv, xls, and xlsx. | DataGridImportButton, DataGridImportDialog | Import options |
aggregates | Which aggregates to show, and in which order. | DataGridStatusBar | Status bar options |
allColumns | Offer every column when adding or changing a sort in place of only the visible columns. Default false. | DataGridSortList, DataGridFilterMenu | Sort list options |
allowWhenReadOnly | Let comment writes through on a readOnly grid. | useDataGridComments | Comments options |
blockSize | Rows per request. | useDataGridServerRows (scroll mode) | Server rows options |
bottomRows | Rows pinned in a sticky band at the viewport's bottom edge. See UseDataGridPinnedRowsOptions.topRows. | useDataGridPinnedRows | Pinned rows options |
canCreate | Gate for creating a comment. | useDataGridComments | Comments options |
canDelete | Gate for deleting. | useDataGridComments | Comments options |
canEdit | Gate for editing. | useDataGridComments | Comments options |
canResolve | Gate for resolving and reopening. ctx.action tells them apart. | useDataGridComments | Comments options |
capacity | Sets the most entries that the undo stack keeps. The oldest entries drop first. Default 100. | useDataGridHistory | Undo and redo options |
capacity | Sets the most entries that the undo stack keeps. The oldest entries drop first. Default 100. | useDataGridState | Undo and redo options |
cells | Fixed cell values by column id, such as the row id and a label. | aggregateRow | Pinned rows options |
cells | Fixed cell values by column id, such as the row id and a label. | serverAggregateRow | Pinned rows options |
cellTypes | Custom cell types that parse the imported text, keyed by ColumnDef.type. | buildImportedRows | Import options |
checkImport | Checks the built rows on your server before onImport runs. | DataGridImportButton, DataGridImportDialog | Import options |
children | Holds the grid that the menu wraps. | DataGridContextMenu | Context menu options |
children | Custom composition of parts. Omit to render the default layout. | DataGridPaginationBar | Client pagination options |
children | Extra items, rendered after the aggregates. | DataGridStatusBar | Status bar options |
children | Renders the toolbar controls inside the bar. | DataGridToolbar | Toolbar options |
className | Adds a class name to the trigger button. | DataGridColumnsMenu | Toolbar options |
className | Adds a class name to the element that wraps the grid and opens the menu. | DataGridContextMenu | Context menu options |
className | Adds a class name to the button. | DataGridExportButton | Export options |
className | Adds a class name to the trigger button. | DataGridFilterMenu | Toolbar options |
className | Merged into the classes of the menu content. | DataGridHeaderDropdown | Context menu options |
className | Merged into the class list of the trigger button. | DataGridHeaderFilter | Toolbar options |
className | Adds a class name to the import button. | DataGridImportButton | Import options |
className | Merges into the dialog content, which is max-h-[80vh] and sm:max-w-2xl by default. | DataGridImportDialog | Import options |
className | Merged into the root of the dialog. | DataGridKeybindingsDialog | Shortcut remapping options |
className | Adds a class name to the bar. | DataGridPaginationBar | Client pagination options |
className | Adds a class name to the print button. | DataGridPrintButton | Export options |
className | Adds a class name to the search box wrapper. | DataGridSearch | Toolbar options |
className | Adds a class name to the sort list. | DataGridSortList | Sort list options |
className | Adds a class name to the bar. | DataGridStatusBar | Status bar options |
className | Adds a class name to the toolbar bar. | DataGridToolbar | Toolbar options |
className | Adds a class name to the views menu. | DataGridViews | Saved views options |
className | Class of the popover root, merged with cn. | useDataGridComments | Comments options |
className | Merged into the class list of the panel root. | useDataGridFindReplace | Find and replace options |
column | The header's column. The items act on it. | DataGridHeaderDropdown | Context menu options |
column | The header's column. The popover lists its distinct values, or the fetchFilterValues answer. | DataGridHeaderFilter | Toolbar options |
columnFallback | Builds the header shown for column N when the file has no header row. | useDataGridImportPreview | Import options |
columnIds | Columns to ask for. | serverAggregateRow | Pinned rows options |
columnIds | Columns to ask for. | useDataGridServerAggregate, DataGridServerAggregateReporter | Pinned rows options |
columns | The grid columns that receive the imported values. | buildImportedRows | Import options |
columns | Lists the ids of the columns to export, in order. Default: the visible columns. | exportGrid | Export options |
comments | Controlled confirmed comments. | useDataGridComments | Comments options |
createId | Default: crypto.randomUUID with a fallback outside secure contexts. | useDataGridComments | Comments options |
createRow | Builds a fresh row for import row index. Required, the dialog never writes to the grid store directly. | buildImportedRows | Import options |
createRow | Builds a fresh row for import row index. Required. | DataGridImportButton, DataGridImportDialog | Import options |
css | Extra CSS appended after the built-in rules, in a second <style> node. | printGrid | Export options |
csvBom | Prefix the CSV with a UTF-8 BOM (\uFEFF). Default true. | exportGrid | Export options |
csvDelimiter | CSV field delimiter. Default ','. | exportGrid | Export options |
csvDelimiter | Overrides CSV delimiter auto-detection. Ignored for xlsx/xls. | parseImportFile | Import options |
csvEncoding | Decodes a CSV file with this TextDecoder label in place of UTF-8. | DataGridImportButton, DataGridImportDialog | Import options |
csvEncoding | Decodes a CSV file with this label in place of UTF-8. | parseImportFile | Import options |
csvEncoding | Decodes a CSV file with this TextDecoder label in place of UTF-8. See IMPORT_CSV_ENCODINGS for the accepted labels. | useDataGridImportPreview | Import options |
currentUser | The user who writes. | useDataGridComments | Comments options |
data | Lists the items to page. | useDataGridPagination | Client pagination options |
dataRows | Data rows only. | buildImportedRows | Import options |
datasetKey | Identifies the result that the history belongs to. A change between renders clears both stacks, so undo cannot reinsert rows of the old result. | useDataGridHistory | Undo and redo options |
datasetKey | Identifies the result that the history belongs to. A change between renders clears both stacks, so undo cannot reinsert rows of the old result. | useDataGridState | Undo and redo options |
debounceMs | Debounce between typing and the store's searchText update. | DataGridSearch | Toolbar options |
debounceMs | Wait in ms before each request starts: on mount, after a filter, quick-search, or columnIds change, and after refresh() and retry(). | serverAggregateRow | Pinned rows options |
debounceMs | Wait in ms before each request starts: on mount, after a filter, quick-search, or columnIds change, and after refresh() and retry(). | useDataGridServerAggregate, DataGridServerAggregateReporter | Pinned rows options |
debounceMs | Sets the wait in ms after the last keystroke before a request starts. Default: the inputDebounceMs of the grid. | lookup cell type | Lookup options |
defaultComments | One-shot seed. | useDataGridComments | Comments options |
defaultOpen | Sets the first open state when open is not set. | DataGridKeybindingsDialog | Shortcut remapping options |
defaultPage | First page while page is not controlled. | useDataGridPagination | Client pagination options |
defaultPage | First page while page is not controlled. | useDataGridServerRows (pages mode) | Server rows options |
defaultPageSize | First page size while pageSize is not controlled. | useDataGridPagination | Client pagination options |
defaultPageSize | Rows per page while pageSize is not controlled. | useDataGridServerRows (pages mode) | Server rows options |
defaultPageSize | Omits pageSize from the URL when it equals this value. | useDataGridUrlPagination | URL state options |
defaults | Preselection defaults. | useDataGridImportPreview | Import options |
defaultSpec | The sort, filter, and search while spec is not controlled. | useDataGridServerRows | Server rows options |
defaultValue | First active view id when value is not set. | useDataGridViews, DataGridViews | Saved views options |
detectSeries | Replaces the built-in series detector. | useDataGridFill | Fill handle options |
direction | Reading direction of the printed page. | printGrid | Export options |
disabled | Turns the fill feature off. The handle hides and fillDown and fillRight do nothing. Default false. | useDataGridFill | Fill handle options |
enableDefaultView | Open the default view after load when the grid still holds its start state and value and defaultValue are unset. | useDataGridViews, DataGridViews | Saved views options |
enableDelete | Shows delete. | useDataGridComments | Comments options |
enableEdit | Shows edit. | useDataGridComments | Comments options |
enableNavigationSync | Applies the URL to the grid when the user navigates back or forward (popstate), as applyFromUrl() does. | DataGridUrlState, useDataGridUrlState | URL state options |
enableResolve | Shows resolve and reopen. | useDataGridComments | Comments options |
existingRows | The rows the import joins. | buildImportedRows | Import options |
fetchAggregates | Resolves { [columnId]: value } for the whole result of spec, not for the rows the grid holds. | serverAggregateRow | Pinned rows options |
fetchAggregates | Resolves { [columnId]: value } for the whole result of spec, not for the rows the grid holds. | useDataGridServerAggregate, DataGridServerAggregateReporter | Pinned rows options |
fetchComments | Loads the comments of the rendered rows. | useDataGridComments | Comments options |
fetchOptions | Resolves the options that match the typed query. | lookup cell type | Lookup options |
fetchRows | Resolves the rows of the requested range or page. | useDataGridServerRows | Server rows options |
file | A file to load when the dialog opens, as if the user had chosen it. | DataGridImportButton, DataGridImportDialog | Import options |
fileName | Download file name, without extension. Default 'export'. | exportGrid | Export options |
findScope | Sets whether Next and Previous step through the loaded rows or the whole server result. | useDataGridFindReplace | Find and replace options |
format | 'xlsx' via lazily-imported hucre, or hand-rolled RFC4180 'csv'. | exportGrid | Export options |
formatCell | Replaces the value of each exported cell after its cell type made the text. | exportGrid | Export options |
formats | The formats the button offers. One format exports on click, several open a menu. | DataGridExportButton | Export options |
formatValue | Formats the shown aggregate values. | DataGridStatusBar | Status bar options |
getCellMenuItems | Returns the complete item list of the cell menu. It receives the built-in items as defaults. | DataGridContextMenu | Context menu options |
getHeaderMenuItems | Resolves the header-surface item set. | DataGridContextMenu | Context menu options |
getHeaderMenuItems | Resolves this dropdown's item set the same way DataGridContextMenu's getHeaderMenuItems does. | DataGridHeaderDropdown | Context menu options |
getRowId | The id validateRow receives for built row index. | buildImportedRows | Import options |
getRowId | Identifies a row. | useDataGridServerRows | Server rows options |
getRowId | Row identity. Defaults to the row's id field, like DataGrid's getRowId. | useDataGridState | Undo and redo options |
hasMore | True when a page after the current one exists. | useDataGridServerPager | Client pagination options |
headers | Replaces the header text of the named columns. | exportGrid | Export options |
headers | Header text per column id, replacing the column's label. | printGrid | Export options |
hideResolved | Hide the markers of resolved-only cells. | useDataGridComments | Comments options |
importDefaults | Consumer-configurable preselection defaults. | DataGridImportButton, DataGridImportDialog | Import options |
importLimits | Size, row, column, cell, and unpacked-size bounds for the file. Omitted fields use DEFAULT_IMPORT_LIMITS. | DataGridImportButton, DataGridImportDialog | Import options |
includeHeaders | Whether to emit a header row. Default true. | exportGrid | Export options |
includeHeaders | Emit a <thead> header row. Default true. | printGrid | Export options |
index | The column's visible-column index. | DataGridHeaderDropdown | Context menu options |
index | The column's visible-column index. | DataGridHeaderFilter | Toolbar options |
initialAnswer | The answer for the first state (defaultSpec, defaultPage, the first page size), for example from a Server Component. | useDataGridServerRows | Server rows options |
labels | i18n override for this footer's strings, merged key by key over the enclosing grid's labels.pagination (the built-in defaults outside a DataGridProvider). | DataGridPaginationBar | Client pagination options |
labels | i18n overrides for this bar's strings, merged over labels.statusBar. | DataGridStatusBar | Status bar options |
labels | Overrides for the menu's strings, merged key by key over the grid's labels.views, which sit over the built-in English defaults. | DataGridViews | Saved views options |
labels | Overrides the strings of the comments UI. | useDataGridComments | Comments options |
labels | Overrides the text of the editor. | lookup cell type | Lookup options |
layout | Layout parts synced to the URL under cols (order), hide (hidden), widths, and pins. | DataGridUrlState, useDataGridUrlState | URL state options |
limits | Size, row, column, cell, and unpacked-size bounds for every parse. Omitted fields use DEFAULT_IMPORT_LIMITS. | useDataGridImportPreview | Import options |
loadDelayMs | Milliseconds a block stays in the wanted range before its request starts. | useDataGridServerRows (scroll mode) | Server rows options |
mapping | Lists one entry for each file column: the grid column id, or null to skip the file column. | buildImportedRows | Import options |
matchCase | Makes the match case-sensitive. | planReplace | Find and replace options |
maxBytes | With source: stop after the slice of rows that passes this many bytes of file text. Default 256 MiB. | exportGrid | Export options |
maxCachedRows | Uncontrolled fetch cache bound in rows. | useDataGridComments | Comments options |
maxComments | Default 50,000. Ceiling 500,000. | useDataGridComments | Comments options |
maxCommentsPerCell | Default 50. Ceiling 500. | useDataGridComments | Comments options |
maxConcurrentFetches | Most block requests in flight at once on a random access source. | useDataGridServerRows (scroll mode) | Server rows options |
maxLoadedRows | Most rows kept loaded on a random access source. | useDataGridServerRows (scroll mode) | Server rows options |
maxRects | Sets the most rectangles that one range entry paints. | useDataGridPresence | Presence options |
maxResults | Sets the most options that the editor shows. Default 50. | lookup cell type | Lookup options |
maxRows | Caps the number of data rows that the export writes. A larger scope truncates the export and warns in development. | exportGrid | Export options |
maxRows | Cap on the rows printed. Default 10,000, further cut by the 500,000-cell ceiling. | printGrid | Export options |
maxTextLength | Default 2,000. Ceiling 20,000. | useDataGridComments | Comments options |
minQueryLength | Sets the fewest typed characters that start a request. Default 0. | lookup cell type | Lookup options |
mode | "pages" fetches one page per state and drives pager. | useDataGridServerRows | Server rows options |
normalizeText | Applied to local text before the bounds are checked. | useDataGridComments | Comments options |
onChange | Called with the aggregated row whenever it changes, feed it into a useState that becomes a pinned band's topRows/bottomRows entry. | DataGridAggregateReporter | Pinned rows options |
onChange | Called with the aggregated row whenever it changes, feed it into a useState that becomes a pinned band's topRows/bottomRows entry. | DataGridServerAggregateReporter | Pinned rows options |
onCommentRejected | Called once per refused or reverted write. | useDataGridComments | Comments options |
onCommentSave | Saves one write. | useDataGridComments | Comments options |
onCommentsChange | State channel: one call per store write, next holds confirmed records only. | useDataGridComments | Comments options |
onDataChange | Fires after the hook keeps an edit, insert, delete, or revert. | useDataGridServerRows | Server rows options |
onError | Receives the rejection when an export fails. Without it, the failure logs a dev-only warning. | DataGridExportButton | Export options |
onError | Called once per failed request. | serverAggregateRow | Pinned rows options |
onError | Called once per failed request. | useDataGridServerAggregate, DataGridServerAggregateReporter | Pinned rows options |
onError | Fires after a request fails. | useDataGridServerRows | Server rows options |
onError | Called with a load or save failure. | useDataGridViews, DataGridViews | Saved views options |
onExcessRects | Fires when a range highlight has more rectangles than the cap, with the number kept and the total. | useDataGridPresence | Presence options |
onFetchError | Called for a failed fetch request or for records dropped for a bound. | useDataGridComments | Comments options |
onImport | Called with the fully-built rows on confirm. The consumer decides how to merge. | DataGridImportButton, DataGridImportDialog | Import options |
onImportError | Called once when onImport rejects, with the rejection. | DataGridImportButton, DataGridImportDialog | Import options |
onLoaded | Fires after the rows of a request land, with the range they cover. | useDataGridServerRows | Server rows options |
onLocalChange | Broadcast seam: fires once per confirmed local write. | useDataGridComments | Comments options |
only | Limits the plan to one cell. | planReplace | Find and replace options |
onOpenChange | Fires with the new open state when the dialog opens or closes. | DataGridImportDialog | Import options |
onOpenChange | Fires with the new open state after the dialog opens or closes. | DataGridKeybindingsDialog | Shortcut remapping options |
onOrphanedComments | Called when rows with comments are deleted. | useDataGridComments | Comments options |
onPageChange | Fires with the new page after a page change. | useDataGridPagination | Client pagination options |
onPageChange | Fires with the new page after a page change. | useDataGridServerPager | Client pagination options |
onPageChange | Fires with the new page after a page change. Pair it with page. | useDataGridServerRows (pages mode) | Server rows options |
onPageSizeChange | Fires after a page-size change with the new size. | useDataGridPagination | Client pagination options |
onPageSizeChange | Fires after a page-size change with the new size. | useDataGridServerPager | Client pagination options |
onPageSizeChange | Fires with the new page size after a change. Pair it with pageSize. | useDataGridServerRows (pages mode) | Server rows options |
onProgress | With source: called after each batch with the running totals. | exportGrid | Export 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 |
onSave | Saves a change. Spread to the provider through gridProps.onSave, where it behaves as the DataGridProvider prop of the same name. | useDataGridServerRows | Server rows options |
onSkip | Called when undo or redo finds a row its change needs missing from data, and applies nothing. | useDataGridHistory | Undo and redo options |
onSpecChange | Fires with the new spec after a sort, filter, or search change. Pair it with spec. | useDataGridServerRows | Server rows options |
onValueChange | Fires with the id of the view that the user picks, or null for no view. | useDataGridViews, DataGridViews | Saved views options |
open | Shows the dialog when true. | DataGridImportDialog | Import options |
open | Controlled open state. Omit for uncontrolled state. | DataGridKeybindingsDialog | Shortcut remapping options |
options | Options of useDataGridAggregate, such as scope. | DataGridAggregateReporter | Pinned rows options |
options | Export options applied to both formats besides format itself, including columns, formatCell, and output. Default { scope: 'view', includeHeaders: true }. | DataGridExportButton | Export options |
options | Print options applied to the pass. Default { scope: "view", includeHeaders: true }. | DataGridPrintButton | Export options |
orientation | Page orientation. Default: landscape above 6 visible columns, else portrait. | printGrid | Export options |
output | Receives the finished file in place of the browser download. | exportGrid | Export options |
overscan | Rows fetched beyond the rendered rows on each side. | useDataGridServerRows (scroll mode) | Server rows options |
page | Controls the current page. Pair it with onPageChange. | useDataGridPagination | Client pagination options |
page | Controls the current page. Pair it with onPageChange. | useDataGridServerPager | Client pagination options |
page | Controls the current page. Pair it with onPageChange. | useDataGridServerRows (pages mode) | Server rows options |
pageSize | Controls the page size. Pair it with onPageSizeChange. | useDataGridPagination | Client pagination options |
pageSize | Controls the page size. Pair it with onPageSizeChange. | useDataGridServerPager | Client pagination options |
pageSize | Controls the page size. Pair it with onPageSizeChange. | useDataGridServerRows (pages mode) | Server rows options |
pageSizeOptions | Page sizes the select offers. | DataGridPaginationBar | Client pagination options |
pageSizeOptions | Page sizes the select offers. | useDataGridPager | Client pagination options |
pageSizeOptions | Page sizes the select offers. | useDataGridPagination | Client pagination options |
pageSizeOptions | Page sizes the select offers. | useDataGridServerPager | Client pagination options |
pageSizeOptions | Page sizes the footer offers. | useDataGridServerRows (pages mode) | Server rows options |
pageSizeOptions | A pageSize URL value outside this list falls back to defaultPageSize. | useDataGridUrlPagination | URL state options |
paperSize | Paper size of the printed page. Default "A4". | printGrid | Export options |
parseFile | Reads the file in place of the built-in parser. | DataGridImportButton, DataGridImportDialog | Import options |
parseFile | Reads the file in place of the built-in parser, for every parse. | useDataGridImportPreview | Import options |
placeholder | Sets the placeholder text of the search box. | DataGridSearch | Toolbar options |
plugins | Plugins the hook mounts after its refresh guard, through gridProps.plugins. | useDataGridServerRows | Server rows options |
plugins | Plugins the hook mounts after its refresh guard, through gridProps.plugins. | useDataGridServerRows (scroll mode) | Server rows options |
plugins | Other plugins of the grid. | useDataGridState | Undo and redo options |
prefetchNextPage | Fetches the page after the current one in the background once the current page has landed. | useDataGridServerRows (pages mode) | Server rows options |
prefix | Namespaces 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, useDataGridUrlState | URL state options |
prefix | Namespaces the page/pageSize URL keys as <prefix>_<key>, so multiple grids can coexist on one page. | useDataGridUrlPagination | URL state options |
processCellFromText | Parses one cell in place of cellType.fromText. Can return a promise, which makes the build asynchronous. | buildImportedRows | Import options |
processCellFromText | Parses one cell in place of the column's fromText. | DataGridImportButton, DataGridImportDialog | Import options |
processFill | Runs before a fill writes. Return the text grid to write, or false to cancel the fill. | useDataGridFill | Fill handle options |
processImportRows | Rewrites or drops the data rows before the grid maps them. | DataGridImportButton, DataGridImportDialog | Import options |
processReplace | Runs after the plan exists and before the grid writes it. | useDataGridFindReplace | Find and replace options |
readOnly | Blocks every comment write and hides the composer and the actions. | useDataGridComments | Comments options |
recordSources | Which DataChange.source values go on the undo stack. | useDataGridHistory | Undo and redo options |
refreshAfterSave | The false | "settled" subset of the server hooks' refreshAfterSave policy. | serverAggregateRow | Pinned rows options |
refreshAfterSave | The false | "settled" subset of the server hooks' refreshAfterSave policy. | useDataGridServerAggregate, DataGridServerAggregateReporter | Pinned rows options |
refreshAfterSave | Sets when the hook calls refresh() after a save settles: "settled", "each", false, or a function. Default "settled". | useDataGridServerRows | Server rows options |
replaceAllLimit | Most cells one plan targets. Default 10,000, clamped to 1..100,000. | planReplace | Find and replace options |
replaceAllLimit | Most cells one plan targets. Default 10,000, clamped to 1..100,000. | useDataGridFindReplace | Find and replace options |
reshapeDelayMs | Milliseconds to wait after a push marked a row stale before the hook runs a refresh() so the server places the rows again. | useDataGridServerRows | Server rows options |
revalidateIntervalMs | Milliseconds between refresh() calls the hook runs itself while the page is visible. | useDataGridServerRows | Server rows options |
sanitizeFormulas | Prefix 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. | exportGrid | Export options |
scope | "view" reduces over every row the sort and filter leave, all pages of a paged grid. | aggregateRow | Pinned rows options |
scope | Sets which rows to export: "view", "page", "all", or "selection". Default "view". | exportGrid | Export 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. | planReplace | Find and replace options |
scope | Sets which rows to print: "view", "page", "all", or "selection". Default "view". | printGrid | Export options |
scope | "view" reduces over every row the sort and filter leave, all pages of a paged grid. | useDataGridAggregate | Pinned 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. | useDataGridFindReplace | Find and replace options |
setFilterOperator | Operator of the set entry the popover writes. | DataGridHeaderFilter | Toolbar options |
sheetName | Name of the single sheet inside the xlsx file. Default 'Sheet1'. | exportGrid | Export options |
sheetName | For xlsx/xls: import this sheet by name in place of the first. Rejects when the workbook has no sheet by that name. | parseImportFile | Import options |
signal | Checked 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". | buildImportedRows | Import options |
signal | Cancels the export. | exportGrid | Export options |
signal | Aborts the file read. An aborted parse rejects with an AbortError. | parseImportFile | Import options |
signal | Cancels the print: the promise rejects with the signal's reason and no dialog opens. | printGrid | Export options |
skip | Leaves out the cells it returns true for. A continuation passes the cells an earlier plan replaced. | planReplace | Find and replace options |
source | Where the rows of the whole result come from, for a grid that holds one page or some loaded blocks. | exportGrid | Export options |
source | Where the rows come from, for a grid that holds one page or some loaded blocks. | printGrid | Export options |
source | Sets how the hook fetches rows: "random" by block position, or "sequential" in order. | useDataGridServerRows (scroll mode) | Server rows options |
spec | View-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, useDataGridUrlState | URL state options |
spec | Controls the sort, filter, and search. Pair it with onSpecChange. | useDataGridServerRows | Server rows options |
specs | The aggregate to compute for each column. | DataGridAggregateReporter | Pinned rows options |
status | Dims both bands while the server values load, go stale, or fail. | useDataGridPinnedRows | Pinned rows options |
storage | Where views persist. | useDataGridViews, DataGridViews | Saved views options |
title | Printed as an <h1> heading and the document title. | printGrid | Export options |
topRows | Rows pinned in a sticky band directly under the header, a SEPARATE array from data, not indices into it. | useDataGridPinnedRows | Pinned rows options |
totalRowCount | Row count across all pages. null when the server sends no count. | useDataGridServerPager | Client pagination options |
trigger | The core's own ghost-chevron trigger element (styling/aria-label owned by header-cell.tsx). | DataGridHeaderDropdown | Context menu options |
trigger | Rendered as the dialog's trigger (e.g. a <Button>). Omit to drive open externally only. | DataGridKeybindingsDialog | Shortcut remapping options |
unresolvedPaste | Sets what happens to a pasted text that matches no known option: "reject", "clear", or "keep". Default "reject". | lookup cell type | Lookup options |
validateRow | Runs once per built row after the build parses its cells, like the grid's validateRow. | buildImportedRows | Import options |
value | Id of the active view. | useDataGridViews, DataGridViews | Saved views options |
valueMode | For 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. | parseImportFile | Import options |
wholeCell | Matches only a cell whose whole text equals the search text. | planReplace | Find and replace options |
windowSize | How many numbered page buttons the default layout shows at once (forwarded to DataGridPaginationPages. Ignored with children). | DataGridPaginationBar | Client pagination options |
xlsxWriter | How XLSX is written. Default "buffered". | exportGrid | Export options |
By add-on
Sort, filter, and search
Options of the sort, filter, search, saved views, and URL add-ons.
| Options | Used by | Page |
|---|---|---|
allColumns | DataGridSortList, DataGridFilterMenu | Sort list options |
debounceMs, placeholder, className | DataGridSearch | Toolbar options |
className | DataGridFilterMenu | Toolbar options |
className, children | DataGridToolbar | Toolbar options |
className | DataGridColumnsMenu | Toolbar options |
className | DataGridSortList | Sort list options |
column, index, className, setFilterOperator | DataGridHeaderFilter | Toolbar options |
scope, replaceAllLimit, processReplace, findScope, className | useDataGridFindReplace | Find and replace options |
matchCase, wholeCell, only, skip, scope, replaceAllLimit | planReplace | Find and replace options |
storage, value, defaultValue, onValueChange, enableDefaultView, onError | useDataGridViews, DataGridViews | Saved views options |
className, labels | DataGridViews | Saved views options |
prefix, spec, layout, enableNavigationSync | DataGridUrlState, useDataGridUrlState | URL state options |
prefix, defaultPageSize, pageSizeOptions | useDataGridUrlPagination | URL state options |
Clipboard and undo
Options of the fill handle and the history add-ons.
| Options | Used by | Page |
|---|---|---|
disabled, processFill, detectSeries | useDataGridFill | Fill handle options |
getRowId, capacity, datasetKey, plugins | useDataGridState | Undo and redo options |
capacity, datasetKey, recordSources, onSkip | useDataGridHistory | Undo and redo options |
Editing cells
Options of the lookup cell type. A lookup column takes them in its options field.
| Options | Used by | Page |
|---|---|---|
fetchOptions, debounceMs, minQueryLength, maxResults, unresolvedPaste, labels | lookup cell type | Lookup options |
Import, export, and print
Options of the file add-ons.
| Options | Used by | Page |
|---|---|---|
formats, options, onError, className | DataGridExportButton | Export options |
format, scope, includeHeaders, csvDelimiter, csvBom, sanitizeFormulas, fileName, sheetName, maxRows, xlsxWriter | exportGrid | Export options |
columns, formatCell, output, headers | exportGrid | Export options |
source, maxBytes, signal, onProgress | exportGrid | Export options |
scope, title, includeHeaders, orientation, maxRows, paperSize, direction, source, headers, css, signal | printGrid | Export options |
options, className | DataGridPrintButton | Export options |
className | DataGridImportButton | Import options |
open, onOpenChange, className | DataGridImportDialog | Import options |
csvDelimiter, sheetName, csvEncoding, signal, valueMode | parseImportFile | Import options |
dataRows, mapping, columns, cellTypes, createRow, processCellFromText, signal, existingRows, validateRow, getRowId | buildImportedRows | Import options |
createRow, onImport, importDefaults, importLimits | DataGridImportButton, DataGridImportDialog | Import options |
onImportError, parseFile, accept, csvEncoding, processImportRows, processCellFromText, file, checkImport | DataGridImportButton, DataGridImportDialog | Import options |
columnFallback, defaults, limits, parseFile, csvEncoding | useDataGridImportPreview | Import options |
Rows, pages, and menus
Options of the pagination, pinned rows, and menu add-ons.
| Options | Used by | Page |
|---|---|---|
data, defaultPageSize, pageSize, pageSizeOptions, defaultPage, page, onPageChange, onPageSizeChange | useDataGridPagination | Client pagination options |
page, pageSize, totalRowCount, hasMore, onPageChange, pageSizeOptions, onPageSizeChange | useDataGridServerPager | Client pagination options |
pageSizeOptions | useDataGridPager | Client pagination options |
className, labels, windowSize, children, pageSizeOptions, the fields of the pager | DataGridPaginationBar | Client pagination options |
column, index, trigger, getHeaderMenuItems, className | DataGridHeaderDropdown | Context menu options |
getCellMenuItems, getHeaderMenuItems, className, children | DataGridContextMenu | Context menu options |
topRows, bottomRows, status | useDataGridPinnedRows | Pinned rows options |
fetchAggregates, columnIds, debounceMs, refreshAfterSave, onError | useDataGridServerAggregate, DataGridServerAggregateReporter | Pinned rows options |
specs, options, onChange | DataGridAggregateReporter | Pinned rows options |
onChange | DataGridServerAggregateReporter | Pinned rows options |
scope, cells | aggregateRow | Pinned rows options |
fetchAggregates, columnIds, debounceMs, onError, cells, refreshAfterSave | serverAggregateRow | Pinned rows options |
scope | useDataGridAggregate | Pinned rows options |
Selection and shortcuts
Options of the status bar and the key dialog.
| Options | Used by | Page |
|---|---|---|
aggregates, formatValue, labels, className, children | DataGridStatusBar | Status bar options |
open, onOpenChange, defaultOpen, trigger, className | DataGridKeybindingsDialog | Shortcut remapping options |
Server
Options of the server rows, presence, and comments add-ons.
| Options | Used by | Page |
|---|---|---|
mode, getRowId, fetchRows, defaultSpec, spec, onSpecChange, onError, onLoaded, onDataChange, revalidateIntervalMs, reshapeDelayMs, plugins, initialAnswer | useDataGridServerRows | Server rows options |
onSave, refreshAfterSave | useDataGridServerRows | Server rows options |
page, defaultPage, pageSize, defaultPageSize, pageSizeOptions, onPageChange, onPageSizeChange, prefetchNextPage | useDataGridServerRows (pages mode) | Server rows options |
source, blockSize, overscan, loadDelayMs, maxConcurrentFetches, maxLoadedRows, plugins, onRenderedRowsChange | useDataGridServerRows (scroll mode) | Server rows options |
maxRects, onExcessRects | useDataGridPresence | Presence options |
currentUser, comments, defaultComments, onCommentsChange, onCommentSave, onCommentRejected, onLocalChange, canCreate, canEdit, canDelete, canResolve | useDataGridComments | Comments options |
fetchComments, onFetchError, onOrphanedComments, createId, normalizeText, maxTextLength, maxCommentsPerCell, maxComments, maxCachedRows, allowWhenReadOnly, readOnly, enableResolve, enableEdit, enableDelete, hideResolved, labels, className | useDataGridComments | Comments options |