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

Represents the props of the Kendo UI for Vue SchedulerEditItem component.

Definition

Package:@progress/kendo-vue-scheduler

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.

Overrides the default component responsible for visualizing the dragItem.

The default Component is: SchedulerDrag.

dragHint?

boolean

Specifies if the SchedulerItem acts as a drag hint.

Setting this property will force the dragItem to be in controlled state, allowing further customization.

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.

Overrides the default component responsible for visualizing the formItem.

The default Component is: SchedulerForm.

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.

Setting this property will force the formItem to be in controlled state, allowing further customization.

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

Overrides the default component responsible for the selection between occurrence and series edit.

The default Component is: SchedulerOccurrenceDialog.

onBlur?

(event: SchedulerItemFocusEvent) => void

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

Parameters:eventSchedulerItemFocusEvent

An action callback. Used to define the component behavior on blur.

Internal state change will be triggered depending on the specific action types.

Parameters:eventSchedulerItemFocusEventpropsSchedulerEditItemPropsstateSchedulerEditItemStateReturns:

SchedulerEditItemAction | SchedulerEditItemAction[]

Called whenever the current edit is canceled.

An action callback. Used to define the component behavior on cancel.

Internal state change will be triggered depending on the specific action types.

An action callback. Used to define the component behavior on click.

Internal state change will be triggered depending on the specific action types.

Parameters:eventSchedulerItemMouseEventpropsSchedulerEditItemPropsstateSchedulerEditItemStateReturns:

SchedulerEditItemAction | SchedulerEditItemAction[]

onDataAction?

(action: DataAction, event: any) => void

Called when the item has been removed or manipulated though dragging, resizing or an external form.

Parameters:actionDataActionevent?any

onDoubleClick?

(event: SchedulerItemMouseEvent) => void

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

Parameters:eventSchedulerItemMouseEvent

An action callback. Used to define the component behavior on double click.

Internal state change will be triggered depending on the specific action types.

Parameters:eventSchedulerItemMouseEventpropsSchedulerEditItemPropsstateSchedulerEditItemStateReturns:

SchedulerEditItemAction | SchedulerEditItemAction[]

An action callback. Used to define the component behavior on drag.

Internal state change will be triggered depending on the specific action types.

Parameters:eventSchedulerItemDragEventpropsSchedulerEditItemPropsstateSchedulerEditItemStateReturns:

SchedulerEditItemAction | SchedulerEditItemAction[]

Called every time the dragItem changes.

Parameters:eventSchedulerEditItemStateChangeEvent​<any>

An action callback. Used to define the component behavior on focus.

Internal state change will be triggered depending on the specific action types.

Parameters:eventSchedulerItemFocusEventpropsSchedulerEditItemPropsstateSchedulerEditItemStateReturns:

SchedulerEditItemAction | SchedulerEditItemAction[]

Called every time the formItem changes.

Parameters:eventSchedulerEditItemStateChangeEvent​<any>

Called whenever the form is submitted.

Parameters:eventSchedulerFormStateChangeEvent​<any>

An action callback. Used to define the component behavior on form submit.

Internal state change will be triggered depending on the specific action types.

Parameters:eventSchedulerFormStateChangeEvent​<any>propsSchedulerEditItemPropsstateSchedulerEditItemStateReturns:

SchedulerEditItemAction | SchedulerEditItemAction[]

onKeyDown?

(event: SchedulerItemKeyboardEvent) => void

Fires each time a keydown event reaches the wrapping element.

Parameters:eventSchedulerItemKeyboardEvent

An action callback. Used to define the component behavior on key down.

Internal state change will be triggered depending on the specific action types.

Parameters:eventSchedulerItemKeyboardEventpropsSchedulerEditItemPropsstateSchedulerEditItemStateReturns:

SchedulerEditItemAction | SchedulerEditItemAction[]

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

An action callback. Used to define the component behavior on key up.

Internal state change will be triggered depending on the specific action types.

Parameters:eventSchedulerItemKeyboardEventpropsSchedulerEditItemPropsstateSchedulerEditItemStateReturns:

SchedulerEditItemAction | SchedulerEditItemAction[]

onMouseDown?

(event: SchedulerItemMouseEvent) => void

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

Parameters:eventSchedulerItemMouseEvent

An action callback. Used to define the component behavior on mouse down.

Internal state change will be triggered depending on the specific action types.

Parameters:eventSchedulerItemMouseEventpropsSchedulerEditItemPropsstateSchedulerEditItemStateReturns:

SchedulerEditItemAction | SchedulerEditItemAction[]

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

An action callback. Used to define the component behavior on mouse up.

Internal state change will be triggered depending on the specific action types.

Parameters:eventSchedulerItemMouseEventpropsSchedulerEditItemPropsstateSchedulerEditItemStateReturns:

SchedulerEditItemAction | SchedulerEditItemAction[]

