Getting Started with the KendoReact Inputs
This guide provides essential information about using the KendoReact Inputs package—you will learn how to install the package, add Input components to your project, style the components, and activate your license. You can apply the steps in this guide to all KendoReact Inputs.
Start Free TrialAfter completing this guide, you will be able to reproduce the following example.
Setting Up Your React Project
Before you install the KendoReact Inputs, 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 Input components, start with the installation of the Inputs 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-inputs @progress/kendo-react-intl @progress/kendo-drawing @progress/kendo-licensing @progress/kendo-svg-icons
Importing the Components
After installing the Inputs package, import the desired components in the React App. This guide shows how to add the ColorPicker.
In the App component file of your React project (for example, src/App.js
), add the following code:
// ES2015 module syntax
import { ColorPicker } from '@progress/kendo-react-inputs';
// CommonJS format
const { ColorPicker } = require('@progress/kendo-react-inputs');
If your project requires more Input components, you can import them too. The Inputs package provides the following components:
- Checkbox
- ColorGradient
- ColorPalette
- ColorPicker
- FlatColorPicker
- Input
- MaskedTextBox
- NumericTextBox
- RadioButton
- RadioGroup
- RangeSlider
- Rating
- Signature
- Slider
- Switch
- TextArea
Using the Components
-
After installing the Inputs package and importing the ColorPicker, add the ColorPicker tags to the App component file of your React project (for example,
src/App.js
).jsconst App = () => { return ( <div className="example-wrapper"> <ColorPicker view="gradient" defaultValue={'green'} /> </div> ); }; ReactDOM.render(<App />, document.querySelector('my-app'));
-
To style the ColorPicker, 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 ColorPicker component on the page.
Now try to add another component from the Inputs package yourself. The procedures for installing, importing, and using the Input 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 Inputs 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-react-intl | Contains the KendoReact Internationalization package that applies the desired cultures by providing services and pipes for the parsing and formatting of dates and numbers. |
@progress/kendo-drawing | Contains the Drawing library, which provides interactive vector graphics. |
@progress/kendo-svg-icons | Contains the KendoReact SVG icons. |
Suggested Links
- Checkbox Overview
- ColorGradient Overview
- ColorPalette Overview
- ColorPicker Overview
- FlatColorPicker Overview
- Input Overview
- TextBox Overview
- MaskedTextBox Overview
- NumericTextBox Overview
- RadioButton Overview
- RadioGroup Overview
- RangeSlider Overview
- Rating Overview
- Signature Overview
- Slider Overview
- Switch Overview
- TextArea Overview
- API Reference of the Inputs