SchedulerProps
Represents the props of the Kendo UI for Vue Scheduler component.
Definition
Package:@progress/kendo-vue-scheduler
Properties
adaptive?
boolean
Enables the adaptive (mobile) rendering of the Scheduler.
When set to true, the Scheduler renders mobile-specific classes and layout on small screens (below 1024px).
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
className?
string
Specifies the className attribute of the wrapping element of the Scheduler.
dataItems?
any[]
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.
Represents component based on the DateHeaderCellProps.
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.
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.
editItem?
any
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?
any
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?
any
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.
footer?
any
Overrides the default footer component of the Scheduler.
The default component is: Scheduler
For more information on customizing the scheduler footer, refer to the Footer Customization article.
Specifies the groups of the Scheduler.
header?
any
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.
id?
string
Specifies the id of the wrapping element of the Scheduler.
item?
any
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.
The names of the model fields from which the Scheduler will read its data (see example).
modifyInitialFormValues?
Function
Function that returns custom initial values for the fields of the form.
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)
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
slotRender?
any
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.
tabIndex?
number
Specifies the tabIndex attribute of the wrapping element of the Scheduler.
task?
any
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.
Represents component based on the TimeHeaderCellProps.
timezone?
string
Specifies the id of the timezone that will be displayed in the Scheduler.
For example, Europe/Sofia.
Defaults to Etc/UTC.
validator?
Function
Function that returns custom validator for the form.
view?
string
Sets the currently selected view. The value is matched with the name property of the view.
viewItem?
any
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.
Sets the currently visible views.
viewSlot?
any
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?
any
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.