New to KendoReactStart a free 30-day trial

ExcelExportProps
Premium

Represents the props of the KendoReact ExcelExport component.

NameTypeDefaultDescription

collapsible?

boolean

false

Enables or disables collapsible (grouped) rows in the exported file.

columns?

ExcelExportColumnProps[]

Pass the columns through the component props. If you provide both the columns prop and the child column components, the component uses the columns from props.

creator?

string

The creator of the workbook.

data?

any[]

The exported data. If grouped, structure the data as described by the GroupResult option of the KendoReact Data Query component.

date?

Date

new Date()

The date on which the workbook is created.

dir?

string

If set to rtl, the Excel file is rendered in the right-to-left mode.

fileName?

string

"Export.xlsx"

Specifies the name of the file that is exported to Excel.

filterable?

boolean

Enables or disables the column filtering in the Excel file.

forceProxy?

boolean

false

If set to true, the content is forwarded to proxyURL even if the browser supports saving files locally.

group?

any[]

The exported data groups. The groups must be compatible with the GroupDescriptor option of the KendoReact Data Query component.

headerPaddingCellOptions?

CellOptions

The options of the cells that are inserted before the header cells to align the headers and the column values (when the data is grouped).

hierarchy?

boolean

If set to true, the data is exported as a tree based on the level property of each data record.

onExportComplete?

(event: ExcelExportExportEvent) => void

Triggered after the export is complete.

paddingCellOptions?

CellOptions

The options of the cells that are inserted before the data, group, and footer cells to indicate the group hierarchy (when the data is grouped).

proxyURL?

string

The URL of the server-side proxy which streams the file to the end user. When the browser cannot save files locally—for example, Internet Explorer 9 and earlier, and Safari—a proxy is used. You must implement the server-side proxy.

The proxy receives a POST request with the following parameters in the request body:

  • contentType—The MIME type of the file.
  • base64—The base-64 encoded file content.
  • fileName—The file name, as requested by the caller. The proxy is expected to return the decoded file with the Content-Disposition header set to attachment; filename="<fileName.xslx>".
Not finding the help you need?
Contact Support