SchedulerProps
Represents the props of the KendoReact Scheduler component.
Definition
Package:@progress/kendo-react-scheduler
Properties
ariaLabel?
string
The aria-label attribute to be applied to the Scheduler component.
For more information, refer to the Scheduler Accessibility Compliance article.
ariaLabelledby?
string
The aria-labelledby attribute to be applied to the Scheduler component.
For more information, refer to the Scheduler Accessibility Compliance article.
Specifies the available view components as children. The Scheduler matches the currently selected view and renders it.
className?
string
Specifies the className attribute of the wrapping element of the Scheduler.
data?
any[]
Sets the data of the Scheduler component. The data is then parsed and rendered as visual Scheduler items.
date?
Date
Sets the current selected Date. The current selected date is passed to the selected view and transformed into a range.
defaultDate?
Date
Sets a default selected Date. Use the defaultDate property to specify the initial rendered date while remaining in an uncontrolled mode.
defaultView?
string
Sets the initially selected view.
For more information refer to the Scheduler Views article.
Sets the initially selected view. The available values are:
dayweekmonthagendatimeline
editable?
boolean | EditableProp
Sets if the Scheduler component is editable. The value can be either a boolean or an Object to specify different types of editing.
false
editItem?
ComponentType<SchedulerEditItemProps>
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.
editSlot?
ComponentType<SchedulerEditSlotProps>
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.
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.
eventOverview?
boolean
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.
true
footer?
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.
Specifies the groups of the Scheduler.
header?
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.
height?
string | number
Sets the height of the Scheduler.
600
id?
string
Specifies the id of the wrapping element of the 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.
Specifies the names of the model fields from which the Scheduler reads its data (see example).
onDataChange?
(event: SchedulerDataChangeEvent) => void
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.
onDateChange?
(args: SchedulerDateChangeEvent) => void
Fires when the user selects a new date.
onViewChange?
(args: SchedulerViewChangeEvent) => void
Fires when the user selects a new view. (see example).
quickCreate?
boolean
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.
true
quickCreateForm?
ComponentType<SchedulerQuickCreateFormProps>
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.
Specifies the resources of the Scheduler.
role?
string
Specifies the role attribute of the Scheduler wrapping element.
For more information, refer to the Scheduler Accessibility Compliance article.
rtl?
boolean
Forces RTL mode. For more information refer to RTL Support.
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.
style?
CSSProperties
Specifies the style object of the wrapping element of the Scheduler.
tabIndex?
number
Specifies the tabIndex attribute of the wrapping element of the Scheduler.
-1
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.
timezone?
string
Specifies the id of the timezone that the Scheduler displays.
For example, Europe/Sofia.
"Etc/UTC"
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:
dayweekmonthagendatimeline
viewItem?
ComponentType<SchedulerViewItemProps>
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.
viewSlot?
ComponentType<SchedulerViewSlotProps>
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.
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.
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.