Getting Started with the KendoReact Data Tools
This guide provides essential information about using the KendoReact Data Tools package—you will learn how to install the package, add Data Tools to your project, style the components, and activate your license. The steps demonstrated in this guide are applicable to all KendoReact Data Tools.
Start Free TrialAfter completing this guide, you will be able to reproduce the following example.
Setting Up Your React Project
Before you install the KendoReact Data Tools, 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 Components
All KendoReact packages are distributed through npm and offer a similar installation experience. To use any of the Data Tools, start with the installation of the npm package and its dependencies. Use Node.js v5.0.0 or later.
Navigate to the root folder of your React project and run the following command:
npm install --save @progress/kendo-react-data-tools @progress/kendo-data-query @progress/kendo-drawing @progress/kendo-react-buttons @progress/kendo-react-dateinputs @progress/kendo-react-dropdowns @progress/kendo-react-inputs @progress/kendo-react-intl @progress/kendo-licensing
Importing the Components
After installing the Data Tools package, import the desired components in the React App. This guide shows how to add the Pager.
In the App component file of your React project (for example, src/App.js
), add the following code:
// ES2015 module syntax
import { Pager } from '@@progress/kendo-react-data-tools';
// CommonJS format
const { Pager } = require('@progress/kendo-react-data-tools');
If your project requires more Data Tools, you can import them too. The Data Tools package provides the following components:
- Pager
- Filter
Using the Components
-
After installing the Data Tools package and importing the components, add the Pager's tags to the App component file of your React project (for example,
src/App.js
).jsreturn <Pager skip={skip} take={take} total={50} previousNext={true} onPageChange={handlePageChange} />;
-
To control the current page, create two state variables for skip and take.
jsconst [skip, setSkip] = React.useState(0); const [take, setTake] = React.useState(10);
-
Handle the onPageChange event to update the page based on the user selection.
jsconst handlePageChange = (event: PageChangeEvent) => { setSkip(event.skip); setTake(event.take); };
-
To style the Pager, install and import the Default theme, which is one of the three beautiful themes for KendoReact.
4.1. Install the Default theme package.
shnpm install --save @progress/kendo-theme-default
4.2. Import the CSS file from the package in
src/App.js
. Add this import before your existingApp.css
import.jsximport '@progress/kendo-theme-default/dist/all.css';
-
Build and run the application by typing the following command in the root folder of your project:
shnpm start
-
Navigate to http://localhost:3000 to see the KendoReact Pager component on the page.
Now try to add another component from the Data Tools package yourself. The procedures for installing, importing, and using the Data Tools components are identical for all components in the package.
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 Data Tools 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. |
@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-data-tools | Delivers components required to manage and control the data in the application. |
@progress/kendo-react-dateinputs | Contains the KendoReact Date Inputs components that are used to select the date and time for an appointment. |
@progress/kendo-react-dropdowns | Contains the KendoReact Dropdowns, which allows users to choose from a predefined list of options. |
@progress/kendo-react-inputs | Contains the KendoReact Inputs, which the input of data, based on a specific and predefined format. |
@progress/kendo-drawing | Contains the Drawing library, which provides interactive vector graphics. |
@progress/kendo-react-buttons | Contains the KendoReact Buttons library, which provides buttons. |
@progress/kendo-svg-icons | Contains the KendoReact SVG icons. |