SchedulerItemProps

Represents the props of the KendoReact SchedulerItem component.

children?

Specifies the children of the SchedulerItem.

Setting this property will override the default elements rendered by the SchedulerItem.

className?

Specifies the className attribute of the wrapping element of the SchedulerItem.

The SchedulerItem applies the following default className:

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

dataItem

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

The description of the item.

dragHint?

Specifies if the current SchedulerItem is used as a DragHint.

editable?

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

end

The end date of the item.

endTimezone

The timezone name for the end date.

format?

Specifies the format in which the zonedStart and zonedEnd properties are displayed.

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

group

Represents the current group in which the item is rendered.

head

Represents if the end of the item is outside the current visual range.

id?

Specifies the id of the wrapping element of the SchedulerItem.

isAllDay

Represents if the item durations is through the whole day.

isException

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

isRecurring

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

itemRef

Represents the ref of the actual item.

onBlur?

Called each time the element, or any of its child elements, lose focus.

onClick?

Called each time the element, or any of its child elements, is clicked.

onDoubleClick?

Called each time the element, or any of its child elements, is double-clicked.

onDrag?

Called each time the element is dragged.

This event is used by the Drag & Drop functionality of the SchedulerItem. The SchedulerItem is using the KendoReactDraggable instead of the onDrag callback.

onFocus?

Called each time the element, or any of its child elements, receive focus.

onKeyDown?

Called each time a keydown event propagates to the wrapping element.

onKeyPress?

Called each time a keypress event propagates to the wrapping element.

onKeyUp?

Called each time a keyup event propagates to the wrapping element.

onMouseDown?

Called each time the element, or any of its child elements resceives mousedown event.

onMouseEnter?

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

onMouseLeave?

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

onMouseOut?

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

onMouseOver?

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

onMouseUp?

Called each time the element, or any of its child elements resceives mouseup event.

onPress?

Called each time the element receives a press event.

This event is used by the Drag & Drop functionality of the SchedulerItem. The SchedulerItem is using the KendoReactDraggable instead of the onDragStart callback.

onRelease?

Called when the dragged element is being released.

This event is used by the Drag & Drop functionality of the SchedulerItem. The SchedulerItem is using the KendoReactDraggable instead of the onDragEnd callback.

onRemoveClick?

Called when the delete icon is clicked.

The delete icon is rendered only when props.editable or props.editable.remove is true

onResizeEndDrag?

Called each time the the resize handler responsible for the item end is being dragged.

This event is used by the Resize functionality of the SchedulerItem. The SchedulerItem is using the KendoReactDraggable instead of the onDrag callback.

onResizePress?

Called each time the any of the resize handlers receives a press event.

This event is used by the Resize functionality of the SchedulerItem. The SchedulerItem is using the KendoReactDraggable instead of the onDragStart callback.

onResizeRelease?

Called when the dragged resize handler is being released

This event is used by the Resize functionality of the SchedulerItem. The SchedulerItem is using the KendoReactDraggable instead of the onDragEnd callback.

onResizeStartDrag?

Called each time the the resize handler responsible for the item start is being dragged.

This event is used by the Resize functionality of the SchedulerItem. The SchedulerItem is using the KendoReactDraggable instead of the onDrag callback.

order

Represents the order of the item among its siblings.

originalStart

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

Represents the current range in which the item is rendered.

resizeHint?

Specifies if the current SchedulerItem is used as a ResizeHint.

selected?

Sets the selected state of the SchedulerSlot. By default the k-state-selected className is added if props.selected is true.

slots

A collection of all slots in which the current item fits.

start

The start date of the item.

startTimezone

The timezone name for the start date.

style?

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

The SchedulerItem applies the following default styles:

• cursor: pointer
• userSelect: none
• borderColor: props.color
• borderColor: props.color
• pointerEvents: none - if props.dragHint or props.resizeHint is set to true

tabIndex?

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

Providing null will not apply any tabIndex to the element.

tail

Represents if the start of the item is outside the current visual range.

title

The title of the item.

vertical?

Specifies the orientation of the SchedulerItem.

zonedEnd

Represents the end Date in the provided timezone.

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

zonedStart

Represents the start Date in the provided timezone.

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