Excel Export

The KendoReact Data Grid provides options for exporting its data to Excel.

The Grid Package is part of KendoReact, a professionally built commercial UI library. To try out this Grid you need to sign up for a 30-day trial, which gives you access to the full KendoReact library.


Getting Started

To enable the Excel export:

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

    npm install @progress/kendo-react-excel-export @progress/kendo-licensing
  2. Import the ExcelExport component in your React Application.

    import { 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.

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

Example
View Source
Edit In Stackblitz  
Change Theme:

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:

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.

Example
View Source
Edit In Stackblitz  
Change Theme:

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.

Example
View Source
Edit In Stackblitz  
Change Theme:

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.

Example
View Source
Edit In Stackblitz  
Change Theme:

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.

Example
View Source
Edit In Stackblitz  
Change Theme:

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. For more information, refer to the proxyUrl configuration of the ExcelExport component.