Getting Started with the KendoReact Scheduler

This guide provides essential information about using the KendoReact Scheduler. You will learn how to install the package, add a Scheduler component to your project, style the component, and activate your license.


After completing this guide, you will be able to reproduce the following example.

Example
View Source
Edit In Stackblitz  
Change Theme:

Setting Up Your React Project

Before you install the KendoReact Scheduler, 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 Component

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

```sh
npm install --save @progress/kendo-react-scheduler @progress/kendo-react-intl @progress/kendo-react-popup @progress/kendo-react-dialogs @progress/kendo-react-dateinputs @progress/kendo-react-dropdowns @progress/kendo-react-inputs @progress/kendo-react-buttons @progress/kendo-date-math @progress/kendo-react-form @progress/kendo-licensing
```

Importing the Component

Once you install the npm package, import the Scheduler and the components that are necessary to display the day, month, and week view.

 // ES2015 module syntax
 import { Scheduler, AgendaView, TimelineView, DayView, WeekView, MonthView } from '@progress/kendo-react-scheduler';
 // CommonJS format
 const { Scheduler, AgendaView, TimelineView, DayView, WeekView, MonthView} = require('@progress/kendo-react-scheduler');

Using the Component

  1. Create an events-utc.js file that will contain the data and a predefined display date, and then import them.

       import { sampleData, displayDate } from './events-utc';
  2. Add the Scheduler component together with the AgendaView, TimelineView, DayView, WeekView, and MonthView. Pass the sampleData and displayDate that are obtained from the events-utc.js file.

         return <Scheduler data={sampleData} defaultDate={displayDate}>
         <AgendaView />
         <TimelineView />
         <DayView />
         <WeekView />
         <MonthView />
       </Scheduler>;
  3. To style the Scheduler, install and import the Default theme, which is one of the three 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 existing App.css import.

    import '@progress/kendo-theme-default/dist/all.css';
  4. Build and run the application by typing the following command in the root folder of your project:

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

Package NameDescription
react 16.8.2*Contains the functionality necessary to define React components.
react-domContains the React renderer for the web.
@progress/kendo-licensingContains the internal infrastructure related to licensing.
@progress/kendo-react-intlContains 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-react-popupContains the KendoReact Popup components.
@progress/kendo-react-dialogsContains the KendoReact Dialogs components.
@progress/kendo-react-dateinputsContains the KendoReact Date Input components.
@progress/kendo-react-dropdownsContains the KendoReact Dropdown components.
@progress/kendo-react-inputsContains the KendoReact Input components.
@progress/kendo-react-buttonsContains the KendoReact Button components.
@progress/kendo-date-mathContains the KendoReact typescript package exporting functions for Date manipulations.

Learning Resources