CalendarOptions

Options used to generate a view matrix.

Props

The following table outlines the props for the CalendarOptions:

NameTypeDefaultDescription
cols
number
-

Number of columns in the resulting matrix. Defaults depend on view kind.

  • month: typically 7
  • year: typically 3
  • decade: typically 3
firstDayOfWeek
number
-

The first day of the week (0 = Sunday, 1 = Monday, ...). Only used for 'month' view.

isWeekend
(date: Date) => boolean
-

Specifies a custom function to determine if a given date is a weekend.

locale
string
-

Locale for Calendar When omitted, calendar engines may fall back to a default locale (e.g., "en-US").

rows
number
-

Number of rows in the resulting matrix. Defaults depend on view kind.

  • month: typically 6
  • year: typically 4
  • decade: typically 4
showDaysOutsideCurrentMonth
boolean
-

Whether to show days from adjacent months in the current calendar view.

weekendDays
number[]
-

Specifies the numeric values representing weekend days (0 = Sunday, 6 = Saturday).