SchedulerEditTaskProps

Represents the props of the KendoReact SchedulerEditTask component.

NameTypeDefaultDescription

children?

React.ReactNode

Specifies the children of the SchedulerTask.

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

className?

string

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

The SchedulerSlot applies the following default className:

  • k-task

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.

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.

group

Group

Represents the current group in which the item is rendered.

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 SchedulerTask.

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.

isRecurring

boolean

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

itemRef

React.RefObject<undefined>

Represents the ref of the actual item.

occurrenceDialog?

React.ComponentType<SchedulerOccurrenceDialogProps>

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

The default Component is: SchedulerOccurrenceDialog.

onDataAction?

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

Called when the item has been removed.

onRemoveClick?

(event: SchedulerTaskMouseEvent) => void

Called when the delete icon is clicked.

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

onRemoveItemChange?

(event: any) => void

Called every time the removeItem changes.

onShowOccurrenceDialogChange?

(event: any) => void

Called every time the showOccurrenceDialog changes.

onShowRemoveDialogChange?

(event: any) => void

Called every time the showRemoveDialog changes.

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.

removeDialog?

React.ComponentType<SchedulerRemoveDialogProps>

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 component;

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[]

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?

React.CSSProperties

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

tabIndex?

"null" | number

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

tail

boolean

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

task?

React.ComponentType<SchedulerTaskProps>

Overrides the default component responsible for visualizing a single task.

The default Component is: SchedulerTask.

title

"null" | string

The title of the item.

viewTask?

React.ComponentType<SchedulerViewTaskProps>

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

The default Component is: SchedulerViewTask.

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.