SchedulerProps

Represents the props of the KendoReact Scheduler component.

ariaLabel? string

The aria-labelledby 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

children? SchedulerView[] | SchedulerView

Specify the available view components as children and the Scheduler will match the currently selected view and render it.

className? string

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

data? DataItem[]

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

date? Date

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

defaultDate? Date

Sets a default selected Date. The defaultDate property is used to specify the initial rendered date, while still remaining in an uncontrolled mode.

defaultView? string

Sets the initially selected view.

For more information refer to the Scheduler Views article.

editItem? React.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? React.ComponentType<SchedulerSlotProps>

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? React.ComponentType<SchedulerTaskProps>

Overrides the default editTask. Specifying the editTask property of a specific view will override this property. Currently, the viewTask is being used in the AgendaView only.

The default component is: SchedulerEditTask

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

editable? EditableProp | boolean

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

group? SchedulerGroup

Specifies the groups of the Scheduler.

height? number | string

Sets the height of the Scheduler.

id? string

Specifies the id of the wrapping element of the Scheduler.

item? React.ComponentType<SchedulerItemProps>

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

The default component is: SchedulerItem

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

modelFields? SchedulerModelFields

The names of the model fields from which the Scheduler will read its data (see example).

onDataChange? (event: SchedulerDataChangeEvent) => void

Called each time when 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

Called when new date is selected.

onViewChange? (args: SchedulerViewChangeEvent) => void

Called when new view is selected. (see example)

resources? SchedulerResource[]

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

Force a rtl mode. For more information refer to RTL Support

slot? React.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.

task? React.ComponentType<SchedulerTaskProps>

Overrides the default task. Specifying the task property of a specific view will override this property. Currently, the task is being used in the AgendaView only.

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 will be displayed in the Scheduler. For example, Europe/Sofia.

Defaults to Etc/UTC.

view? string

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

viewItem? React.ComponentType<SchedulerEditItemProps>

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

The default component is: SchedulerViewItem

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

viewSlot? React.ComponentType<SchedulerSlotProps>

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? React.ComponentType<SchedulerTaskProps>

Overrides the default viewTask. Specifying the viewTask property of a specific view will override this property. Currently, the viewTask is being used in the AgendaView only.

The default component is: SchedulerViewTask

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