Getting Started with the KendoReact Data Grid

This guide provides essential information about using the KendoReact Data Grid—you will learn how to install the package, add the React Data Grid component to your project, style it, and activate your license.

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

If you want to see the Data Grid used in a complete app, check out our Sample Applications section.

Setting Up Your React Project

Before you install the KendoReact Grid package, 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 Component

All KendoReact packages are distributed through npm and offer a similar installation experience. To use the Data Grid, start with the installation of the Grid 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:

Copy Codenpm install --save @progress/kendo-react-grid @progress/kendo-data-query @progress/kendo-react-data-tools @progress/kendo-react-inputs @progress/kendo-react-intl @progress/kendo-react-dropdowns @progress/kendo-react-dateinputs @progress/kendo-drawing @progress/kendo-react-animation @progress/kendo-licensing @progress/kendo-react-buttons @progress/kendo-react-treeview

Importing the Component

After installing the package, import the Grid component in the React App. To use the Grid columns, also import the GridColumn component. To add some sample data to the Grid, import the products.json file from the example above.

In the App component file of your React project (for example, src/App.js), add the imports.

Copy Code// ES2015 module syntax
import { Grid, GridColumn as Column } from "@progress/kendo-react-grid";
import products from "./products.json";

Copy Code// CommonJS format
const { Grid, GridColumn as Column } = require('@progress/kendo-react-grid');
const { products} = require('./products.json');

Using the Component

1. After installing the Grid package and importing the component, add the Grid tags to the App component file of your React project (for example, src/App.js). Then add the columns that correspond to the data in the products.json file. Optionally, set the Grid's height.

   Copy Codeconst App = () => {
   return (
       <Grid
       style={{
           height: "400px",
       }}
       data={products}
       >
       <GridColumn field="ProductID" title="ID" width="40px" />
       <GridColumn field="ProductName" title="Name" width="250px" />
       <GridColumn field="Category.CategoryName" title="CategoryName" />
       <GridColumn field="UnitPrice" title="Price" />
       <GridColumn field="UnitsInStock" title="In stock" />
   );
   };
   
   ReactDOM.render(<App />, document.querySelector("my-app"));

2. To style the Grid, 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';

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

   Copy Codenpm start

4. Navigate to http://localhost:3000 to see the KendoReact Grid 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 Grid package requires you to install the following peer dependencies in your application:

Implementing React Data Grid: Video Tutorial

If you prefer video, watch the React Data Grid Video Tutorial. You will see how to implement the KendoReact Data Grid and how to work the following grid features: theming and styling, paging and filtering.

Using the Template Wizard in VS Code

To quickly scaffold a KendoReact Data Grid, you can use the Kendo UI Template Wizard for Visual Studio Code. The template allows you to add a Grid to your application with a single click. It also lets you customize your application with one of the KendoReact themes. Read more about the Kendo UI Template Wizard for Visual Studio Code...

Suggested Links

• Setting up local data operations
• Applying data operations on the server
• Editing Grid data records
• Using locked columns in the Grid
• Exporting the Grid content to PDF
• Styling the Grid
• API Reference of the Grid

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