New to Kendo UI for Vue? Start a free 30-day trial

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 you set it to true, the Scheduler uses mobile-specific classes and layout on small screens (below 1024px).

Default:

true

Sets the aria-label attribute of the Scheduler.

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

Sets the aria-labelledby attribute of the Scheduler. Pass the id of the element that labels the Scheduler.

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

Sets a CSS class on the wrapping element of the Scheduler.

Sets the data of the Scheduler. The Scheduler parses the data and shows it as Scheduler items.

Default:

[]

date?

Date

Sets the selected Date. The Scheduler passes the selected date to the selected view, which turns it into a range.

Overrides the default date header cell. Set it to a component or to the name of a slot template. The template receives the DateHeaderCellProps.

Sets the initially selected Date. Use defaultDate to set the first date that the Scheduler shows, while the Scheduler stays in uncontrolled mode.

Default:

new Date()

Sets the initially selected view.

For more information, refer to the Scheduler Views article.

The available values are:

  • day
  • week
  • month
  • agenda
  • timeline

Specifies if you can edit the Scheduler. Set it to a boolean or to an object that enables different types of editing.

Default:

false

Overrides the default edit item. Set it to a component or to the name of a slot template. The editItem property of a specific view overrides this property.

The default component is: SchedulerEditItem.

For more information on how to customize the Scheduler items, refer to the Item Customization article.

Overrides the default edit slot. Set it to a component or to the name of a slot template. The editSlot property of a specific view overrides this property.

The default component is: SchedulerEditSlot.

For more information on how to customize the Scheduler slots, refer to the Slot Customization article.

Overrides the default edit task. Set it to a component or to the name of a slot template. The editTask property of a specific view overrides this property. Only the AgendaView uses the editTask.

The default component is: SchedulerEditTask.

For more information on how to customize the Scheduler tasks, refer to the Task Customization article.

Specifies whether clicking an event or pressing Enter opens its overview popover. Double-clicking continues to open the full editor.

Default:

true

Overrides the default footer of the Scheduler. Set it to a component or to the name of a slot template.

The default component is: SchedulerFooter.

For more information on how to customize the Scheduler footer, refer to the Footer Customization article.

Sets the groups of the Scheduler.

Overrides the default header of the Scheduler. Set it to a component or to the name of a slot template.

The default component is: SchedulerHeader.

For more information on how to customize the Scheduler header, refer to the Header Customization article.

height?

string | number

Sets the height of the Scheduler.

Default:

600

id?

string

Sets the id attribute of the wrapping element of the Scheduler.

Overrides the default item. Set it to a component or to the name of a slot template. The item property of a specific view overrides this property.

The default component is: SchedulerItem.

For more information on how to customize the Scheduler items, refer to the Item Customization article.

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

Sets a function that returns custom initial values for the fields of the edit form.

Default:

(i: any) => i

Fires each time you edit the data. To enable editing, set the editable property to true or to an EditableProp object.

For more information, refer to the Scheduler Editing article.

Parameters:eventSchedulerDataChangeEvent

Fires when you select a new date.

Fires when you select a new view (see example).

Enables a title popover when an empty slot is clicked or a focused slot receives Enter. Requires editable.add. Double-clicking always opens the full editor.

Default:

true

Example:
vue
<Scheduler :quick-create="false" />

quickCreateForm?

string | Component​<SchedulerQuickCreateFormProps> | (createElement: (type: K, children: RawChildren) => VNode, defaultRendering: VNode​<RendererNode, RendererElement, { [key: string]: any }>, props: SchedulerQuickCreateFormProps) => VNodeChild

Overrides the default quick-create form. Accepts a component, render function, or named slot. Use SchedulerQuickCreateForm with a custom validator to validate the title.

Example:
vue
<Scheduler :quick-create-form="'quickForm'" />

Sets the resources of the Scheduler.

role?

string

Sets the role attribute of the wrapping element of the Scheduler. When you do not set it, the Scheduler uses the application role.

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

rtl?

boolean

Forces the right-to-left (rtl) mode. For more information, refer to RTL Support.

Overrides the default slot. Set it to a component or to the name of a slot template. The slot property of a specific view overrides this property.

The default component is: SchedulerSlot.

For more information on how to customize the Scheduler slots, refer to the Slot Customization article.

tabIndex?

number

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

Default:

-1

Overrides the default task. Set it to a component or to the name of a slot template. The task property of a specific view overrides this property. Only the AgendaView uses the task.

The default component is: SchedulerTask.

For more information on how to customize the Scheduler tasks, refer to the Task Customization article.

Overrides the default time header cell. Set it to a component or to the name of a slot template. The template receives the TimeHeaderCellProps.

timezone?

string

Sets the id of the timezone that the Scheduler shows. For example, Europe/Sofia.

Defaults to Etc/UTC.

validator?

Function

Sets a function that returns a custom validator for the edit form.

Default:

() => ({})

view?

string

Sets the selected view. The Scheduler matches the value with the name property of each view.

Overrides the default view item. Set it to a component or to the name of a slot template. The viewItem property of a specific view overrides this property.

The default component is: SchedulerViewItem.

For more information on how to customize the Scheduler items, refer to the Item Customization article.

Sets the views that the Scheduler shows.

Default:

[]

Overrides the default view slot. Set it to a component or to the name of a slot template. The viewSlot property of a specific view overrides this property.

The default component is: SchedulerViewSlot.

For more information on how to customize the Scheduler slots, refer to the Slot Customization article.

Overrides the default view task. Set it to a component or to the name of a slot template. The viewTask property of a specific view overrides this property. Only the AgendaView uses the viewTask.

The default component is: SchedulerViewTask.

For more information on how to customize the Scheduler tasks, refer to the Task Customization article.