Getting Started with the KendoReact Gauges

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

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

Setting Up Your React Project

Before you install the KendoReact Gauges, 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 Gauges, 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:

Copy Codenpm install --save @progress/kendo-react-gauges @progress/kendo-drawing @progress/kendo-react-intl @progress/kendo-licensing

Importing the Components

After installing the Gauges package, import the desired components in the React App. This guide shows how to add the ArcGauge.

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

Copy Code// ES2015 module syntax
import { ArcGauge } from '@progress/kendo-react-gauges';

Copy Code// CommonJS format
const { ArcGauge } = require('@progress/kendo-react-gauges');

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

• ArcGauge
• CircularGauge
• LinearGauge
• RadialGauge

Using the Components

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

   Copy Code   const ArcGaugeComponent = () => {
         return (
            <ArcGauge value={30} />
         );
      }

2. To style the ArcGauge, 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 ArcGauge component on the page.

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

Suggested Links

• ArcGauge Overview
• CircularGauge Overview
• LinearGauge Overview
• RadialGauge Overview
• API Reference of the Gauges

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