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

Represents the Kendo UI for Vue SchedulerViewItem component. Use it in a custom view item template to change the view-specific layout of a Scheduler event, such as its size and position (see example).

Definition

Package:@progress/kendo-vue-scheduler

Properties Interface:SchedulerViewItemProps

Syntax:

vue
<SchedulerViewItem v-bind="props" :item-style="{ height: 'auto' }" />

Properties

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

The SchedulerItem applies the following default classes:

  • k-event
  • k-selected - if selected is true
  • k-event-drag-hint - if dragHint is true
  • k-scheduler-marquee - if resizeHint is true
  • k-marquee: if resizeHint is true
  • k-first: if resizeHint is true and tail is false
  • k-last: if resizeHint is true and head is false

Represents the original DataItem from which the item was created.

For more information about the data collection, refer to the Scheduler Data Binding article.

The description of the item.

dragHint?

boolean

Specifies if the SchedulerItem acts as a drag hint.

Overrides the editable prop of the Scheduler and the active view.

end

Date

The end date of the item.

The timezone name for the end date.

format?

string

Sets the format in which the SchedulerItem shows the zonedStart and zonedEnd properties.

For more information, refer to the formatDate method of the IntlService.

The group in which the Scheduler shows the item.

boolean

Specifies if the end of the item is outside the current visible range.

id?

string

Sets the id of the wrapping element of the SchedulerItem.

isAllDay

boolean

Specifies if the item lasts the whole day.

Specifies if the item is an exception to a recurrence rule.

Specifies if the item is a single occurrence of a recurring DataItem.

Overrides the default component that shows a single item. Set it to a component or to the name of a slot template.

The default component is: SchedulerItem.

The ref of the actual item.

Sets the style object of the wrapping element of the SchedulerItem.

The SchedulerItem applies the following default styles:

  • cursor: pointer
  • userSelect: none
  • --kendo-scheduler-event-color: the color resolved from the matching entry in props.group.resources whose colorField is set (requires a Kendo theme that consumes this CSS variable; see https://github.com/telerik/kendo-themes/pull/6204)
  • pointerEvents: none - if props.dragHint or props.resizeHint is set to true

onBlur?

(event: SchedulerItemFocusEvent) => void

Fires each time the element, or any of its child elements, loses focus.

Parameters:eventSchedulerItemFocusEvent

onDoubleClick?

(event: SchedulerItemMouseEvent) => void

Fires each time you double-click the element or any of its child elements.

Parameters:eventSchedulerItemMouseEvent

onKeyDown?

(event: SchedulerItemKeyboardEvent) => void

Fires each time a keydown event reaches the wrapping element.

Parameters:eventSchedulerItemKeyboardEvent

onKeyPress?

(event: SchedulerItemKeyboardEvent) => void

Fires each time a keypress event reaches the wrapping element.

Parameters:eventSchedulerItemKeyboardEvent

onKeyUp?

(event: SchedulerItemKeyboardEvent) => void

Fires each time a keyup event reaches the wrapping element.

Parameters:eventSchedulerItemKeyboardEvent

onMouseDown?

(event: SchedulerItemMouseEvent) => void

Fires each time the element, or any of its child elements, receives a mousedown event.

Parameters:eventSchedulerItemMouseEvent

onMouseEnter?

(event: SchedulerItemMouseEvent) => void

Fires each time the element, or any of its child elements, receives a mouseenter event.

Parameters:eventSchedulerItemMouseEvent

onMouseLeave?

(event: SchedulerItemMouseEvent) => void

Fires each time the element, or any of its child elements, receives a mouseleave event.

Parameters:eventSchedulerItemMouseEvent

onMouseOut?

(event: SchedulerItemMouseEvent) => void

Fires each time the element, or any of its child elements, receives a mouseout event.

Parameters:eventSchedulerItemMouseEvent

onMouseOver?

(event: SchedulerItemMouseEvent) => void

Fires each time the element, or any of its child elements, receives a mouseover event.

Parameters:eventSchedulerItemMouseEvent

onMouseUp?

(event: SchedulerItemMouseEvent) => void

Fires each time the element, or any of its child elements, receives a mouseup event.

Parameters:eventSchedulerItemMouseEvent

onRemoveClick?

(event: SchedulerItemMouseEvent) => void

Fires when you click the delete icon.

The SchedulerItem shows the delete icon only when editable or editable.remove is true.

Parameters:eventSchedulerItemMouseEvent

onResizeEndDrag?

(event: SchedulerItemDragEvent) => void

Fires each time you drag the resize handle of the item end.

The Resize feature of the SchedulerItem uses this event.

Parameters:eventSchedulerItemDragEvent

onResizePress?

(event: SchedulerItemDragEvent) => void

Fires each time any of the resize handles receives a press event.

The Resize feature of the SchedulerItem uses this event.

Parameters:eventSchedulerItemDragEvent

onResizeRelease?

(event: SchedulerItemDragEvent) => void

Fires when you release the dragged resize handle.

The Resize feature of the SchedulerItem uses this event.

Parameters:eventSchedulerItemDragEvent

onResizeStartDrag?

(event: SchedulerItemDragEvent) => void

Fires each time you drag the resize handle of the item start.

The Resize feature of the SchedulerItem uses this event.

Parameters:eventSchedulerItemDragEvent

order

number

The order of the item among its siblings.

Represents the original start of the item.

This property is being used when only a single occurrence of a recurring item is being edited.

range

Range

The range in which the Scheduler shows the item.

readonly?

boolean

Specifies if the event is read-only. When true, the SchedulerItem applies the k-readonly CSS class and sets aria-disabled to true.

Specifies if the SchedulerItem acts as a resize hint.

selected?

boolean

Sets the selected state of the SchedulerItem. When selected is true, the SchedulerItem adds the k-selected class by default.

slots

Slot[]

The collection of all slots in which the item fits.

start

Date

The start date of the item.

The timezone name for the start date.

tabIndex?

number

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

When you set it to null, the SchedulerItem does not apply a tabIndex to the element.

tail

boolean

Specifies if the start of the item is outside the current visible range.

title

string

The title of the item.

vertical?

boolean

Specifies if the SchedulerItem uses vertical orientation.

zonedEnd

ZonedDate

The end date in the provided timezone.

For more information about timezones, refer to the Scheduler Timezones article.

zonedStart

ZonedDate

The start date in the provided timezone.

For more information about timezones, refer to the Scheduler Timezones article.