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 and add free Common Utilities to your project. The steps demonstrated in this guide are applicable to all KendoReact Common Utilities (free and premium).
Use React Common Utilities for FreeYou can use the free components from the React Common Utilities package in production—no sign-up or license required. Common Utilities are part of KendoReact, an enterprise-grade UI library with 120+ free and premium components. To test-drive premium components, start a 30-day trial.After completing this guide, you will have a free React SvgIcon.
Before You Begin
npm create vite@latest my-app -- --template react
This guide requires that you have basic knowledge of React and TypeScript, and that you have already created a blank React project.
You can speed up the development of your KendoReact application with the Kendo UI Template Wizard for Visual Studio Code.
Install the Components
npm i @progress/kendo-react-common
Run these commands in the root of your React project to install the KendoReact Common Utilities package and its dependencies, and the Kendo UI Default theme.
Import the Components
import { SvgIcon } from '@progress/kendo-react-common';
import { paletteIcon } from '@progress/kendo-svg-icons';
Place the import
statements in the App component file (for example: src/App.tsx
) for your project. Note that the steps for installing and importing all Common Utilities components are identical.
Use the Components
Using the free KendoReact Common Utilities components does not require a license, even in production. To work with the premium Draggable utility, you need a commercial license key or an active trial license key.
-
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.tsx
).tsx<SvgIcon icon={paletteIcon} size="xlarge" />
-
Build and run the application by typing the following command in the root folder of your project:
shnpm run dev
-
Navigate to http://localhost:3000 to see the KendoReact SvgIcon component on the page.
Style the Components
Are you looking for guidance around how to create visually appealing and consistent user interfaces with Telerik UI components? Check out the Progress Design System.
To use the built-in styling of the components start by installing a theme:
npm i @progress/kendo-theme-default
With the import "@progress/kendo-theme-default/dist/all.css";
statement present in your code, you already have professionally designed styling applied to your app out-of-box. You can also try any of the other available Kendo UI Themes.
Additionally, the SvgIcons provide built-in appearance properties which let you control the size, flip, and theme color of the component. Try to play around with the appearance of your SvgIcon.
<SvgIcon icon={paletteIcon} size="xlarge" themeColor="primary" />
Next Steps
Now try to add another component from the Common Utilities package yourself. The procedures for installing and importing the Common Utilities components are identical for all components in the package.
The Common Utilities package provides the following components:
- Adaptive Mode
- Icon
- SvgIcon
- Typography
- Drag&Drop (premium)
- Keyboard Navigation (premium)
KendoReact Common Utilities APIs
Common Utilities Dependencies
The Common Utilities 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. |
@progress/kendo-svg-icons | Contains the KendoReact SVG icons. |