Getting Started with the KendoReact Spreadsheet
This guide provides essential information about using the KendoReact Spreadsheet package. You will learn how to install the Spreadsheet package, add a Spreadsheet 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 Spreadsheet, make sure that you have a running React project. The easiest way to set up a project for the KendoReact components is to use the create-kendoreact-app
tool that is described in the Get Started with KendoReact article.
Installing the Spreadsheet Package
All KendoReact packages are distributed through npm and offer a similar installation experience. To use the Spreadsheet component, start with the installation of the Spreadsheet npm package and its dependencies. Use Node.js v5.0.0 or later.
npm install --save @progress/kendo-react-spreadsheet @progress/kendo-licensing @progress/kendo-svg-icons @progress/kendo-react-buttons @progress/kendo-react-intl @progress/kendo-react-animation @progress/kendo-react-treeview @progress/kendo-react-dropdowns @progress/kendo-drawing @progress/kendo-react-form @progress/kendo-react-inputs @progress/kendo-react-progressbars @progress/kendo-react-layout @progress/kendo-react-popup @progress/kendo-react-sortable @progress/kendo-react-upload
Importing the Component
After installing the package, import the Spreadsheet component in the React App.
In the src/App.js
file of your React project, import the Spreadsheet
component from the Spreadsheet package.
// ES2015 module syntax
import { Spreadsheet } from '@progress/kendo-react-spreadsheet';
// CommonJS format
const { Spreadsheet } = require('@progress/kendo-react-spreadsheet');
Using the Component
-
After installing the Spreadsheet package and importing the components, add the Spreadsheet tag to the App component file of your React project (for example,
src/App.js
). -
Load the JSON sheets data in the
defaultProps
of the Spreadsheet in order to display initial Excel document in the component.function SpreadsheetContainer() { return ( <Spreadsheet style={{ width: '100%', height: 700 }} defaultProps={{ sheets: data }} /> ); } ReactDOM.render(<SpreadsheetContainer />, document.getElementById('app'));
-
To style the Spreadsheet, install and import the Default theme, which is one of the three beautiful themes for KendoReact.
3.1. Install the Default theme package.
npm install --save @progress/kendo-theme-default
3.2. Import the CSS file from the package in
src/App.js
. Add this import before your existingApp.css
import.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 Spreadsheet 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 PDFViewer 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-drawing | Contains the Drawing library, which provides interactive vector graphics. |
@progress/kendo-licensing | Contains the internal infrastructure related to licensing. |
@progress/kendo-react-animation | Enables the animations in the KendoReact components. |
@progress/kendo-react-buttons | Contains the KendoReact Buttons components. |
@progress/kendo-react-dropdowns | Contains the KendoReact Dropdowns, which allows users to choose from a predefined list of options. |
@progress/kendo-react-form | Contains the KendoReact Form components. |
@progress/kendo-react-inputs | Contains the KendoReact Inputs components. |
@progress/kendo-react-intl | Contains the KendoReact Internationalization package that applies the desired cultures by providing services and pipes for the parsing and formatting of dates and numbers. |
@progress/kendo-react-layout | Contains the KendoReact Layout components. |
@progress/kendo-react-popup | Contains the KendoReact Popup component. |
@progress/kendo-react-progressbars | Contains the KendoReact ProgressBar component. |
@progress/kendo-react-sortable | Contains the KendoReact Sortable component. |
@progress/kendo-react-spreadsheet | Contains the KendoReact Spreadsheet component. |
@progress/kendo-react-treeview | Contains the KendoReact Treeview components. |
@progress/kendo-react-upload | Contains the KendoReact Upload components. |
@progress/kendo-svg-icons | Contains the KendoReact SVG icons. |