New to KendoReactStart a free 30-day trial

CalendarProps

Interface

Represents the props of the KendoReact Calendar component. The generic argument is passed to the onChange property and is used as a target in the CalendarChangeEvent interface.

Definition

Package:@progress/kendo-react-dateinputs

Properties

Identifies the element(s) which will describe the component, similar to HTML aria-describedby attribute. For example, these elements could contain error or hint messages.

Identifies the element(s) which will label the component.

Defines the bottommost view to which the user can navigate.

cell?

ComponentType​<CalendarCellProps>

Enables the customization or the override of the default Calendar cell. (see example).

Sets the className of the Calendar.

Sets the default active view of the Calendar. If not set, the Calendar will display the month view.

defaultValue?

null | Date

Sets the default value of the Calendar.

disabled?

boolean

Determines whether the Calendar is disabled. (see example).

Sets the initial focused date of the Calendar.

ComponentType​<CalendarHeaderProps>

Enables the customization or the override of the default header in the Calendar. (see example).

Enables the customization or the override of the default header title in the Calendar. (see example).

id?

string

Sets the id of the Calendar.

max?

Date

Sets the maximum allowed date of the Calendar. Defaults to 2099-12-31. (see example).

min?

Date

Sets the minimum allowed date of the Calendar. Defaults to 1900-1-1. (see example).

Determines if the navigation sidebar will be displayed.

Enables the customization or the override of the default navigation item in the Calendar. (see example).

onBlur?

(event: FocusEvent​<any, Element>) => void

Fires each time the Calendar is blurred.

Parameters:eventFocusEvent​<any, Element>

onChange?

(event: CalendarChangeEvent​<T>) => void

An event that is called after the value of the Calendar has changed.

Parameters:eventCalendarChangeEvent​<T>

onFocus?

(event: FocusEvent​<any, Element>) => void

Fires each time the Calendar is focused.

Parameters:eventFocusEvent​<any, Element>

Displays the days that fall out of the current month.

Deprecated

Toggles the smooth scroll animation on navigation item click. By default, the animation is enabled in React 17.

tabIndex?

number

Sets the tabIndex property of the Calendar.

Defines the topmost view to which the user can navigate.

value?

null | Date

Sets the value of the Calendar.

webMcp?

boolean | WebMcpProps

Enables Web MCP tool registration for this component. Requires a parent WebMcpProvider from @progress/kendo-react-webmcp.

Enables the customization or the override of the default week-column cell in the Calendar. (see example).

Specifies the possible format options for the displayed Calendar week days' names.

Default:

short *

Determines if the week number column will be displayed.