GridCSVExportOptions
Represents the CSV export options for the Grid component. Extends CSVExportOptions from @progress/kendo-csv with all properties optional.
<Grid csv={{
fileName: 'export.csv',
preventFormulaInjection: true,
keys: ['ProductID', 'ProductName'],
names: ['ID', 'Name']
}} />
| Name | Type | Default | Description |
|---|---|---|---|
allPages? |
|
|
Specifies whether to export all pages or only the current page when paging is enabled.
When tsx
|
data? |
|
Optional data to export to CSV instead of using the Grid's data prop. Useful when you want to export different data than what's displayed in the Grid. tsx
| |
delimiter? |
|
Character used to separate values in a row. Must be a single character. Common delimiters: "," (default), ";", "|", "\t" (tab). Invalid delimiters automatically fall back to comma. | |
fileName? |
|
|
Specifies the name of the exported CSV file. tsx
|
groupHeaderFormatter? |
|
Custom formatter for group header in grouped data exports. Receives the display names of grouped fields, returns the formatted header. Default: Joins display names with '/' separator (e.g., "Region/Category"). ts
| |
groupValueFormatter? |
|
Custom formatter for group value rows in grouped data exports. Receives the values and field names, returns the formatted group value. Default: Joins values with '/' separator (e.g., "North/Electronics"). ts
ts
| |
includeUTF8BOM? |
|
When true, adds a UTF-8 Byte Order Mark (BOM) at the beginning of the file. Helps applications like Microsoft Excel correctly recognize UTF-8 encoding. Recommended when data contains non-ASCII characters (accents, emojis, etc.). Default: false. | |
keys? |
|
Property names to extract from object/Map rows, in order.
Required when data contains objects or Maps (unless | |
lineSeparator? |
|
String used to terminate each line. Default: "\r\n" (CRLF, Windows/CSV standard). Alternative: "\n" (LF, Unix/macOS). | |
maxCellLength? |
|
Maximum number of characters allowed per cell. Values exceeding this limit are truncated. Default: 32767 (Excel's maximum cell length). | |
maxColumns? |
|
Maximum number of columns to export. Keys/columns exceeding this limit are automatically truncated. Default: 1000 (prevents memory exhaustion and DoS attacks). | |
maxRows? |
|
Maximum number of rows to export. Data exceeding this limit is automatically truncated. Default: 1000000 (prevents memory exhaustion and DoS attacks). | |
names? |
|
Optional column headers to render on the first line.
If provided, also used as default for | |
preventFormulaInjection? |
|
When true, prefixes potentially dangerous formula characters (=, +, -, @, tab, \r) with a single quote (') to prevent formula injection attacks in spreadsheet applications. Default: true (recommended for security). |