CalendarBaseProps

Props

The following table outlines the props for the CalendarBaseProps:

NameTypeDefaultDescription
cellTemplate
((props: CalendarCellProps) => node)
-

Specifies a custom template for rendering the content of each calendar cell. Can be a React node or a function that returns a React node.

depth
CalendarView.Month

Sets the most granular view the user can navigate down to. For example, a depth of Year prevents navigation to the Month view.

disableFutureDays
boolean
false

When true, disables all dates in the future relative to the current day.

disableOtherMonthNavigation
boolean
false

Prevents navigation when clicking on dates from other months in month view

disablePastDays
boolean
false

When true, disables all dates in the past relative to the current day.

firstDayOfWeek
number
0

Specifies the first day of the week: 0 for Sunday, 1 for Monday, and so on. If not set, the first day is determined by the locale.

maxDate
Date
new Date(2099, 11, 31)

Specifies the maximum date that can be selected in the Calendar.

minDate
Date
new Date(1900, 0, 1)

Specifies the minimum date that can be selected in the Calendar.

showDaysOutsideCurrentMonth
boolean
true

When true, shows dates from the previous and next months in the current month's view.

start
CalendarView.Month

Specifies the initial view that the calendar renders.

weekDaysFormat
WeekDaysFormats.Short

Specifies the format of the day names to be displayed in the week header.

weekNumber
boolean
false

When true, displays the week number of the year in the month view.

weekRule
WeekRule.FirstDay

Specifies the rule for defining the first week of the year.

Events

The following table outlines the events for the CalendarBaseProps:

NameTypeDescription
onViewChange
(event: ViewChangeEvent) => void

Triggers when the calendar navigates to a new view or date range.