Getting Started with the KendoReact Tooltips
This guide provides essential information about using the KendoReact Tooltips package—you will learn how to install the Tooltips package, add a Tooltip 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 Tooltips, 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 components in the Tooltips package, start with the installation of the npm package and its dependencies. Use Node.js v5.0.0 or later.
npm install --save @progress/kendo-react-tooltip @progress/kendo-react-popup @progress/kendo-licensing
Importing the Component
After installing the Tooltips npm package, import the desired components in the React App. This guide shows how to add the Tooltip.
In the App component file of your React project (for example, src/App.js
), add the following code:
// ES2015 module syntax
import { Tooltip, Popover } from '@progress/kendo-react-tooltip';
// CommonJS format
const { Tooltip, Popover } = require('@progress/kendo-react-tooltip');
If your project requires more components from the Tooltips package, you can import them too. The package provides the following components:
- Tooltip
- Popover
Using the Component
-
After installing the Tooltips package and importing the components, add a Button and the Tooltip tags to the App component file of your React project (for example,
src/App.js
).jsx<Tooltip anchorElement="target" position="bottom"> <Button title="Saves the current document">Save</Button> </Tooltip>
-
To style the Tooltip, 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 Tooltip component on the page.
Now try to add another component from the Tooltips package yourself. The procedures for installing, importing, and using the Tooltips 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 Tooltips 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-react-popup | Contains positioning logic for the Popover component |
@progress/kendo-licensing | Contains the internal infrastructure related to licensing. |