GridCsvExportOptions API

The options to apply on the CSV export.

Demos

For examples and details on the usage, check the following pages:

CSV export

Import

import { GridCsvExportOptions } from '@mui/x-data-grid-premium'
// or
import { GridCsvExportOptions } from '@mui/x-data-grid-pro'
// or
import { GridCsvExportOptions } from '@mui/x-data-grid'

Properties

allColumnsOptional

If true, the hidden columns will also be exported.

Type:boolean

Default:false

delimiterOptional

The character used to separate fields.

Type:string

Default:','

fieldsOptional

The columns exported.
This should only be used if you want to restrict the columns exports.

Type:string[]

fileNameOptional

The string used as the file name.

Type:string

Default:document.title

getRowsToExportOptional

Function that returns the list of row ids to export on the order they should be exported.

Type:(params: GridCsvGetRowsToExportParams) => GridRowId[]

includeColumnGroupsHeadersOptional

If true, the CSV will include the column groups.

Type:boolean

Default:true

includeHeadersOptional

If true, the CSV will include the column headers and column groups.
Use includeColumnGroupsHeaders to control whether the column groups are included.

Type:boolean

Default:true

utf8WithBomOptional

If true, the UTF-8 Byte Order Mark (BOM) prefixes the exported file.
This can allow Excel to automatically detect file encoding as UTF-8.

Type:boolean

Default:false