Skip to content

Options

createCalendar(element, options) takes one object of options. Most of them can change afterwards with calendar.update({ … }); the frameworks pass them as inputs, props or an options object.

Each option has its own page: what it does, its type and default, whether it changes live, an example in JavaScript, Angular, React and Vue, and a live demo. Each option has its page.

Generated from the types: the type, and whether update() changes it.

OptionTypeLive
allDaySlotbooleanYes
autoPrintbooleanNo
availableSlotsreadonly AvailableSlot[] | nullYes
businessHoursBusinessHoursInputYes
chooseScope(request: ScopeRequest) => EditScope | null | Promise<Edi…Yes
collapsedGroupsreadonly string[]Yes
collapsedResourcesreadonly string[]Yes
contextMenuMenuHookYes
cssLayersbooleanNo
customButtonsReadonly<Record<string, CustomButton>>Yes
dayMaxLanesnumber | 'auto' | nullYes
density'compact' | 'comfortable' | 'spacious'Yes
displayCalendarstring | nullYes
displayEventTimebooleanYes
dragEdgeNavigatebooleanYes
droppableboolean | ((data: unknown) => boolean)Yes
editablebooleanYes
eventMaxStacknumber | 'auto' | nullYes
eventResizableFromStartbooleanYes
eventStyle'tinted' | 'solid'Yes
eventsreadonly EventInput[]Yes
firstDayWeekdayYes
forget{ readonly olderThan: DurationLike } | nullYes
formatsFormatsYes
headerItemsReadonly<Record<string, ElementHooks<HeaderItemCtx>>>Yes
headerToolbarHeaderToolbar | falseYes
headerViewsreadonly string[]Yes
hiddenDaysreadonly Weekday[]Yes
historyLimitnumberNo
hooksCalendarHooksYes
initialDatePlainDateYes, as date
initialViewstringYes, as view
injectStylesbooleanNo
kernelCalendarKernelNo
keyboardUndobooleanYes
localestringYes
look'styled' | 'none'Yes
messagesPartial<DzMessages>Yes
motionMotionAdapterYes
multiMonthMaxColumnsnumberYes
nowIndicatorbooleanYes
nowRefreshDurationLikeYes
onCommandRefused(result: CommandResult, command: Command) => voidYes
onCreateRequest(request: CreateRequest) => voidYes
onDateClick(click: DateClick) => voidYes
onDrop(drop: DropInfo) => voidYes
onEventChange(change: EventChange) => voidYes
onEventClick(instance: EventInstance) => voidYes
onEventLeave(leave: EventLeave) => voidYes
onEventOpen(instance: EventInstance) => voidYes
onEventReceive(change: EventChange) => voidYes
onFollowChange(following: boolean) => voidYes
onProblem(problem: CalendarProblem) => voidYes
onProposalRefused(proposal: Proposal) => voidYes
onResourceProblems(problems: readonly Problem[]) => voidYes
onResourceToggle(state: { readonly collapsedResources: readonly string[];…Yes
onSelect(selection: Selection) => voidYes
onSlotClick(slot: AvailableSlot) => voidYes
onSource(n: SourceNotice) => voidNo
onUnselect() => voidYes
resourceGroupFieldstring | undefinedYes
resourceOrderResourceOrder | undefinedYes
resourcesreadonly ResourceInput[]Yes
rulesOmit<RulesContext, 'displayZone' | 'businessHours'>Yes
scheme'auto' | 'light' | 'dark'Yes
scrollTimeDurationLikeYes
secondaryCalendarstring | nullYes
selectablebooleanYes
showUnassignedbooleanYes
snapMinutesnumberYes
sourcesreadonly EventSourceSpec[]Yes
storeEventStoreNo
themestringYes
timeGridOmit<TimeGridOptions, 'displayZone' | 'businessHours' | '…Yes
timeZoneZoneIdYes
timeline{ readonly slot?: number | 'day'; readonly maxLanes?: num…Yes
titleFormatTitleFormatYes, as formats
viewOptionsReadonly<Record<string, unknown>>Yes
viewsReadonly<Record<string, ViewSpec | ViewSettings>>No
virtualizeAbovenumberNo
weekNumbersbooleanYes
weekendsbooleanYes

Callbacks — onEventClick, onDateClick, onSelect, onEventChange… — are options too, and can be replaced with update().