Getting Started with the KendoReact Excel Export
Premium

This guide provides essential information about using the KendoReact Excel Export package and ExcelExport component—you will learn how to install the Excel Export package, add a ExcelExport component to your project, style the component, and activate your license.

The Excel Export is part of KendoReact premium, an enterprise-grade UI library with 120+ free and premium components for building polished, performant apps. Test-drive all features with a free 30-day trial.Start Free Trial

After completing this guide, you will be able to reproduce the following example.

Change Theme

Theme

Loading ...

Setting Up Your React Project

Before you install the KendoReact Excel Export, make sure that you have a running React project. The easiest way to set up a React project is to use the Create React App approach that is described in the Get Started with KendoReact article.

Installing the Excel Export Package

All KendoReact packages are distributed through npm and offer a similar installation experience. To use the ExcelExport component, start with the installation of the Excel Export npm package and its dependencies. Use Node.js v5.0.0 or later.

npm i @progress/kendo-react-excel-export

Importing the Component

After installing the package, import the ExcelExport component in the React App.

In the src/App.js file of your React project, import the ExcelExport component from the Excel Export package.

jsx

// ES2015 module syntax
import { ExcelExport } from '@progress/kendo-react-excel-export';

jsx

// CommonJS format
const { ExcelExport } = require('@progress/kendo-react-excel-export');

Using the Component

Import the products data in the src/App.js file.
jsx
```
import products from './products.json';
```

Add the ExcelExport component to the page.

jsx

<ExcelExport data={products} fileName="Products.xlsx" ref={_exporter}>
    <ExcelExportColumn field="ProductID" title="Product ID" locked={true} width={200} />
    <ExcelExportColumn field="ProductName" title="Product Name" width={350} />
    <ExcelExportColumn field="UnitsOnOrder" title="Units on Order" />
    <ExcelExportColumn field="UnitsInStock" title="Units in Stock" />
</ExcelExport>

Add a button in the App component that will export the data to Excel.

jsx

<button className="k-button k-button-md k-rounded-md k-button-solid k-button-solid-base" onClick={exportExcel}>
    Export to Excel
</button>

Handle the button's onClick event and set it to export the data by using the ExcelExport save method.

jsx

const _exporter = React.createRef<ExcelExport>();

const exportExcel = () => {
    if (_exporter.current) {
    _exporter.current.save();
    }
};

To style the KendoReact components, install and import the Default theme, which is one of the three beautiful themes for KendoReact.

2.1. Install the Default theme package.

npm i @progress/kendo-theme-default

2.2. Import the CSS file from the package in src/App.js. Add this import before your existing App.css import.

jsx

import '@progress/kendo-theme-default/dist/all.css';

Build and run the application by typing the following command in the root folder of your project:

npm start

Navigate to http://localhost:3000 to see the KendoReact ExcelExport component on the page.

Activating Your License Key

Using any of the UI components in the KendoReact library requires either a commercial license key or an active trial license key.

Follow the instructions on the KendoReact My License page to activate your trial or commercial license. You can skip this step if your application already contains a KendoReact license file.

Dependencies

The Excel Export package requires you to install the following peer dependencies in your application:

Package Name	Description
react 16.8.2*	Contains the functionality necessary to define React components.
react-dom	Contains the React renderer for the web.
@progress/kendo-licensing	Contains the internal infrastructure related to licensing.