SchedulerEditItemProps
Represents the props of the Kendo UI for Vue SchedulerEditItem component.
Definition
Package:@progress/kendo-vue-scheduler
Properties
className?
string
Sets a CSS class on the wrapping element of the SchedulerItem.
The SchedulerItem applies the following default classes:
k-eventk-selected- ifselectedistruek-event-drag-hint- ifdragHintistruek-scheduler-marquee- ifresizeHintistruek-marquee: ifresizeHintistruek-first: ifresizeHintistrueandtailisfalsek-last: ifresizeHintistrueandheadisfalse
dataItem
any
Represents the original DataItem from which the item was created.
For more information about the data collection, refer to the Scheduler Data Binding article.
description
string
The description of the item.
drag?
any
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.
dragItem?
any
Setting this property will force the dragItem to be in controlled state, allowing further customization.
editable?
boolean | EditableProp
Overrides the editable prop of the Scheduler and the active view.
end
Date
The end date of the item.
endTimezone
string
The timezone name for the end date.
form?
any
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.
formItem?
any
Setting this property will force the formItem to be in controlled state, allowing further customization.
head
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.
isException
boolean
Specifies if the item is an exception to a recurrence rule.
isRecurring
boolean
Specifies if the item is a single occurrence of a recurring DataItem.
item?
any
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.
itemRef?
any
The ref of the actual item.
itemStyle?
any
Sets the style object of the wrapping element of the SchedulerItem.
The SchedulerItem applies the following default styles:
cursor:pointeruserSelect:none--kendo-scheduler-event-color: the color resolved from the matching entry inprops.group.resourceswhosecolorFieldis set (requires a Kendo theme that consumes this CSS variable; see https://github.com/telerik/kendo-themes/pull/6204)pointerEvents:none- ifprops.dragHintorprops.resizeHintis set totrue
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.
An action callback. Used to define the component behavior on blur.
Internal state change will be triggered depending on the specific action types.
onCancel?
(event: SchedulerFormStateChangeEvent<null> | SchedulerOccurrenceDialogStateChangeEvent<null>) => void
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.
onDataAction?
(action: DataAction, event: any) => void
Called when the item has been removed or manipulated though dragging, resizing or an external form.
onDoubleClick?
(event: SchedulerItemMouseEvent) => void
Fires each time you double-click the element or any of its child elements.
An action callback. Used to define the component behavior on double click.
Internal state change will be triggered depending on the specific action types.
An action callback. Used to define the component behavior on drag.
Internal state change will be triggered depending on the specific action types.
onDragItemChange?
(event: SchedulerEditItemStateChangeEvent<any>) => void
Called every time the dragItem changes.
An action callback. Used to define the component behavior on focus.
Internal state change will be triggered depending on the specific action types.
onFormItemChange?
(event: SchedulerEditItemStateChangeEvent<any>) => void
Called every time the formItem changes.
onFormSubmit?
(event: SchedulerFormStateChangeEvent<any>) => void
Called whenever the form is submitted.
An action callback. Used to define the component behavior on form submit.
Internal state change will be triggered depending on the specific action types.
onKeyDown?
(event: SchedulerItemKeyboardEvent) => void
Fires each time a keydown event reaches the wrapping element.
An action callback. Used to define the component behavior on key down.
Internal state change will be triggered depending on the specific action types.
onKeyPress?
(event: SchedulerItemKeyboardEvent) => void
Fires each time a keypress event reaches the wrapping element.
onKeyUp?
(event: SchedulerItemKeyboardEvent) => void
Fires each time a keyup event reaches the wrapping element.
An action callback. Used to define the component behavior on key up.
Internal state change will be triggered depending on the specific action types.
onMouseDown?
(event: SchedulerItemMouseEvent) => void
Fires each time the element, or any of its child elements, receives a mousedown event.
An action callback. Used to define the component behavior on mouse down.
Internal state change will be triggered depending on the specific action types.
onMouseEnter?
(event: SchedulerItemMouseEvent) => void
Fires each time the element, or any of its child elements, receives a mouseenter event.
onMouseLeave?
(event: SchedulerItemMouseEvent) => void
Fires each time the element, or any of its child elements, receives a mouseleave event.
onMouseOut?
(event: SchedulerItemMouseEvent) => void
Fires each time the element, or any of its child elements, receives a mouseout event.
onMouseOver?
(event: SchedulerItemMouseEvent) => void
Fires each time the element, or any of its child elements, receives a mouseover event.
onMouseUp?
(event: SchedulerItemMouseEvent) => void
Fires each time the element, or any of its child elements, receives a mouseup event.
An action callback. Used to define the component behavior on mouse up.
Internal state change will be triggered depending on the specific action types.
onOccurrenceClick?
(event: SchedulerOccurrenceDialogStateChangeEvent<any>) => void
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.
An action callback. Used to define the component behavior on release.
Internal state change will be triggered depending on the specific action types.
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.
An action callback. Used to define the component behavior on remove click.
Internal state change will be triggered depending on the specific action types.
onRemoveConfirm?
(event: SchedulerRemoveDialogStateChangeEvent<any>) => void
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.
onRemoveItemChange?
(event: SchedulerEditItemStateChangeEvent<any>) => void
Called every time the removeItem changes.
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.
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.
onResizeItemChange?
(event: SchedulerEditItemStateChangeEvent<any>) => void
Called every time the resize changes.
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.
An action callback. Used to define the component behavior on resize press.
Internal state change will be triggered depending on the specific action types.
onResizeRelease?
(event: SchedulerItemDragEvent) => void
Fires when you release the dragged resize handle.
The Resize feature of the SchedulerItem uses this event.
An action callback. Used to define the component behavior on resize release.
Internal state change will be triggered depending on the specific action types.
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.
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.
onSeriesChange?
(event: SchedulerEditItemStateChangeEvent<boolean>) => void
Called every time the series changes.
onSeriesClick?
(event: SchedulerOccurrenceDialogStateChangeEvent<any>) => void
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.
onShowOccurrenceDialogChange?
(event: SchedulerEditItemStateChangeEvent<boolean>) => void
Called every time the showOccurrenceDialog changes.
onShowRemoveDialogChange?
(event: SchedulerEditItemStateChangeEvent<boolean>) => void
Called every time the showRemoveDialog changes.
order
number
The order of the item among its siblings.
originalStart
Date
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.
removeItem?
any
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;
resize?
any
Overrides the default component responsible for visualizing the resizeItem.
The default Component is: SchedulerResize.
resizeHint?
boolean
Specifies if the SchedulerItem acts as a resize hint.
resizeItem?
any
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 wholeseriesfalse— indicates that the editing should always be applied to a singleoccurrence.
showOccurrenceDialog?
boolean
Setting this property will force the showOccurrenceDialog to be in controlled state, allowing further control over the display of the occurrenceDialog component.
showRemoveDialog?
boolean
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.
startTimezone
string
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.
viewItem?
any
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.