New to KendoReact? Start a free 30-day trial

Represents the props of the KendoReact Scheduler component.

Definition

Package:@progress/kendo-react-scheduler

Properties

The aria-label attribute to be applied to the Scheduler component.

For more information, refer to the Scheduler Accessibility Compliance article.

Example:
jsx
<Scheduler ariaLabel="Scheduler component" />

The aria-labelledby attribute to be applied to the Scheduler component.

For more information, refer to the Scheduler Accessibility Compliance article.

Example:
jsx
<Scheduler ariaLabelledby="scheduler-label" />

Specifies the available view components as children. The Scheduler matches the currently selected view and renders it.

Example:
jsx
<Scheduler>
  <DayView />
  <WeekView />
</Scheduler>

Specifies the className attribute of the wrapping element of the Scheduler.

Example:
jsx
<Scheduler className="custom-scheduler" />

data?

any[]

Sets the data of the Scheduler component. The data is then parsed and rendered as visual Scheduler items.

Example:
jsx
const data = [{ id: 1, title: 'Event', start: new Date(), end: new Date() }];
<Scheduler data={data} />

date?

Date

Sets the current selected Date. The current selected date is passed to the selected view and transformed into a range.

Example:
jsx
<Scheduler date={new Date()} />

Sets a default selected Date. Use the defaultDate property to specify the initial rendered date while remaining in an uncontrolled mode.

Example:
jsx
<Scheduler defaultDate={new Date()} />

Sets the initially selected view.

For more information refer to the Scheduler Views article.

Sets the initially selected view. The available values are:

  • day
  • week
  • month
  • agenda
  • timeline
Example:
jsx
<Scheduler defaultView="week" />

Sets if the Scheduler component is editable. The value can be either a boolean or an Object to specify different types of editing.

Default:

false

Example:
jsx
<Scheduler editable={true} />

Overrides the default editItem. Specifying the editItem property of a specific view will override this property.

The default component is: SchedulerEditItem.

For more information on customizing the scheduler items, refer to the Item Customization article.

Example:
jsx
const CustomEditItem = (props) => <div>{props.title}</div>;
<Scheduler editItem={CustomEditItem} />

Overrides the default editSlot component. Specifying the editSlot property of a specific view will override this property.

The default component is: SchedulerEditSlot.

For more information on customizing the scheduler slots, refer to the Slot Customization article.

Example:
jsx
const CustomEditSlot = (props) => <div>{props.title}</div>;
<Scheduler editSlot={CustomEditSlot} />

editTask?

ComponentType​<SchedulerTaskProps>

Overrides the default editTask. Specifying the editTask property of a specific view will override this property. Currently, only the AgendaView uses the editTask.

The default component is: SchedulerEditTask.

For more information on customizing the scheduler tasks, refer to the Task Customization article.

Example:
jsx
const CustomEditTask = (props) => <div>{props.title}</div>;
<Scheduler editTask={CustomEditTask} />

Enables the event overview popover that opens when the user clicks/taps an appointment (or presses Enter on a focused appointment).

The popover shows the event details together with contextual Edit and Delete actions before the edit dialog opens. Recurring events expose Edit and Delete as DropDownButtons offering this occurrence and the series. Read-only events show no actions.

When set to false, clicking an appointment keeps its existing behavior and no popover is shown. Double-clicking an appointment always opens the full editor regardless of this setting.

Default:

true

Example:
jsx
<Scheduler editable={true} eventOverview={false} />

ComponentType​<SchedulerFooterProps>

Overrides the default footer component of the Scheduler.

The default component is: SchedulerFooter.

For more information on customizing the scheduler footer, refer to the Footer Customization article.

Example:
jsx
const CustomFooter = (props) => <div>Custom Footer</div>;
<Scheduler footer={CustomFooter} />

Specifies the groups of the Scheduler.

Example:
jsx
const group = { resources: ['Rooms'], orientation: 'horizontal' };
<Scheduler group={group} />

ComponentType​<SchedulerHeaderProps>

Overrides the default header component of the Scheduler.

The default component is: SchedulerHeader.

For more information on customizing the scheduler header, refer to the Header Customization article.

Example:
jsx
const CustomHeader = (props) => <div>Custom Header</div>;
<Scheduler header={CustomHeader} />

height?

string | number

Sets the height of the Scheduler.

Default:

600

Example:
jsx
<Scheduler height={600} />

id?

string

Specifies the id of the wrapping element of the Scheduler.

Example:
jsx
<Scheduler id="my-scheduler" />

item?

ComponentType​<SchedulerItemProps>

Overrides the default item. If you specify the item property of a specific view, it overrides this property.

The default component is: SchedulerItem.

For more information on customizing the scheduler items, refer to the Item Customization article.

Example:
jsx
const CustomItem = (props) => <div>{props.title}</div>;
<Scheduler item={CustomItem} />

Specifies the names of the model fields from which the Scheduler reads its data (see example).

Example:
jsx
const modelFields = { id: 'TaskID', start: 'Start', end: 'End' };
<Scheduler modelFields={modelFields} />

Fires each time editing occurs. To enable editing set the editable property to true or an EditableProp.

