Getting Started with the KendoReact ListViewPremium
This guide provides essential information about using the KendoReact ListView package—you will learn how to install the ListView package, add a ListView 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 ListView, 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 ListView Package
All KendoReact packages are distributed through npm and offer a similar installation experience. To use the ListView component, start with the installation of the ListView npm package and its dependencies. Use Node.js v5.0.0 or later.
npm install --save @progress/kendo-react-listview @progress/kendo-licensing
Importing the Component
After installing the package, import the ListView component and the products
data in the React App.
In the src/App.js
file of your React project, import the ListView
component from the ListView package.
// ES2015 module syntax
import { ListView } from "@progress/kendo-react-listview";
// CommonJS format
const { ListView } = require('@progress/kendo-react-listview');
Using the Component
-
Import the
products
data in thesrc/App.js
file.jsximport products from './products.json';
-
Add the ListView component in the
App
component.jsx<div> <ListView data={products} item={MyItemRender} style={{ width: '100%' }} /> </div>
-
Create the
MyItemRender
component responsible for rendering each ListView item.jsxconst MyItemRender = (props: ListViewItemProps) => { let item = props.dataItem; return ( <div className="k-listview-item" style={{ padding: 10, borderBottom: '1px solid lightgrey' }}> {item.ProductName} </div> ); };
-
To style the ListView, install and import the Default theme, which is one of the three beautiful themes for KendoReact.
2.1. Install the Default theme package.
shnpm install --save @progress/kendo-theme-default
2.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 ListView 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 ListView 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. |