KendoReact Data Grid Excel Export Overview

The KendoReact Data Grid provides you the option to export its data to excel by utilizing the KendoReact Excel Export library.

The KendoReact Data Grid Excel Export in Action

The following example demonstrates the basic implementation of the Excel export functionality of the Grid.

Getting Started with the KendoReact Data Grid Excel Export

To enable the Excel export:

1. Install kendo-react-excel-export package.

   Copy Codenpm install @progress/kendo-react-excel-export @progress/kendo-licensing

2. Import the ExcelExport component in your React Application.

   Copy Codeimport { ExcelExport } from '@progress/kendo-react-excel-export';

3. Wrap the Grid in the ExcelExport component and use the ExcelExport save function to export the Grid and save it to excel file.

Configuration

You can entirely control the Excel export configuration through the arguments that are passed to the save function of the KendoReact Excel Export component.

The ExcelExport enables you to:

• Wrap the Grid in an ExcelExport component
• Pass the Grid columns to the ExcelExport component
• Export specific data
• Customize the exported columns of the Grid

Wrapping the Grid

If the Grid is passed as a child to the ExcelExport and its columns are defined declaratively by using the GridColumn components, they will be automatically detected. You still need to pass the data of the Grid to the save function or as a data property to the ExcelExport component.

Passing the Grid Columns

The Grid exposes its columns through its columns field. To pass the Grid columns, pass its data and columns to the save function of the ExcelExport component.

Exporting Specific Data

To export specific data, pass the data to the save function of the ExcelExport component. For example, if the Grid has its paging enabled but you need to export all pages, pass the unprocessed data to the save function.

Customizing Exported Columns

You can use the same data as the Grid and customize the exported columns. To export columns that are different from the current Grid columns, include the ExcelExportColumn and ExcelExportColumnGroup components as children to the ExcelExport.

Known Limitations

• During the export to Excel, the Grid does not use column formats. Column formats are incompatible with Excel. For more information, refer to the page on the Excel-supported formats.
• The maximum size of the exported file to Excel has a system-specific limit. For large data sets, it is highly recommended that you use a server-side solution.
• When you use the ExcelExport in older browsers, such as Internet Explorer 9 and Safari, you have to implement a server proxy using the proxyUrl property of the ExcelExport component. You can refer to this KB article for an example.

KendoReact Data Grid Excel Export APIs

• API Reference of the Grid Component
• API Reference of the Excel Export Component

Suggested Links

• ExcelExport Overview
• Export to Excel Grid Reordered Columns
• Export Multiple Grids to Excel
• Export to Excel Both Parent and Child Grid Data
• Export Data to Excel with Custom Header and Footer
• Export Grid Data With Watermark