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.
All the options
Section titled “All the options”Generated from the types: the type, and whether update() changes it.
| Option | Type | Live |
|---|---|---|
allDaySlot | boolean | Yes |
autoPrint | boolean | No |
availableSlots | readonly AvailableSlot[] | null | Yes |
businessHours | BusinessHoursInput | Yes |
chooseScope | (request: ScopeRequest) => EditScope | null | Promise<Edi… | Yes |
collapsedGroups | readonly string[] | Yes |
collapsedResources | readonly string[] | Yes |
contextMenu | MenuHook | Yes |
cssLayers | boolean | No |
customButtons | Readonly<Record<string, CustomButton>> | Yes |
dayMaxLanes | number | 'auto' | null | Yes |
density | 'compact' | 'comfortable' | 'spacious' | Yes |
displayCalendar | string | null | Yes |
displayEventTime | boolean | Yes |
dragEdgeNavigate | boolean | Yes |
droppable | boolean | ((data: unknown) => boolean) | Yes |
editable | boolean | Yes |
eventMaxStack | number | 'auto' | null | Yes |
eventResizableFromStart | boolean | Yes |
eventStyle | 'tinted' | 'solid' | Yes |
events | readonly EventInput[] | Yes |
firstDay | Weekday | Yes |
forget | { readonly olderThan: DurationLike } | null | Yes |
formats | Formats | Yes |
headerItems | Readonly<Record<string, ElementHooks<HeaderItemCtx>>> | Yes |
headerToolbar | HeaderToolbar | false | Yes |
headerViews | readonly string[] | Yes |
hiddenDays | readonly Weekday[] | Yes |
historyLimit | number | No |
hooks | CalendarHooks | Yes |
initialDate | PlainDate | Yes, as date |
initialView | string | Yes, as view |
injectStyles | boolean | No |
kernel | CalendarKernel | No |
keyboardUndo | boolean | Yes |
locale | string | Yes |
look | 'styled' | 'none' | Yes |
messages | Partial<DzMessages> | Yes |
motion | MotionAdapter | Yes |
multiMonthMaxColumns | number | Yes |
nowIndicator | boolean | Yes |
nowRefresh | DurationLike | Yes |
onCommandRefused | (result: CommandResult, command: Command) => void | Yes |
onCreateRequest | (request: CreateRequest) => void | Yes |
onDateClick | (click: DateClick) => void | Yes |
onDrop | (drop: DropInfo) => void | Yes |
onEventChange | (change: EventChange) => void | Yes |
onEventClick | (instance: EventInstance) => void | Yes |
onEventLeave | (leave: EventLeave) => void | Yes |
onEventOpen | (instance: EventInstance) => void | Yes |
onEventReceive | (change: EventChange) => void | Yes |
onFollowChange | (following: boolean) => void | Yes |
onProblem | (problem: CalendarProblem) => void | Yes |
onProposalRefused | (proposal: Proposal) => void | Yes |
onResourceProblems | (problems: readonly Problem[]) => void | Yes |
onResourceToggle | (state: { readonly collapsedResources: readonly string[];… | Yes |
onSelect | (selection: Selection) => void | Yes |
onSlotClick | (slot: AvailableSlot) => void | Yes |
onSource | (n: SourceNotice) => void | No |
onUnselect | () => void | Yes |
resourceGroupField | string | undefined | Yes |
resourceOrder | ResourceOrder | undefined | Yes |
resources | readonly ResourceInput[] | Yes |
rules | Omit<RulesContext, 'displayZone' | 'businessHours'> | Yes |
scheme | 'auto' | 'light' | 'dark' | Yes |
scrollTime | DurationLike | Yes |
secondaryCalendar | string | null | Yes |
selectable | boolean | Yes |
showUnassigned | boolean | Yes |
snapMinutes | number | Yes |
sources | readonly EventSourceSpec[] | Yes |
store | EventStore | No |
theme | string | Yes |
timeGrid | Omit<TimeGridOptions, 'displayZone' | 'businessHours' | '… | Yes |
timeZone | ZoneId | Yes |
timeline | { readonly slot?: number | 'day'; readonly maxLanes?: num… | Yes |
titleFormat | TitleFormat | Yes, as formats |
viewOptions | Readonly<Record<string, unknown>> | Yes |
views | Readonly<Record<string, ViewSpec | ViewSettings>> | No |
virtualizeAbove | number | No |
weekNumbers | boolean | Yes |
weekends | boolean | Yes |
Callbacks — onEventClick, onDateClick, onSelect, onEventChange… — are options too, and can be replaced with update().