allDayMaintainDuration
RuntimeOptional
Preserve the exact duration when crossing all-day/timed surfaces.
- Type
boolean- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
Every option.
One searchable contract.
Search the installed @wts-calendar/core declarations, public calendar methods, and every PHP and ASP.NET Core endpoint setting. Types and method signatures are generated from the package pinned by this portal.
248 client options95 public APIs78 event-bus names447 exported symbols20 server settings
248 matching client options
Runtime options can be changed with calendar.setOption(name, value).
allDaySlot
RuntimeOptional
Show the all-day row in day and week views. Defaults to true.
- Type
boolean- Category
- Core configuration
- Availability
- Standard
- Documented default
- true
allDayText
RuntimeOptional
Text displayed for the all-day row. Defaults to `All day`.
- Type
string- Category
- Core configuration
- Availability
- Standard
- Documented default
- `All day`
apikey
Construction onlyOptional
Typed calendar option.
- Type
never- Category
- Data & integrations
- Availability
- Standard
- Documented default
- Package default / not specified
Deprecated: Plain API keys are not accepted.
aspectRatio
RuntimeOptional
Width-to-content-height ratio used when no explicit height is set.
- Type
number- Category
- Appearance & layout
- Availability
- Standard
- Documented default
- Package default / not specified
backgroundEventColor
RuntimeOptional
Global background-event color.
- Type
string- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
businessHours
RuntimeOptional
Visually marks business and non-business time. `true` uses Monday-Friday, 09:00-17:00. Set to false to disable the display.
- Type
false | CalendarBusinessHoursInput- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
buttonClass
RuntimeOptional
Typed calendar option.
- Type
CalendarToolbarClassNameInput<CalendarToolbarButtonRenderInfo>- Category
- Toolbar
- Availability
- Standard
- Documented default
- Package default / not specified
buttonDisplay
RuntimeOptional
Controls whether toolbar buttons show text, icons, or both.
- Type
CalendarToolbarButtonDisplay- Category
- Toolbar
- Availability
- Standard
- Documented default
- Package default / not specified
buttonGroupClass
RuntimeOptional
Typed calendar option.
- Type
CalendarToolbarClassNameInput<CalendarToolbarButtonGroupRenderInfo>- Category
- Toolbar
- Availability
- Standard
- Documented default
- Package default / not specified
buttonHints
RuntimeOptional
Accessible labels for built-in actions, views, and custom buttons.
- Type
Readonly<Record<string, string>>- Category
- Toolbar
- Availability
- Standard
- Documented default
- Package default / not specified
buttons
RuntimeOptional
v7-style definitions that can add or override any toolbar button.
- Type
Readonly<Record<string, CalendarToolbarButton>>- Category
- Toolbar
- Availability
- Standard
- Documented default
- Package default / not specified
buttonText
RuntimeOptional
Visible labels for built-in actions, views, and custom buttons.
- Type
Readonly<Record<string, string>>- Category
- Toolbar
- Availability
- Standard
- Documented default
- Package default / not specified
colorScheme
RuntimeOptional
Light/dark palette selection; `auto` follows the OS preference.
- Type
CalendarColorScheme- Category
- Appearance & layout
- Availability
- Standard
- Documented default
- Package default / not specified
columnResizing
PremiumRuntimeOptional
Accessible column resizing for resource-based views.
- Type
boolean | CalendarColumnResizingOptions- Category
- Core configuration
- Availability
- Premium
- Documented default
- Package default / not specified
container
Construction onlyRequired
Typed calendar option.
- Type
HTMLElement- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
contentHeight
RuntimeOptional
Height of the active view body, excluding toolbars.
- Type
CalendarSizeValue- Category
- Appearance & layout
- Availability
- Standard
- Documented default
- Package default / not specified
customButtons
RuntimeOptional
Application-defined toolbar actions referenced by name in a toolbar.
- Type
Readonly<Record<string, CalendarCustomButton>>- Category
- Toolbar
- Availability
- Standard
- Documented default
- Package default / not specified
customHTML
Construction onlyOptional
Typed calendar option.
- Type
{ setHeader?: () => string | HTMLElement | Element; headerElement?: { ordering?: Array<'prev' | 'next' | 'title' | Array<'day-view' | 'month-view' | 'week-view' | 'list-view' | 'monthly-repeated-task' | 'weekly-repeated-task'>>; nextButton?: string; previousButton?: string; viewButtons?: { dayView?: string; monthView?: string; weekView?: string; listView?: string; monthlyTaskView?: string; weeklyTaskView?: string; }; }; }- Category
- Appearance & layout
- Availability
- Standard
- Documented default
- Package default / not specified
dateClick
RuntimeOptional
Called when a date or time cell is activated without range selection.
- Type
(info: CalendarDateClickInfo) => void- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
dateDisambiguation
RuntimeOptional
Resolves skipped or repeated wall-clock times at DST boundaries. Defaults to the Temporal-compatible behavior.
- Type
CalendarDateDisambiguation- Category
- Views & time
- Availability
- Standard
- Documented default
- the Temporal-compatible behavior
datesAboveResources
PremiumRuntimeOptional
Places date headings above resource headings in vertical resource views.
- Type
boolean- Category
- Views & time
- Availability
- Premium
- Documented default
- Package default / not specified
datesSet
RuntimeOptional
Called after the initial visible range and every subsequent range change.
- Type
(detail: CalendarDatesSetDetail) => void | Promise<void>- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
dayCellClassNames
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarDateRenderInfo) => CalendarEventClassNames- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
dayCellContent
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarDateRenderInfo) => CalendarEventContent- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
dayCellDidMount
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarDateMountInfo) => void- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
dayCellWillUnmount
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarDateMountInfo) => void- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
dayHeaderClassNames
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarDateRenderInfo) => CalendarEventClassNames- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
dayHeaderContent
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarDateRenderInfo) => CalendarEventContent- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
dayHeaderDidMount
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarDateMountInfo) => void- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
dayHeaderDividerClass
RuntimeOptional
Typed calendar option.
- Type
CalendarLayoutClassNameInput<CalendarStickyClassInfo>- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
dayHeaderRowClass
RuntimeOptional
Typed calendar option.
- Type
CalendarLayoutClassNameInput- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
dayHeaderWillUnmount
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarDateMountInfo) => void- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
dayMaxEvents
RuntimeOptional
Maximum visible events per month cell. `false` disables the limit and `true` uses the adaptive default of three.
- Type
boolean | number- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
dayOffOnWeekDays
RuntimeOptional
Typed calendar option.
- Type
Array<number>- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
dayRowClass
RuntimeOptional
Typed calendar option.
- Type
CalendarLayoutClassNameInput- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
dayView
RuntimeOptional
Typed calendar option.
- Type
{ hourSegment?: number; hourSegmentRange?: boolean | { start: string | Date; end: string | Date; }; segmentHeight?: number; dragTolerance?: number; resizeTolerance?: number; /** @deprecated Use `dragTolerance`. */ dragTolarance?: number; /** @deprecated Use `resizeTolerance`. */ resizeTolarance?: number; }- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
defaultAllDayEventDuration
RuntimeOptional
Effective duration, in calendar days, for all-day events without `end`. Defaults to 1.
- Type
number- Category
- Core configuration
- Availability
- Standard
- Documented default
- 1
defaultTimedEventDuration
RuntimeOptional
Effective duration, in minutes, for timed events without `end`. Defaults to 60.
- Type
number- Category
- Core configuration
- Availability
- Standard
- Documented default
- 60
direction
RuntimeOptional
Explicit text direction. Otherwise resolved from the active locale.
- Type
'ltr' | 'rtl'- Category
- Localization
- Availability
- Standard
- Documented default
- Package default / not specified
displayEventEnd
RuntimeOptional
Show timed-event end times where the view has enough space.
- Type
boolean- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
displayEventTime
RuntimeOptional
Show timed-event start times in month and list labels.
- Type
boolean- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
document
Construction onlyOptional
Typed calendar option.
- Type
Document- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
dragRevertDuration
RuntimeOptional
Failed-drag return animation duration in milliseconds.
- Type
number- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
dragScroll
RuntimeOptional
Auto-scroll scrollable calendar containers during dragging.
- Type
boolean- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
drop
RuntimeOptional
Fires for every accepted external drop, including `create: false`.
- Type
(info: CalendarExternalDropInfo) => void- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
dropAccept
Construction onlyOptional
Selector or predicate controlling accepted external elements.
- Type
string | ((element: HTMLElement) => boolean)- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
droppable
Construction onlyOptional
Accept events dragged from external elements or another WtsCalendar. Defaults to false.
- Type
boolean- Category
- Events & interaction
- Availability
- Standard
- Documented default
- false
editable
RuntimeOptional
Master event editing switch. Defaults to true for legacy compatibility.
- Type
boolean- Category
- Events & interaction
- Availability
- Standard
- Documented default
- true for legacy compatibility
eventAllow
RuntimeOptional
Final synchronous approval for each proposed drop or resize.
- Type
(dropInfo: CalendarEventAllowInfo, draggedEvent: IEvent) => boolean- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventChange
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarInteractionTransaction) => void- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventClassNames
RuntimeOptional
Adds classes to every rendered foreground or background event segment.
- Type
CalendarEventClassNameInput- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventClick
RuntimeOptional
Called once for a native click on a rendered event segment.
- Type
(info: CalendarEventClickInfo) => void- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventColor
RuntimeOptional
Global foreground event color, overridden by an event's `color`.
- Type
string- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventConstraint
RuntimeOptional
compatibility interaction constraint alias.
- Type
CalendarSelectConstraint- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventContent
RuntimeOptional
Replaces the default foreground event label. Strings are rendered as text; DOM nodes must belong to the configured calendar document.
- Type
CalendarEventContentInput- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventCreation
RuntimeOptional
Enables select-to-create requests without imposing a package modal. Existing `select` behavior is unchanged when omitted or false.
- Type
boolean | { defaultTitle?: string; }- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventDidMount
RuntimeOptional
Called after an event segment is attached to the calendar DOM.
- Type
(info: CalendarEventMountInfo) => void- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventDisplay
RuntimeOptional
Default rendering style; an event-level `display` takes precedence.
- Type
CalendarEventDisplay- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventDragMinDistance
RuntimeOptional
Pointer movement required before event dragging starts.
- Type
number- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventDragStart
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarEventDragLifecycleInfo) => void- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventDragStop
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarEventDragLifecycleInfo) => void- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventDrop
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarInteractionTransaction) => unknown- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventDurationEditable
RuntimeOptional
Enables event duration changes independently of movement.
- Type
boolean- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventHistory
RuntimeOptional
Bounded event undo/redo history. Enabled with a limit of 50 by default. Set to false to disable it.
- Type
false | { limit?: number; }- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventInteractionFailure
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarInteractionFailureInfo) => void- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventLeave
RuntimeOptional
Fires on the source calendar before a cross-calendar move completes.
- Type
(info: CalendarEventTransferTransaction) => unknown- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventLongPressDelay
RuntimeOptional
Touch hold duration before event dragging starts.
- Type
number- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventMaxStack
RuntimeOptional
Maximum simultaneous time-grid event lanes; false is unlimited.
- Type
false | number- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventMinHeight
RuntimeOptional
Minimum timed-event height in pixels. Defaults to 18.
- Type
number- Category
- Events & interaction
- Availability
- Standard
- Documented default
- 18
eventMouseEnter
RuntimeOptional
Called for native mouseenter on a rendered event segment.
- Type
(info: CalendarEventMouseInfo) => void- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventMouseLeave
RuntimeOptional
Called for native mouseleave on a rendered event segment.
- Type
(info: CalendarEventMouseInfo) => void- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventMutationValidator
RuntimeOptional
Optional server-side approval hook for create, edit, and remove transactions. False, rejection, or timeout restores the prior snapshot.
- Type
(transaction: CalendarEventMutationTransaction) => boolean | void | Promise<boolean | void>- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventOrder
RuntimeOptional
Deterministic within-day ordering. Defaults to `start,-duration,allDay,title`.
- Type
CalendarEventOrderInput- Category
- Events & interaction
- Availability
- Standard
- Documented default
- `start,-duration,allDay,title`
eventOrderStrict
RuntimeOptional
Prevents view layout from relaxing `eventOrder`. Defaults to false.
- Type
boolean- Category
- Events & interaction
- Availability
- Standard
- Documented default
- false
eventOverlap
RuntimeOptional
compatibility interaction overlap policy.
- Type
boolean | ((stillEvent: IEvent, movingEvent: IEvent) => boolean)- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventReceive
RuntimeOptional
Fires after an external or cross-calendar event is created.
- Type
(info: CalendarEventTransferTransaction) => unknown- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventResizableFromStart
RuntimeOptional
Adds a resize handle to the event's starting edge.
- Type
boolean- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventResize
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarInteractionTransaction) => unknown- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventResizeStart
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarEventDragLifecycleInfo) => void- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventResizeStop
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarEventDragLifecycleInfo) => void- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventResourceEditable
PremiumRuntimeOptional
Enables moving events between resources.
- Type
boolean- Category
- Events & interaction
- Availability
- Premium
- Documented default
- Package default / not specified
events
Construction onlyOptional
Typed calendar option.
- Type
Array<IEvent>- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventSources
Construction onlyOptional
Typed calendar option.
- Type
readonly CalendarEventSource[]- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventStartEditable
RuntimeOptional
Enables event movement independently of duration editing.
- Type
boolean- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventTextColor
RuntimeOptional
Global text color used on foreground events.
- Type
string- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
eventTimeFormat
RuntimeOptional
DatePipe-compatible event time format. Defaults to `HH:mm`.
- Type
string- Category
- Events & interaction
- Availability
- Standard
- Documented default
- `HH:mm`
eventTransferMode
Construction onlyOptional
Default behavior for calendar-to-calendar drops. Defaults to `move`.
- Type
CalendarEventTransferMode- Category
- Events & interaction
- Availability
- Standard
- Documented default
- `move`
eventWillUnmount
RuntimeOptional
Called immediately before an event segment is removed.
- Type
(info: CalendarEventMountInfo) => void- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
excludeDayOffOnWeekDays
RuntimeOptional
Typed calendar option.
- Type
Array<Date | string>- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
exCludeDayOffOnWeekDays
RuntimeOptional
Typed calendar option.
- Type
Array<Date | string>- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
Deprecated: Use `excludeDayOffOnWeekDays`.
expandRows
RuntimeOptional
Expand view rows to consume available content height.
- Type
boolean- Category
- Appearance & layout
- Availability
- Standard
- Documented default
- Package default / not specified
externalEventData
Construction onlyOptional
Maps an unbound draggable element to calendar event data. Elements bound with `makeDraggable` do not require this mapper.
- Type
(context: CalendarExternalEventContext) => CalendarExternalEventInput | null | undefined- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
extraClass
Construction onlyOptional
Typed calendar option.
- Type
{ header?: Array<string> | string; title?: Array<string> | string; nextButton?: Array<string> | string; previousButton?: Array<string> | string; viewButtons?: { dayView?: Array<string> | string; monthView?: Array<string> | string; weekView?: Array<string> | string; listView?: Array<string> | string; monthlyTaskView?: Array<string> | string; weeklyTaskView?: Array<string> | string; }; }- Category
- Appearance & layout
- Availability
- Standard
- Documented default
- Package default / not specified
filterResourcesWithEvents
PremiumRuntimeOptional
compatibility event-presence filter.
- Type
boolean- Category
- Core configuration
- Availability
- Premium
- Documented default
- Package default / not specified
fixedWeekCount
RuntimeOptional
Always render six month rows. Defaults to true.
- Type
boolean- Category
- Core configuration
- Availability
- Standard
- Documented default
- true
footerScrollbarSticky
RuntimeOptional
Keep a synchronized horizontal scrollbar at the viewport footer.
- Type
boolean | 'auto'- Category
- Toolbar
- Availability
- Standard
- Documented default
- Package default / not specified
footerToolbar
RuntimeOptional
Optional declarative footer toolbar.
- Type
false | CalendarToolbarInput- Category
- Toolbar
- Availability
- Standard
- Documented default
- Package default / not specified
footerToolbarClass
RuntimeOptional
Typed calendar option.
- Type
CalendarToolbarClassNameInput<CalendarToolbarRenderInfo>- Category
- Toolbar
- Availability
- Standard
- Documented default
- Package default / not specified
forceEventDuration
RuntimeOptional
Materialize a missing event `end` from the configured default duration. Rendering always uses the effective duration; this option also exposes it through the calendar event API. Defaults to false.
- Type
boolean- Category
- Core configuration
- Availability
- Standard
- Documented default
- false
googleCalendarApiKey
Construction onlyOptional
API key used by optional public Google Calendar event sources.
- Type
string- Category
- Data & integrations
- Availability
- Standard
- Documented default
- Package default / not specified
headerToolbar
RuntimeOptional
Declarative header toolbar. Omit to preserve the legacy default header.
- Type
false | CalendarToolbarInput- Category
- Toolbar
- Availability
- Standard
- Documented default
- Package default / not specified
headerToolbarClass
RuntimeOptional
Typed calendar option.
- Type
CalendarToolbarClassNameInput<CalendarToolbarRenderInfo>- Category
- Toolbar
- Availability
- Standard
- Documented default
- Package default / not specified
headingLevel
RuntimeOptional
Semantic heading level for the toolbar title. Defaults to 2.
- Type
1 | 2 | 3 | 4 | 5 | 6- Category
- Toolbar
- Availability
- Standard
- Documented default
- 2
height
RuntimeOptional
Total calendar height, including toolbars.
- Type
CalendarSizeValue- Category
- Appearance & layout
- Availability
- Standard
- Documented default
- Package default / not specified
hideHeader
Construction onlyOptional
Typed calendar option.
- Type
boolean- Category
- Toolbar
- Availability
- Standard
- Documented default
- Package default / not specified
initialDate
Construction onlyOptional
compatibility construction alias for `viewDate`.
- Type
CalendarDateInput- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
initialView
Construction onlyOptional
compatibility construction alias for `view`.
- Type
Views- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
interactionConstraints
RuntimeOptional
Synchronous scheduling rules evaluated before interaction callbacks or asynchronous validation.
- Type
CalendarInteractionConstraints- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
interactionValidationTimeout
RuntimeOptional
Maximum time for async interaction validation before automatic rollback. Defaults to 30 seconds. Set to `0` to disable the timeout.
- Type
number- Category
- Core configuration
- Availability
- Standard
- Documented default
- 30 seconds
interactionValidator
RuntimeOptional
Optional optimistic interaction validator. Returning/resolving `false` or rejecting automatically reverts the drop or resize transaction.
- Type
(transaction: CalendarInteractionTransaction | CalendarEventTransferTransaction) => boolean | void | Promise<boolean | void>- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
lazyFetching
RuntimeOptional
Reuse previously fetched source ranges. Defaults to true.
- Type
boolean- Category
- Core configuration
- Availability
- Standard
- Documented default
- true
license
Construction onlyOptional
Verified premium grant returned by `verifyCalendarLicense`.
- Type
CalendarLicenseGrant- Category
- Data & integrations
- Availability
- Standard
- Documented default
- Package default / not specified
listView
RuntimeOptional
Agenda/list configuration. `list` uses `durationDays`; the named list views use their natural day, week, or month range.
- Type
{ /** Custom `list` duration in calendar days. Defaults to 30. */ durationDays?: number; /** Event-row count that activates vertical virtualization. Defaults to 200. */ virtualizationThreshold?: number; /** Extra virtual rows mounted above and below the viewport. Defaults to 8. */ overscan?: number; /** Include date headings without events. Defaults to false. */ showEmptyDays?: boolean; /** Only include events assigned to these resource ids. */ resourceIds?: readonly string[]; /** Date heading format. Defaults to `EEEE, MMMM d, yyyy`. */ dayFormat?: string; /** Timed event format. Defaults to the global `eventTimeFormat`. */ eventTimeFormat?: string; /** Keep date headings visible while scrolling non-virtual lists. */ stickyHeaders?: boolean; /** Replaces the default empty-range message. */ noEventsContent?: string | ((range: { start: Date; end: Date; view: Views; }) => CalendarEventContent); }- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
locale
RuntimeOptional
Active locale code or an inline locale definition.
- Type
CalendarLocaleInput- Category
- Localization
- Availability
- Standard
- Documented default
- Package default / not specified
locales
RuntimeOptional
Locale definitions available for runtime switching by code.
- Type
readonly CalendarLocale[]- Category
- Localization
- Availability
- Standard
- Documented default
- Package default / not specified
localization
RuntimeOptional
Typed calendar option.
- Type
string- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
Deprecated: Use `locale`.
moreLinkClassNames
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarMoreLinkRenderInfo) => CalendarEventClassNames- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
moreLinkClick
RuntimeOptional
Behavior of the month-cell overflow link. Defaults to `popover`.
- Type
CalendarMoreLinkAction- Category
- Core configuration
- Availability
- Standard
- Documented default
- `popover`
moreLinkContent
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarMoreLinkRenderInfo) => CalendarEventContent- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
moreLinkDidMount
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarMoreLinkMountInfo) => void- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
moreLinkWillUnmount
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarMoreLinkMountInfo) => void- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
morePopoverClassNames
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarMorePopoverRenderInfo) => CalendarEventClassNames- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
morePopoverContent
RuntimeOptional
Replaces the popover's default event-list content.
- Type
(info: CalendarMorePopoverRenderInfo) => CalendarEventContent- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
morePopoverDidMount
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarMorePopoverMountInfo) => void- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
morePopoverWillUnmount
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarMorePopoverMountInfo) => void- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
multiMonth
RuntimeOptional
Responsive multi-month and year-planner configuration. Both views reuse the standard month event, selection, drag, resize, and event-source pipelines.
- Type
{ /** Number of months shown by `multi-month`. Defaults to 3. */ durationMonths?: number; /** Fixed grid column count, or responsive automatic columns. */ columns?: 'auto' | number; /** Minimum responsive month-panel width in pixels. Defaults to 280. */ minimumMonthWidth?: number; /** Gap between month panels in pixels. Defaults to 16. */ gap?: number; /** Panel count that activates browser render virtualization. Defaults to 6. */ virtualizationThreshold?: number; }- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
navLinks
RuntimeOptional
Makes date and week labels navigable.
- Type
boolean- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
nowIndicator
RuntimeOptional
Display the current-time marker in time-grid views.
- Type
boolean- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
nowIndicatorClassNames
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarNowIndicatorRenderInfo) => CalendarEventClassNames- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
nowIndicatorContent
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarNowIndicatorRenderInfo) => CalendarEventContent- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
nowIndicatorDidMount
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarNowIndicatorMountInfo) => void- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
nowIndicatorWillUnmount
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarNowIndicatorMountInfo) => void- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
pluginOptions
Construction onlyOptional
Per-plugin configuration keyed by the plugin's unique name.
- Type
Readonly<Record<string, unknown>>- Category
- Data & integrations
- Availability
- Standard
- Documented default
- Package default / not specified
plugins
Construction onlyOptional
Optional feature integrations. Core month/week/day/list views and simple recurrence do not require plugins.
- Type
readonly CalendarPlugin[]- Category
- Data & integrations
- Availability
- Standard
- Documented default
- Package default / not specified
progressiveEventRendering
RuntimeOptional
Render asynchronous sources individually instead of one final batch.
- Type
boolean- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
rerenderDelay
RuntimeOptional
Debounce calendar renders by this many milliseconds. `null` disables it.
- Type
number | null- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
resourceAssignmentAllow
PremiumRuntimeOptional
Optional final approval hook for assignments. Promise results use the existing optimistic pending/rollback lifecycle.
- Type
(context: CalendarResourceAssignmentContext) => boolean | void | CalendarResourceAssignmentDecision | Promise<boolean | void | CalendarResourceAssignmentDecision>- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceCellClassNames
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceClassNameInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceCellContent
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceContentInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceCellDidMount
PremiumRuntimeOptional
Typed calendar option.
- Type
(info: CalendarResourceMountInfo) => void- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceCellWillUnmount
PremiumRuntimeOptional
Typed calendar option.
- Type
(info: CalendarResourceMountInfo) => void- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceColumnDividerClassNames
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceClassNameInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceColumnHeaderClassNames
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceClassNameInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceColumnHeaderContent
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceContentInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceColumnHeaderDidMount
PremiumRuntimeOptional
Typed calendar option.
- Type
(info: CalendarResourceMountInfo) => void- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceColumnHeaderInnerClassNames
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceClassNameInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceColumnHeaderWillUnmount
PremiumRuntimeOptional
Typed calendar option.
- Type
(info: CalendarResourceMountInfo) => void- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceDayHeaderClassNames
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceClassNameInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceDayHeaderContent
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceContentInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceDayHeaderDidMount
PremiumRuntimeOptional
Typed calendar option.
- Type
(info: CalendarResourceMountInfo) => void- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceDayHeaderWillUnmount
PremiumRuntimeOptional
Typed calendar option.
- Type
(info: CalendarResourceMountInfo) => void- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceExpanderClassNames
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceClassNameInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceFilter
PremiumRuntimeOptional
Non-mutating client-side visibility predicate shared by resource views.
- Type
CalendarResourceFilter- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceGroupField
PremiumRuntimeOptional
compatibility single Resource Timeline grouping field.
- Type
string- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceGroupFields
PremiumRuntimeOptional
Nested Resource Timeline grouping tiers. These run after column-level groups and before `resourceGroupField` when both are configured.
- Type
readonly (string | CalendarResourceGroupDefinition)[]- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceGroupHeaderClassNames
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceClassNameInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceGroupHeaderContent
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceContentInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceGroupHeaderDidMount
PremiumRuntimeOptional
Typed calendar option.
- Type
(info: CalendarResourceMountInfo) => void- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceGroupHeaderInnerClassNames
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceClassNameInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceGroupHeaderWillUnmount
PremiumRuntimeOptional
Typed calendar option.
- Type
(info: CalendarResourceMountInfo) => void- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceGroupLaneClassNames
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceClassNameInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceGroupLaneContent
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceContentInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceGroupLaneDidMount
PremiumRuntimeOptional
Typed calendar option.
- Type
(info: CalendarResourceMountInfo) => void- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceGroupLaneInnerClassNames
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceClassNameInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceGroupLaneWillUnmount
PremiumRuntimeOptional
Typed calendar option.
- Type
(info: CalendarResourceMountInfo) => void- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceGroupOrder
PremiumRuntimeOptional
Default order for group values when a tier does not define its own.
- Type
'asc' | 'desc' | ((left: unknown, right: unknown) => number)- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceHeaderRowClassNames
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceClassNameInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceIndentClassNames
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceClassNameInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceLaneBottomClassNames
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceClassNameInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceLaneBottomContent
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceContentInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceLaneClassNames
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceClassNameInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceLaneContent
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceContentInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceLaneDidMount
PremiumRuntimeOptional
Typed calendar option.
- Type
(info: CalendarResourceMountInfo) => void- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceLaneTopClassNames
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceClassNameInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceLaneTopContent
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceContentInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceLaneWillUnmount
PremiumRuntimeOptional
Typed calendar option.
- Type
(info: CalendarResourceMountInfo) => void- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceOrder
PremiumRuntimeOptional
Stable sibling ordering in every resource view. Source order is preserved when omitted.
- Type
CalendarResourceOrderInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceRowClassNames
PremiumRuntimeOptional
Typed calendar option.
- Type
CalendarResourceClassNameInput- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resources
PremiumConstruction onlyOptional
Typed calendar option.
- Type
Array<CalendarResource>- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceSources
PremiumConstruction onlyOptional
Typed calendar option.
- Type
readonly CalendarResourceSource[]- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceSummaryContent
PremiumRuntimeOptional
Replaces the default text shown on a collapsed parent resource. Returned strings and numbers are assigned through `textContent`.
- Type
(info: CalendarResourceSummaryContentInfo) => string | number | null | undefined- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceTimeGrid
PremiumRuntimeOptional
Resource TimeGrid column virtualization. Virtualization activates when the flattened date × resource column count reaches the threshold.
- Type
{ /** Fixed resource column width in pixels. Defaults to 168. */ columnWidth?: number; /** Minimum column count that activates virtualization. Defaults to 24. */ virtualizationThreshold?: number; /** Extra columns rendered before and after the viewport. Defaults to 2. */ overscan?: number; }- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
resourceTimeline
PremiumRuntimeOptional
Resource Timeline configuration. Resources are rows and calendar days are horizontal slots. Both axes virtualize independently for large schedules.
- Type
{ /** Calendar-day duration starting at `viewDate`. Defaults to 30. */ durationDays?: number; /** Fixed width of each day slot in pixels. Defaults to 88. */ slotWidth?: number; /** Minimum resource row height in pixels. Defaults to 52. */ rowMinHeight?: number; /** Width of the sticky resource-name area in pixels. Defaults to 220. */ resourceAreaWidth?: number; /** Resource count that activates vertical virtualization. Defaults to 50. */ resourceVirtualizationThreshold?: number; /** Day-slot count that activates horizontal virtualization. Defaults to 60. */ slotVirtualizationThreshold?: number; /** Extra resource rows mounted above and below the viewport. Defaults to 6. */ resourceOverscan?: number; /** Extra day slots mounted before and after the viewport. Defaults to 3. */ slotOverscan?: number; /** * Sticky, text-only resource columns. An omitted value preserves the * default resource-title column. */ resourceAreaColumns?: readonly CalendarResourceAreaColumn[]; /** * Whether nested resources start expanded in every resource scheduling * view. Defaults to true. */ resourcesInitiallyExpanded?: boolean; }- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
scrollTime
RuntimeOptional
Initial time-grid scroll position in `HH:mm` format.
- Type
string- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
scrollTimeReset
RuntimeOptional
Reapply `scrollTime` after date navigation. Defaults to true.
- Type
boolean- Category
- Views & time
- Availability
- Standard
- Documented default
- true
select
RuntimeOptional
Called after a selection is committed.
- Type
(selection: CalendarSelection) => void- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
selectable
RuntimeOptional
Enables pointer, touch, and keyboard range selection.
- Type
boolean- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
selectAllow
RuntimeOptional
Final synchronous approval hook for user-created and programmatic ranges.
- Type
(selection: CalendarSelection) => boolean- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
selectConstraint
RuntimeOptional
Additional selection-only scheduling constraints.
- Type
CalendarSelectConstraint- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
selection
RuntimeOptional
Typed calendar option.
- Type
CalendarSelectionOptions- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
selectLongPressDelay
RuntimeOptional
Touch hold duration before range selection starts.
- Type
number- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
selectMinDistance
RuntimeOptional
Minimum mouse movement before range selection starts.
- Type
number- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
selectMirror
RuntimeOptional
Draw an event-like TimeGrid placeholder while selecting.
- Type
boolean- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
selectOverlap
RuntimeOptional
Controls selection intersections with rendered events.
- Type
CalendarSelectOverlap- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
showNonCurrentDates
RuntimeOptional
Render leading/trailing dates from adjacent months. Defaults to true.
- Type
boolean- Category
- Core configuration
- Availability
- Standard
- Documented default
- true
slotDuration
RuntimeOptional
Time-grid slot duration in minutes. Defaults to 60.
- Type
number- Category
- Views & time
- Availability
- Standard
- Documented default
- 60
slotEventOverlap
RuntimeOptional
Allow timed events to visually overlap. Defaults to false.
- Type
boolean- Category
- Views & time
- Availability
- Standard
- Documented default
- false
slotHeaderClass
RuntimeOptional
Typed calendar option.
- Type
CalendarLayoutClassNameInput- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
slotHeaderDividerClass
RuntimeOptional
Typed calendar option.
- Type
CalendarLayoutClassNameInput<CalendarStickyClassInfo>- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
slotHeaderRowClass
RuntimeOptional
Typed calendar option.
- Type
CalendarLayoutClassNameInput- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
slotLabelClassNames
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarSlotRenderInfo) => CalendarEventClassNames- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
slotLabelContent
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarSlotRenderInfo) => CalendarEventContent- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
slotLabelDidMount
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarSlotMountInfo) => void- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
slotLabelFormat
RuntimeOptional
DatePipe-compatible time-grid label format. Defaults to `hh:mm a`.
- Type
string- Category
- Views & time
- Availability
- Standard
- Documented default
- `hh:mm a`
slotLabelTiers
RuntimeOptional
Optional multi-tier TimeGrid axis. The first tier is the primary tier.
- Type
readonly CalendarSlotLabelTier[]- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
slotLabelWillUnmount
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarSlotMountInfo) => void- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
slotLaneClassNames
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarSlotRenderInfo) => CalendarEventClassNames- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
slotLaneDidMount
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarSlotMountInfo) => void- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
slotLaneWillUnmount
RuntimeOptional
Typed calendar option.
- Type
(info: CalendarSlotMountInfo) => void- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
slotMaxTime
RuntimeOptional
Exclusive latest time shown by day and week time grids. `24:00` is supported. Per-view `hourSegmentRange` remains authoritative when configured.
- Type
string- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
slotMinTime
RuntimeOptional
Earliest time shown by day and week time grids. Per-view `hourSegmentRange` remains authoritative when configured.
- Type
string- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
snapDuration
RuntimeOptional
Drag, resize, and selection snap duration in minutes.
- Type
number- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
startOfWeek
RuntimeOptional
First weekday, Sunday = 0. Defaults to the active locale's week data.
- Type
number- Category
- Localization
- Availability
- Standard
- Documented default
- the active locale's week data
styleUrl
Construction onlyOptional
Typed calendar option.
- Type
string- Category
- Appearance & layout
- Availability
- Standard
- Documented default
- Package default / not specified
tableBodyClass
RuntimeOptional
Typed calendar option.
- Type
CalendarLayoutClassNameInput<CalendarTableClassInfo>- Category
- Appearance & layout
- Availability
- Standard
- Documented default
- Package default / not specified
tableClass
RuntimeOptional
v7-compatible table/layout class hooks.
- Type
CalendarLayoutClassNameInput<CalendarTableClassInfo>- Category
- Appearance & layout
- Availability
- Standard
- Documented default
- Package default / not specified
tableHeaderClass
RuntimeOptional
Typed calendar option.
- Type
CalendarLayoutClassNameInput<CalendarTableClassInfo & { readonly isSticky: boolean; }>- Category
- Appearance & layout
- Availability
- Standard
- Documented default
- Package default / not specified
tableHeaderSticky
RuntimeOptional
Keep table/date headers visible inside a constrained calendar.
- Type
boolean | 'auto'- Category
- Appearance & layout
- Availability
- Standard
- Documented default
- Package default / not specified
task
PremiumConstruction onlyOptional
Typed calendar option.
- Type
Array<TaskInterface>- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
taskSources
PremiumConstruction onlyOptional
Range-aware category sources consumed by the repeated-task views.
- Type
readonly CalendarTaskSource[]- Category
- Resources & tasks
- Availability
- Premium
- Documented default
- Package default / not specified
theme
RuntimeOptional
Stock visual theme. `standard` preserves the legacy default.
- Type
CalendarThemeName- Category
- Appearance & layout
- Availability
- Standard
- Documented default
- Package default / not specified
themeTokens
RuntimeOptional
Per-instance theme token overrides exposed as CSS custom properties.
- Type
CalendarThemeTokens- Category
- Appearance & layout
- Availability
- Standard
- Documented default
- Package default / not specified
timeGridMoreLinkClick
RuntimeOptional
Behavior of a TimeGrid overlap link. Defaults to `popover`.
- Type
CalendarTimeGridMoreLinkAction- Category
- Views & time
- Availability
- Standard
- Documented default
- `popover`
timeGridMoreLinkContent
RuntimeOptional
Replaces the TimeGrid overlap-link text.
- Type
(info: Omit<CalendarTimeGridMoreLinkInfo, 'el' | 'jsEvent'>) => CalendarEventContent- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
timeZone
RuntimeOptional
IANA time zone used for rendering and calendar arithmetic. Defaults to the runtime's local zone.
- Type
CalendarTimeZone- Category
- Localization
- Availability
- Standard
- Documented default
- the runtime's local zone
titleFormat
RuntimeOptional
Date-pipe format used by the toolbar title.
- Type
string- Category
- Toolbar
- Availability
- Standard
- Documented default
- Package default / not specified
toolbarClass
RuntimeOptional
Typed calendar option.
- Type
CalendarToolbarClassNameInput<CalendarToolbarRenderInfo>- Category
- Toolbar
- Availability
- Standard
- Documented default
- Package default / not specified
toolbarElements
RuntimeOptional
Safe custom elements referenced by name in a toolbar definition.
- Type
Readonly<Record<string, CalendarToolbarElement>>- Category
- Toolbar
- Availability
- Standard
- Documented default
- Package default / not specified
toolbarSectionClass
RuntimeOptional
Typed calendar option.
- Type
CalendarToolbarClassNameInput<CalendarToolbarSectionRenderInfo>- Category
- Toolbar
- Availability
- Standard
- Documented default
- Package default / not specified
toolbarTitleClass
RuntimeOptional
Typed calendar option.
- Type
CalendarToolbarClassNameInput<CalendarToolbarSectionRenderInfo>- Category
- Toolbar
- Availability
- Standard
- Documented default
- Package default / not specified
unselect
RuntimeOptional
Called when the current selection is cleared.
- Type
(info: CalendarUnselectInfo) => void- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
unselectAuto
RuntimeOptional
Clear the active selection when clicking elsewhere.
- Type
boolean- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
unselectCancel
RuntimeOptional
CSS selector whose descendants do not clear the active selection.
- Type
string- Category
- Events & interaction
- Availability
- Standard
- Documented default
- Package default / not specified
validRange
RuntimeOptional
Navigation and interaction boundary. `start` is inclusive and `end` is exclusive.
- Type
CalendarValidRange- Category
- Core configuration
- Availability
- Standard
- Documented default
- Package default / not specified
view
RuntimeOptional
Typed calendar option.
- Type
Views- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
viewClass
RuntimeOptional
v7-compatible alias of `viewClassNames`.
- Type
CalendarViewClassNameInput- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
viewClassNames
RuntimeOptional
Classes applied to the active view root for the lifetime of that view.
- Type
CalendarViewClassNameInput- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
viewDate
RuntimeOptional
Typed calendar option.
- Type
string | Date- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
viewDidMount
RuntimeOptional
Called exactly once after a view root is mounted.
- Type
(info: CalendarViewRenderInfo) => void | Promise<void>- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
views
Construction onlyOptional
Named views backed by the shared DayGrid, TimeGrid, list, timeline, or multi-month engines. Custom names are accepted by `view` and `setView`.
- Type
Readonly<Record<string, CalendarCustomViewDefinition>>- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
viewWillUnmount
RuntimeOptional
Called exactly once immediately before a mounted view root is replaced.
- Type
(info: CalendarViewRenderInfo) => void | Promise<void>- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
weekDaysFormat
RuntimeOptional
Typed calendar option.
- Type
string- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
weekends
RuntimeOptional
Set to false to omit Sunday and Saturday in addition to `hiddenDays`.
- Type
boolean- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
weekNumberCalculation
RuntimeOptional
ISO, locale week, or custom week-number calculation.
- Type
'ISO' | 'local' | ((date: Date) => string | number)- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
weekNumbers
RuntimeOptional
Show week numbers in month and week views.
- Type
boolean- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified
weekView
RuntimeOptional
Typed calendar option.
- Type
{ hourSegment?: number; hourSegmentRange?: boolean | { start: string; end: string; }; segmentHeight?: number; dragTolerance?: number; resizeTolerance?: number; /** @deprecated Use `dragTolerance`. */ dragTolarance?: number; /** @deprecated Use `resizeTolerance`. */ resizeTolarance?: number; }- Category
- Views & time
- Availability
- Standard
- Documented default
- Package default / not specified