Skip to main content

Calendar

Calendar displays a month grid that lets people choose a date or date range, such as a booking period or a reporting window.

Import

import { Calendar } from '@vortexlabs/vortex';
import type { CalendarProps } from '@vortexlabs/vortex';

Other links

Storybook
Calendar props
PropTypeDefaultAttributes
selection
union
single
min
Date
No default value
max
Date
No default value
isDateDisabled
callback
No default value
hasDateEvent
callback
No default value
eventAriaLabel
string
No default value
firstWeekDay
number
1
locale
string
en-US
monthFormat
union
short
previousAriaLabel
string
No default value
nextAriaLabel
string
No default value
className
union
No default value
attributes
object
No default value

Single Selection

Single selection props
PropTypeDefaultAttributes
value
union
No default value
defaultValue
union
No default value
onChange
callback
No default value

Range Selection

Range selection props
PropTypeDefaultAttributes
selection
"range"
No default value
value
object
No default value
defaultValue
object
No default value
onChange
callback
No default value

CalendarRangeValue

CalendarRangeValue fields
PropTypeDefaultAttributes
start
union
No default value
end
union
No default value