Called whenever the occurence option is selected from the OccurrenceDialog.

An action callback. Used to define the component behavior on occurrence click.

Internal state change will be triggered depending on the specific action types.

An action callback. Used to define the component behavior on press.

Internal state change will be triggered depending on the specific action types.

Parameters:eventSchedulerItemDragEventpropsSchedulerEditItemPropsstateSchedulerEditItemStateReturns:

SchedulerEditItemAction | SchedulerEditItemAction[]

An action callback. Used to define the component behavior on release.

Internal state change will be triggered depending on the specific action types.

Parameters:eventSchedulerItemDragEventpropsSchedulerEditItemPropsstateSchedulerEditItemStateReturns:

SchedulerEditItemAction | SchedulerEditItemAction[]

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

An action callback. Used to define the component behavior on remove click.

Internal state change will be triggered depending on the specific action types.

Parameters:eventSchedulerItemMouseEventpropsSchedulerEditItemPropsstateSchedulerEditItemStateReturns:

SchedulerEditItemAction | SchedulerEditItemAction[]

Called whenever the confirm option is selected from the RemoveDialog.

An action callback. Used to define the component behavior on remove confirm click.

Internal state change will be triggered depending on the specific action types.

Parameters:eventSchedulerRemoveDialogStateChangeEvent​<any>propsSchedulerEditItemPropsstateSchedulerEditItemStateReturns:

SchedulerEditItemAction | SchedulerEditItemAction[]

Called every time the removeItem changes.

Parameters:eventSchedulerEditItemStateChangeEvent​<any>

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

An action callback. Used to define the component behavior on resize end drag.

Internal state change will be triggered depending on the specific action types.

Parameters:eventSchedulerItemDragEventpropsSchedulerEditItemPropsstateSchedulerEditItemStateReturns:

SchedulerEditItemAction | SchedulerEditItemAction[]

Called every time the resize changes.

Parameters:eventSchedulerEditItemStateChangeEvent​<any>

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

An action callback. Used to define the component behavior on resize press.

Internal state change will be triggered depending on the specific action types.

Parameters:eventSchedulerItemDragEventpropsSchedulerEditItemPropsstateSchedulerEditItemStateReturns:

SchedulerEditItemAction | SchedulerEditItemAction[]

onResizeRelease?

(event: SchedulerItemDragEvent) => void

Fires when you release the dragged resize handle.

The Resize feature of the SchedulerItem uses this event.

Parameters:eventSchedulerItemDragEvent

An action callback. Used to define the component behavior on resize release.

Internal state change will be triggered depending on the specific action types.

Parameters:eventSchedulerItemDragEventpropsSchedulerEditItemPropsstateSchedulerEditItemStateReturns:

SchedulerEditItemAction | SchedulerEditItemAction[]

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

An action callback. Used to define the component behavior on resize start drag.

Internal state change will be triggered depending on the specific action types.

Parameters:eventSchedulerItemDragEventpropsSchedulerEditItemPropsstateSchedulerEditItemStateReturns:

SchedulerEditItemAction | SchedulerEditItemAction[]

Called every time the series changes.

Parameters:eventSchedulerEditItemStateChangeEvent​<boolean>

Called whenever the series option is selected from the OccurrenceDialog.

An action callback. Used to define the component behavior on series click.

Internal state change will be triggered depending on the specific action types.

Called every time the showOccurrenceDialog changes.

Parameters:eventSchedulerEditItemStateChangeEvent​<boolean>

Called every time the showRemoveDialog changes.

Parameters:eventSchedulerEditItemStateChangeEvent​<boolean>

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.

Overrides the default component responsible for visualizing the removeItem and confirming the remove action.

The default Component is: SchedulerRemoveDialog.

Setting this property will force the removeItem to be in controlled state, allowing further customization.

Specifies the DataItem which should be removed from the data set. The removeItem is passed as property to the removeDialog and occurrenceDialog component;

Overrides the default component responsible for visualizing the resizeItem.

The default Component is: SchedulerResize.

Specifies if the SchedulerItem acts as a resize hint.

Setting this property will force the resizeItem to be in controlled state, allowing further customization.

selected?

boolean

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

series?

boolean

Indicates if the editing should be applied to the whole series or to a single occurrence when the item is recurring.

By default, the series prop is set to null and additional selection is done through the occurrence dialog. If set ot either true or false:

  • true — indicates that the editing should always be applied to the whole series
  • false — indicates that the editing should always be applied to a single occurrence.

Setting this property will force the showOccurrenceDialog to be in controlled state, allowing further control over the display of the occurrenceDialog component.

Setting this property will force the showRemoveDialog to be in controlled state, allowing further control over the display of the removeDialog component.

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.

Overrides the default component responsible for positioning the item inside the view.

The default Component is: SchedulerViewItem.

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.