SchedulerItemProps
Represents the props of the KendoReact SchedulerItem component.
Definition
Package:@progress/kendo-react-scheduler
Properties
children?
ReactNode
Specifies the children of the SchedulerItem.
Setting this property overrides the default elements rendered by the SchedulerItem.
className?
string
Specifies the className attribute of the wrapping element of the SchedulerItem.
The SchedulerItem applies the following default className:
k-eventk-selected- ifprops.selectedis set totruek-event-drag-hint- ifprops.dragHintis set totruek-scheduler-marquee- ifprops.resizeHintis set totruek-marquee: ifprops.resizeHintis set totruek-first: ifprops.resizeHintis set totrueandprops.tailis set tofalsek-last: ifprops.resizeHintis set totrueandprops.headis set tofalse
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
null | string
The description of the item.
dragHint?
boolean
Specifies if the current SchedulerItem is used as a DragHint.
editable?
boolean | EditableProp
Overrides the editable prop of the Scheduler and the active view.
end
Date
The end date of the item.
endTimezone
null | string
The timezone name for the end date.
format?
string
Specifies the format in which the zonedStart and zonedEnd properties are displayed.
For more information, refer to the formatDate method of the IntlService.
head
boolean
Represents if the end of the item is outside the current visual range.
id?
string
Specifies the id of the wrapping element of the SchedulerItem.
isAllDay
boolean
Represents if the item durations is through the whole day.
isException
boolean
Represents if the item is an exception to a recurrence rule.
isLast?
boolean
Returns true if it is the last item rendered in the current view.
isRecurring
boolean
Represents if the item is a single occurrence of a recurring DataItem.
itemRef
RefObject<null | SchedulerItemHandle | SchedulerTaskHandle>
Represents the ref of the actual item.
onBlur?
(event: SchedulerItemFocusEvent) => void
Fires each time the element, or any of its child elements, lose focus.
onClick?
(event: SchedulerItemMouseEvent) => void
Fires each time the element, or any of its child elements, is clicked.
onDoubleClick?
(event: SchedulerItemMouseEvent) => void
Fires each time the element, or any of its child elements, is double-clicked.
onDrag?
(event: SchedulerItemDragEvent) => void
Fires each time the element is dragged.
This event is used by the Drag & Drop functionality of the SchedulerItem.
The SchedulerItem uses the KendoReactDraggable instead of the onDrag callback.
onFocus?
(event: SchedulerItemFocusEvent) => void
Fires each time the element, or any of its child elements, receive focus.
onKeyDown?
(event: SchedulerItemKeyboardEvent) => void
Fires each time a keydown event propagates to the wrapping element.
onKeyPress?
(event: SchedulerItemKeyboardEvent) => void
Fires each time a keypress event propagates to the wrapping element.
onKeyUp?
(event: SchedulerItemKeyboardEvent) => void
Fires each time a keyup event propagates to the wrapping element.
onMouseDown?
(event: SchedulerItemMouseEvent) => void
Fires each time the element, or any of its child elements, receives a mousedown event.
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.
onPress?
(event: SchedulerItemDragEvent) => void
Fires each time the element receives a press event.
This event is used by the Drag & Drop functionality of the SchedulerItem.
The SchedulerItem uses the KendoReactDraggable instead of the onDragStart callback.
onRelease?
(event: SchedulerItemDragEvent) => void
Fires when you release the dragged element.
This event is used by the Drag & Drop functionality of the SchedulerItem.
The SchedulerItem uses the KendoReactDraggable instead of the onDragEnd callback.
onRemoveClick?
(event: SchedulerItemMouseEvent) => void
Fires when you click the delete icon.
The delete icon renders only when props.editable or props.editable.remove is true.
onResizeEndDrag?
(event: SchedulerItemDragEvent) => void
Fires each time the resize handler responsible for the item end is being dragged.
This event is used by the Resize functionality of the SchedulerItem.
The SchedulerItem uses the KendoReactDraggable instead of the onDrag callback.
onResizePress?
(event: SchedulerItemDragEvent) => void
Fires each time any of the resize handlers receives a press event.
This event is used by the Resize functionality of the SchedulerItem.
The SchedulerItem uses the KendoReactDraggable instead of the onDragStart callback.
onResizeRelease?
(event: SchedulerItemDragEvent) => void
Fires when you release the dragged resize handler.
This event is used by the Resize functionality of the SchedulerItem.
The SchedulerItem uses the KendoReactDraggable instead of the onDragEnd callback.
onResizeStartDrag?
(event: SchedulerItemDragEvent) => void
Fires each time the resize handler responsible for the item start is being dragged.
This event is used by the Resize functionality of the SchedulerItem.
The SchedulerItem uses the KendoReactDraggable instead of the onDrag callback.
order
null | number
Represents the order of the item among its siblings.
originalStart
null | 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
Represents the current range in which the item is rendered.
resizeHint?
boolean
Specifies if the current SchedulerItem is used as a ResizeHint.
selected?
boolean
Sets the selected state of the SchedulerItem. By default, the k-selected className is added if props.selected is true.
slots
Slot[]
A collection of all slots in which the current item fits.
start
Date
The start date of the item.
startTimezone
null | string
The timezone name for the start date.
style?
CSSProperties
Specifies the style object of the wrapping element of the SchedulerItem.
The SchedulerItem applies the following default styles:
cursor:pointeruserSelect:noneborderColor:props.colorborderColor:props.colorpointerEvents:none- ifprops.dragHintorprops.resizeHintis set totrue
tabIndex?
null | number
Specifies the tabIndex attribute of the wrapping element of the SchedulerItem.
Providing null does not apply any tabIndex to the element.
tail
boolean
Represents if the start of the item is outside the current visual range.
title
null | string
The title of the item.
vertical?
boolean
Specifies the orientation of the SchedulerItem.
zonedEnd
ZonedDate
Represents the end Date in the provided timezone.
For more information about timezones, refer to the Scheduler TImezones article.
zonedStart
ZonedDate
Represents the start Date in the provided timezone.
For more information about timezones, refer to the Scheduler TImezones article.