For more information refer to the Scheduler Editing article.

Parameters:eventSchedulerDataChangeEvent
Example:
jsx
const handleDataChange = (event) => console.log(event);
<Scheduler onDataChange={handleDataChange} />

Fires when the user selects a new date.

Parameters:argsSchedulerDateChangeEvent
Example:
jsx
const handleDateChange = (args) => console.log(args.value);
<Scheduler onDateChange={handleDateChange} />

Fires when the user selects a new view. (see example).

Parameters:argsSchedulerViewChangeEvent
Example:
jsx
const handleViewChange = (args) => console.log(args.value);
<Scheduler onViewChange={handleViewChange} />

Enables the quick-create popover that opens when the user single-clicks an empty Scheduler slot (or presses Enter on a focused slot).

The popover allows entering a title and saving the event, opening the full editor through More options, or canceling.

This setting has no effect unless editing is enabled through the editable property (editable={true} or editable.add). Double-clicking a slot always opens the full editor regardless of this setting.

Default:

true

Example:
jsx
<Scheduler editable={true} quickCreate={false} />

Overrides the default component rendered inside the quick-create popover. Supports a validator for the editable title field, similar to the form prop.

The default component is: SchedulerQuickCreateForm.

Example:
jsx
const CustomQuickCreateForm = (props) => <SchedulerQuickCreateForm {...props} validator={validator} />;
<Scheduler quickCreate={true} quickCreateForm={CustomQuickCreateForm} />

Specifies the resources of the Scheduler.

Example:
jsx
const resources = [{ name: 'Rooms', data: [{ text: 'Room 1', value: 1 }] }];
<Scheduler resources={resources} />

role?

string

Specifies the role attribute of the Scheduler wrapping element.

For more information, refer to the Scheduler Accessibility Compliance article.

Example:
jsx
<Scheduler role="application" />

rtl?

boolean

Forces RTL mode. For more information refer to RTL Support.

Example:
jsx
<Scheduler rtl={true} />

slot?

ComponentType​<SchedulerSlotProps>

Overrides the default slot component. Specifying the slot property of a specific view will override this property.

The default component is: SchedulerSlot.

For more information on customizing the scheduler slots, refer to the Slot Customization article.

Example:
jsx
const CustomSlot = (props) => <div>{props.title}</div>;
<Scheduler slot={CustomSlot} />

style?

CSSProperties

Specifies the style object of the wrapping element of the Scheduler.

Example:
jsx
<Scheduler style={{ height: '500px' }} />

tabIndex?

number

Specifies the tabIndex attribute of the wrapping element of the Scheduler.

Default:

-1

Example:
jsx
<Scheduler tabIndex={0} />

task?

ComponentType​<SchedulerTaskProps>

Overrides the default task. Specifying the task property of a specific view will override this property. Currently, only the AgendaView uses the task.

The default component is: SchedulerTask.

For more information on customizing the scheduler tasks, refer to the Task Customization article.

Example:
jsx
const CustomTask = (props) => <div>{props.title}</div>;
<Scheduler task={CustomTask} />

timezone?

string

Specifies the id of the timezone that the Scheduler displays. For example, Europe/Sofia.

Default:

"Etc/UTC"

Example:
jsx
<Scheduler timezone="Europe/Sofia" />

view?

string

Sets the currently selected view. The value is matched with the name property of the view.

Sets the initially selected view. The available values are:

  • day
  • week
  • month
  • agenda
  • timeline
Example:
jsx
<Scheduler view="day" />

Overrides the default viewItem. If you specify the viewItem property of a specific view, it overrides this property.

The default component is: SchedulerViewItem.

For more information on customizing the scheduler items, refer to the Item Customization article.

Example:
jsx
const CustomViewItem = (props) => <div>{props.title}</div>;
<Scheduler viewItem={CustomViewItem} />

Overrides the default viewSlot component. Specifying the viewSlot property of a specific view will override this property.

The default component is: SchedulerViewSlot.

For more information on customizing the scheduler slots, refer to the Slot Customization article.

Example:
jsx
const CustomViewSlot = (props) => <div>{props.title}</div>;
<Scheduler viewSlot={CustomViewSlot} />

viewTask?

ComponentType​<SchedulerTaskProps>

Overrides the default viewTask. Specifying the viewTask property of a specific view will override this property. Currently, only the AgendaView uses the viewTask.

The default component is: SchedulerViewTask.

For more information on customizing the scheduler tasks, refer to the Task Customization article.

Example:
jsx
const CustomViewTask = (props) => <div>{props.title}</div>;
<Scheduler viewTask={CustomViewTask} />

webMcp?

boolean | WebMcpProps

Enables browser-native AI agent tools via Web MCP (Chrome 146+).

Pass true for defaults or an object for fine-grained control. AI agents are multilingual — dataName accepts any language.

Example:
tsx
// Boolean: generic "scheduler" label
<Scheduler webMcp data={events} onDataChange={handleDataChange} />

// Config object: explicit name
<Scheduler webMcp={{ dataName: 'appointments' }} data={events} onDataChange={handleDataChange} />