Skip to content

Calendar properties

Summary


Props table


Parameter
Type
Default
CalendarDate
Today date
boolean
/
string[]
English week labels
string[]
English months labels
(date: CalendarDate) => void
/
number
Today year
number
Today month
boolean
true
string
true
string
/
Record
/
(newValue: CalendarDate) => void
() => {}
string
/


Props list



value

Type
Default
CalendarDate
Today date


Actual selected date



hideArrows

Type
Default
boolean
/


If true, hide arrow buttons near the date label



days

Type
Default
string[]
English week labels


Custom days labels



months

Type
Default
string[]
English months labels


Custom months labels



onViewChange

Type
Default
(date: CalendarDate) => void
/


Callback triggered when the Calendar view (the displayed month) is changed



startYear

Type
Default
number
Today year


Initial displayed year



startMonth

Type
Default
number
Today month


Initial displayed month



fromToday

Type
Default
boolean
true


If false, prevent the user to select a date lower than today date



dayLabel

Type
Default
string
true


Show/hide actual day label on top of the calendar



labelClassName

Type
Default
string
/


Custom className applied on the day label component



labelProps

Type
Default
Record
/


Custom props applied on the day label component



onChange

Type
Default
(newValue: CalendarDate) => void
() => {}


Callback triggered when Calendar component input value is changed by the user



arrowClassName

Type
Default
string
/


Custom classname applied on the arrow button