Aller au contenu

Options

createCalendar(element, options) prend un seul objet d’options. La plupart peuvent changer ensuite avec calendar.update({ … }) ; les frameworks les passent en entrées, en props ou dans un objet options.

Chaque option a sa page : ce qu’elle fait, son type et sa valeur par défaut, si elle change à chaud, un exemple en JavaScript, Angular, React et Vue, et une démo en direct. Chaque option a sa page.

Généré à partir des types : le type, et si update() la change.

OptionTypeEn direct
allDaySlotbooleanOui
autoPrintbooleanNon
availableSlotsreadonly AvailableSlot[] | nullOui
businessHoursBusinessHoursInputOui
chooseScope(request: ScopeRequest) => EditScope | null | Promise<Edi…Oui
collapsedGroupsreadonly string[]Oui
collapsedResourcesreadonly string[]Oui
contextMenuMenuHookOui
cssLayersbooleanNon
customButtonsReadonly<Record<string, CustomButton>>Oui
dayMaxLanesnumber | 'auto' | nullOui
density'compact' | 'comfortable' | 'spacious'Oui
displayCalendarstring | nullOui
displayEventTimebooleanOui
dragEdgeNavigatebooleanOui
droppableboolean | ((data: unknown) => boolean)Oui
editablebooleanOui
eventMaxStacknumber | 'auto' | nullOui
eventResizableFromStartbooleanOui
eventStyle'tinted' | 'solid'Oui
eventsreadonly EventInput[]Oui
firstDayWeekdayOui
forget{ readonly olderThan: DurationLike } | nullOui
formatsFormatsOui
headerItemsReadonly<Record<string, ElementHooks<HeaderItemCtx>>>Oui
headerToolbarHeaderToolbar | falseOui
headerViewsreadonly string[]Oui
hiddenDaysreadonly Weekday[]Oui
historyLimitnumberNon
hooksCalendarHooksOui
initialDatePlainDateOui, sous date
initialViewstringOui, sous view
injectStylesbooleanNon
kernelCalendarKernelNon
keyboardUndobooleanOui
localestringOui
look'styled' | 'none'Oui
messagesPartial<DzMessages>Oui
motionMotionAdapterOui
multiMonthMaxColumnsnumberOui
nowIndicatorbooleanOui
nowRefreshDurationLikeOui
onCommandRefused(result: CommandResult, command: Command) => voidOui
onCreateRequest(request: CreateRequest) => voidOui
onDateClick(click: DateClick) => voidOui
onDrop(drop: DropInfo) => voidOui
onEventChange(change: EventChange) => voidOui
onEventClick(instance: EventInstance) => voidOui
onEventLeave(leave: EventLeave) => voidOui
onEventOpen(instance: EventInstance) => voidOui
onEventReceive(change: EventChange) => voidOui
onFollowChange(following: boolean) => voidOui
onProblem(problem: CalendarProblem) => voidOui
onProposalRefused(proposal: Proposal) => voidOui
onResourceProblems(problems: readonly Problem[]) => voidOui
onResourceToggle(state: { readonly collapsedResources: readonly string[];…Oui
onSelect(selection: Selection) => voidOui
onSlotClick(slot: AvailableSlot) => voidOui
onSource(n: SourceNotice) => voidNon
onUnselect() => voidOui
resourceGroupFieldstring | undefinedOui
resourceOrderResourceOrder | undefinedOui
resourcesreadonly ResourceInput[]Oui
rulesOmit<RulesContext, 'displayZone' | 'businessHours'>Oui
scheme'auto' | 'light' | 'dark'Oui
scrollTimeDurationLikeOui
secondaryCalendarstring | nullOui
selectablebooleanOui
showUnassignedbooleanOui
snapMinutesnumberOui
sourcesreadonly EventSourceSpec[]Oui
storeEventStoreNon
themestringOui
timeGridOmit<TimeGridOptions, 'displayZone' | 'businessHours' | '…Oui
timeZoneZoneIdOui
timeline{ readonly slot?: number | 'day'; readonly maxLanes?: num…Oui
titleFormatTitleFormatOui, sous formats
viewOptionsReadonly<Record<string, unknown>>Oui
viewsReadonly<Record<string, ViewSpec | ViewSettings>>Non
virtualizeAbovenumberNon
weekNumbersbooleanOui
weekendsbooleanOui

Les fonctions de rappel — onEventClick, onDateClick, onSelect, onEventChange… — sont des options aussi, et se remplacent avec update().