Getting Started with the KendoReact OrgChart
This guide provides essential information about using the KendoReact OrgChart package. You will learn how to install the OrgChart package, add an OrgChart 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 OrgChart, make sure that you have a running React project. The easiest way to set up a project for the KendoReact components is to use the create-kendoreact-app
tool that is described in the Get Started with KendoReact article.
Installing the OrgChart Package
All KendoReact packages are distributed through npm and offer a similar installation experience. To use the OrgChart component, start with the installation of the OrgChart npm package and its dependencies. Use Node.js v5.0.0 or later.
npm install --save @progress/kendo-react-orgchart @progress/kendo-data-query @progress/kendo-licensing @progress/kendo-svg-icons
Importing the Component
After installing the package, import the OrgChart component in the React App.
In the src/App.js
file of your React project, import the OrgChart
component from the OrgChart package.
// ES2015 module syntax
import { OrgChart } from '@progress/kendo-react-orgchart';
// CommonJS format
const { OrgChart } = require('@progress/kendo-react-orgchart');
Using the Component
-
After installing the OrgChart package and importing the components, add the OrgChart tag to the App component file of your React project (for example,
src/App.js
). -
Set the data to its
data
property and set the title field using thetitleField
prop.const App = () => { return ( <OrgChart data={data} titleField="text" /> ); } export default App;
-
To style the OrgChart, install and import the Default theme, which is one of the four beautiful themes for KendoReact.
3.1. Install the Default theme package.
npm install --save @progress/kendo-theme-default
3.2. Import the CSS file from the package in
src/App.js
. Add this import before your existingApp.css
import.import '@progress/kendo-theme-default/dist/all.css';
-
Build and run the application by typing the following command in the root folder of your project:
npm start
-
Navigate to http://localhost:3000 to see the KendoReact OrgChart component on the page.
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 PDF Viewer 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-data-query | Applies sorting, filtering, grouping, and aggregate data operations. |
@progress/kendo-licensing | Contains the internal infrastructure related to licensing. |
@progress/kendo-svg-icons | Contains the KendoReact SVG icons. |