DocumentationAPI reference

Client options

Find a setting, inspect its contract, and connect it to a working example. core 1.1.6

248 entries

Select an entry for details and linked types.
allDayMaintainDuration

Preserve the exact duration when crossing all-day/timed surfaces.

allDaySlot

Show the all-day row in day and week views. Defaults to true.

allDayText

Text displayed for the all-day row. Defaults to `All day`.

aspectRatio

Width-to-content-height ratio used when no explicit height is set.

backgroundEventColor

Global background-event color.

branding

Controls the optional "Powered by WTS Calendar" documentation link.

businessHours

Visually marks business and non-business time. `true` uses Monday-Friday, 09:00-17:00. Set to false to disable the display.

buttonClass

Adds application CSS classes to the button. Define the CSS in your application; this hook does not create styles.

buttonDisplay

Controls whether toolbar buttons show text, icons, or both.

buttonGroupClass

Adds application CSS classes to the button group. Define the CSS in your application; this hook does not create styles.

buttonHints

Accessible labels for built-in actions, views, and custom buttons.

buttons

v7-style definitions that can add or override any toolbar button.

buttonText

Visible labels for built-in actions, views, and custom buttons.

colorScheme

Light/dark palette selection; `auto` follows the OS preference.

columnResizingPremium

Accessible column resizing for resource-based views.

container

The existing DOM element into which the calendar mounts. Framework wrappers supply this element for you.

contentHeight

Height of the active view body, excluding toolbars.

customButtons

Application-defined toolbar actions referenced by name in a toolbar.

customHTML

Legacy construction-time header customization. Expand the nested type before using its header element or ordering settings.

dateClick

Called when a date or time cell is activated without range selection.

dateDisambiguation

Resolves skipped or repeated wall-clock times at DST boundaries. Defaults to the Temporal-compatible behavior.

datesAboveResourcesPremium

Places date headings above resource headings in vertical resource views.

datesSet

Called after the initial visible range and every subsequent range change.

dayCellClassNames

Adds application CSS classes to the day cell. Define the CSS in your application; this hook does not create styles.

dayCellContent

Customizes the content rendered in the day cell. Check the linked return type for supported text or DOM-node values.

dayCellDidMount

Runs after the day cell is mounted. Use the callback payload to attach application behavior to that rendered element.

dayCellWillUnmount

Runs before the day cell is removed. Clean up listeners and application resources attached during its mount callback.

dayHeaderClassNames

Adds application CSS classes to the day header. Define the CSS in your application; this hook does not create styles.

dayHeaderContent

Customizes the content rendered in the day header. Check the linked return type for supported text or DOM-node values.

dayHeaderDidMount

Runs after the day header is mounted. Use the callback payload to attach application behavior to that rendered element.