Calendar API Reference

Properties

Name Type Default Value
animation string 'advanced'
animationSettings object null
calendarMode string 'default'
dayNameFormat string 'firstTwoLetters'
dateFormatFunction function | null null
disabled boolean false
disableAutoNavigation boolean false
displayMode string 'month'
displayModeView string 'table'
dropDownHeight string '200'
dropDownWidth string ''
firstDayOfWeek number 0
footerTemplate any null
headerTemplate any null
hideDayNames boolean false
hideOtherMonthDays boolean false
hideTooltipArrow boolean false
importantDates string[]
importantDatesTemplate any null
locale string 'en'
localizeFormatFunction function | null null
max any new Date(2100, 1, 1)
messages object Please expand entry to see value
min any new Date(1900, 1, 1)
months number 1
monthNameFormat string 'long'
name string ''
readonly boolean false
restrictedDates string[]
rightToLeft boolean false
scrollButtonsNavigationMode string 'landscape'
scrollButtonsPosition string 'both'
selectedDates string[]
selectionMode string 'default'
spinButtonsDelay number 80
spinButtonsInitialDelay number 0
theme string ''
titleTemplate any null
tooltip boolean false
tooltipArrow boolean true
tooltipDelay number 100
tooltipOffset {number[]}[]
tooltipPosition string 'top'
tooltipTemplate any null
unfocusable boolean false
view string 'portrait'
viewSections string[] header
weekNumbers boolean false
weeks number 6
yearFormat string 'numeric'

Events

Name Type
change Event
displayModeChanging Event
displayModeChange Event

Methods

Name Type Return Type
clearSelection(): void Method void
navigate(step: number | Date | string): boolean Method boolean
select(date: Date | string): void Method void
today(): Date Method Date