Getting Started with the KendoReact Gantt

This guide provides essential information about using the KendoReact Gantt package—you will learn how to install the Gantt package, add a Gantt 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 Gantt, 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 Gantt Package

All KendoReact packages are distributed through npm and offer a similar installation experience. To use the Gantt component, start with the installation of the Gantt npm package and its dependencies. Use Node.js v5.0.0 or later.

Copy Code    npm install --save @progress/kendo-react-gantt @progress/kendo-date-math @progress/kendo-drawing @progress/kendo-data-query @progress/kendo-react-intl @progress/kendo-react-treelist @progress/kendo-react-data-tools @progress/kendo-react-dateinputs @progress/kendo-react-inputs @progress/kendo-react-dropdowns @progress/kendo-react-buttons @progress/kendo-licensing @progress/kendo-svg-icons

Importing the Component

After installing the package, import the Gantt component in the React App. To use the Gantt views, also import the GanttDayView, GanttWeekView, and GanttMonthView components. To add some sample data to the Gantt, import the simpleTasks array from the example above.

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

Copy Code    // ES2015 module syntax
    import {
    Gantt,
    GanttWeekView,
    GanttMonthView,
    GanttDayView,
    GanttTextFilter,
    GanttTaskModelFields,
    GanttDependencyModelFields
    } from '@progress/kendo-react-gantt';
    import { simpleDependencies, simpleTasks } from './simpleData';

Copy Code    // ES2015 module syntax
    const {
    Gantt,
    GanttWeekView,
    GanttMonthView,
    GanttDayView,
    GanttTextFilter,
    GanttTaskModelFields,
    GanttDependencyModelFields
    } = require('@progress/kendo-react-gantt');
    const { simpleDependencies, simpleTasks } = require('./simpleData');

Using the Component

1. After installing the Gantt package and importing the component, add the Gantt tags to the App component file of your React project (for example, src/App.js). Then add the Gantt views.

   Copy Code    <Gantt
       style={ganttStyle}
       taskData={taskData}
       taskModelFields={taskModelFields}
       dependencyData={dependencyData}
       dependencyModelFields={dependencyModelFields}
       columns={columns}
       >
           <GanttDayView />
           <GanttWeekView />
           <GanttMonthView />
       </Gantt>

2. Add the columns that correspond to the sampleData array.

   Copy Code    const columns = [
           {
               field: taskModelFields.id,
               title: 'id',
               width: 70
           },
           {
               field: taskModelFields.title,
               title: 'Title',
               width: 200,
               expandable: true,
               filter: GanttTextFilter
           },
           {
               field: taskModelFields.start,
               title: 'Start',
               width: 120,
               format: '{0:MM/dd/yyyy}'
           },
           {
               field: taskModelFields.end,
               title: 'End',
               width: 120,
               format: '{0:MM/dd/yyyy}'
           }
       ];

3. Map the task model fields based on the data inside the sampleData array.

   Copy Code    const taskModelFields = {
           id: 'id',
           start: 'start',
           end: 'end',
           title: 'title',
           percentComplete: 'percentComplete',
           isRollup: 'isRollup',
           isExpanded: 'isExpanded',
           isInEdit: 'isInEdit',
           children: 'subtasks'
       };

4. To style the Gantt, 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';

5. Build and run the application by typing the following command in the root folder of your project:

   Copy Codenpm start

6. Navigate to http://localhost:3000 to see the KendoReact Gantt 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 Gantt package requires you to install the following peer dependencies in your application:

Suggested Links

• Sorting
• Filtering
• Task types
• Dependency types
• Row resize
• Flat Data
• Slots customization
• Timezones
• Globalization

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