Getting Started with the KendoReact Excel Export

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.

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

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.

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

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.

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

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

Using the Component

1. Import the products data in the src/App.js file.

   Copy Code    import products from './products.json';

2. Add the ExcelExport component to the page.

   Copy Code    <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>

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

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

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

   Copy Code    const _exporter = React.createRef<ExcelExport>()
         const exportExcel = () => {
             if(_exporter.current){
                 _exporter.current.save();
             }
   
       }

5. 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.

   Copy Codenpm install --save @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.

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

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

   Copy Codenpm start

7. 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:

Suggested Links

• Configuration of exported columns
• Customization of exported cells
• Customization of the workbook
• Filtering
• Saving files on the server
• Right-to-left support
• Add Loading

Learning Resources

• Getting Started with KendoReact
• Virtual Classroom (Introductory Course Available to Trial and Commercial License Holders)
• Explore the Finance Portfolio Sample Application
• Explore the Coffee Warehouse Sample Application
• Explore the Github Issues Grid Sample Application