Components
    • Animation
    • Barcodes
    • Buttons
    • Charts
    • Common Utilities
    • Conversational UI
    • Data Grid
    • Data Query
    • Data Tools
    • Date Inputs
    • Date Math
    • Dialogs
    • Drawing
    • Dropdowns
    • Editor
    • Excel Export
    • File Saver
    • Form
    • Gantt
    • Gauges
    • Indicators
    • Inputs
    • Labels
    • Layout
    • ListBox
    • ListView
    • Mapbeta
    • Notification
    • PDF Processing
    • PivotGrid
    • Popup
    • Progress Bars
    • Ripple
    • Scheduler
    • ScrollView
    • Sortable
    • TaskBoard
    • Tooltips
    • TreeList
    • TreeView
    • Upload
    Sample Applications
    Styling & Themes
    Common Features
    Project Setup
    Changelog

Getting Started with the KendoReact Common Utilities

This guide provides essential information about using the KendoReact Common Utilities package—you will learn how to install the package, add Common Utilities to your project, style the components, and activate your license. The steps demonstrated in this guide are applicable to all KendoReact Common Utilities.


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

Example
View Source
Change Theme:

Setting Up Your React Project

Before you install the KendoReact Common Utilities, 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 Common Utilities, 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-common @progress/kendo-licensing

Importing the Components

After installing the Common Utilities package, import the desired components in the React App. This guide shows how to add the Icon.

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

// ES2015 module syntax
import { Icon } from '@progress/kendo-react-common';
// CommonJS format
const { Icon } = require('@progress/kendo-react-common');

If your project requires more Common Utilities, you can import them too. The Common Utilities package provides the following components:

  • Icon
  • SvgIcon
  • Typography
  • Draggable

Using the Components

  1. After installing the Common Utilities package and importing the components, add the Icon's tags to the App component file of your React project (for example, src/App.js).

       const App = () => {
          return <Icon name="palette" size='xlarge' />;
       };
  2. To style the Icon, install and import the Default theme, which is one of the three beautiful themes for KendoReact.

    2.1. Install the Default theme package.

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

    import '@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:

    npm start
  4. Navigate to http://localhost:3000 to see the KendoReact Icon component on the page.

Now try to add another component from the Common Utilities package yourself. The procedures for installing, importing, and using the Common Utilities 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 Common Utilities package requires you to install the following peer dependencies in your application:

Package NameDescription
react 16.8.2*Contains the functionality necessary to define React components.
react-domContains the React renderer for the web.
@progress/kendo-licensingContains the internal infrastructure related to licensing.

Learning Resources