AgendaViewProps

Represents the properties of the KendoReact AgendaView Component.

NameTypeDefaultDescription

className?

string

Sets a custom className to the wrapping element of the AgendaView.

dateRange?

DateRange | (args: SchedulerViewDateRangeArgs) => DateRange

Overrides the dateRange calculated by the Scheduler component.

If a function is passed, an object of type SchedulerViewDateRangeArgs will be passed.

editable?

EditableProp

Overrides the general editable prop of the Scheduler for the specified view only.

editSlot?

React.ComponentType<SchedulerEditSlotProps>

Overrides the editSlot prop of the Scheduler for the specified view only.

editTask?

React.ComponentType<SchedulerTaskProps>

Overrides the editTask prop of the Scheduler for the specified view only.

id?

string

Sets a custom id to the wrapping element of the AgendaView.

name?

string

The name property is used by the Scheduler to match which view is selected. Every view has a default name.

numberOfDays?

number

Specifies the number of days that the view will render. Defaults to 7.

onDataAction?

(action: DataAction) => void

Called every time any of the SchedulerView Slots or Items trigger a data action, through editing, deleting or creating new DataItem.

selectedDateFormat?

string

The long-date format for displaying the selected date in the Scheduler toolbar. Defaults to {0:D} - {1:D} (more information)

selectedShortDateFormat?

string

The short-date format for displaying the selected date in the Scheduler toolbar. Defaults to {0:d} - {1-d} (more information)

slot?

React.ComponentType<SchedulerSlotProps>

Overrides the slot prop of the Scheduler for the specified view only.

step?

number

The number of steps (in days) to change, when using the back and forwards buttons in the toolbar navigation. The default value is 7 days.

style?

React.CSSProperties

Sets a custom style property to the wrapping element of the AgendaView.

task?

React.ComponentType<SchedulerTaskProps>

Overrides the task prop of the Scheduler for the specified view only.

title?

string | (localization: LocalizationService) => string

The title to be displayed in the view selection list in the Toolbar. If a function is passed, it will receive a [LocalizationService]({ slug api_intl_localizationservice }) as an argument

viewSlot?

React.ComponentType<SchedulerViewSlotProps>

Overrides the viewSlot prop of the Scheduler for the specified view only.

viewTask?

React.ComponentType<SchedulerTaskProps>

Overrides the viewTask prop of the Scheduler for the specified view only.