API reference

Controlled view. Workweek is Monday–Friday; a number is an n-day span (2–14). Pair with onViewChange.

Uncontrolled starting view. Ignored when view is set.

Fired whenever something asks to change the view, controlled or not.

Controlled anchor date. Navigation only reports via onDateChange.

Uncontrolled starting anchor; defaults to today.

Fired whenever something asks to move the anchor date.

Controlled events. Switches the internal store off — pair with onEventsChange.

The full next event list on every committed change (controlled mode).

Uncontrolled starting events. Omit for the sample events; pass [] to start empty.

Rows for view="timeline". Ignored by every other view. Empty by default — nothing renders without lanes.

Uncontrolled persistence: false is ephemeral, omit is localStorage, or bring an adapter.

Everything kloq keeps in localStorage. false keeps it in memory; a string namespaces the keys.

Optimistic seam — called on every committed change; a rejected promise reverts it.

Controlled-mode undo — ⌘Z calls it.

Controlled-mode redo — ⇧⌘Z calls it.

The visible range changed — [start, end). Fires once on mount, then on every view or date change.

Days to widen the range onRangeChange reports.

Hour height, event type size and padding together.

Live zoom as an index into ZOOM_STEPS (0–10; 4 = 100%).

px per hour, clamped to 8–480. Omit and density picks the base.

First hour the grid draws (0–23); with dayEndHour this clips the day.

Last hour the grid draws (exclusive).

Drag and keyboard snap grid.

Snap grid while ⌥ is held.

Shortest event a resize can produce.

0 = Sunday … 6 = Saturday.

Bounds (minDate / maxDate), a per-slot refusal and a per-event veto. Refused time draws as a hatch; every gesture honours it.

Working-hours tint boundaries; false disables the tint.

ISO 8601 week numbers in the gutter corner (time-grid views).

Collapse a week to three days, then to one, as the box narrows. view is never rewritten.

BCP 47 tag for every date and time label.

Force a 12- or 24-hour clock; omit and the locale decides.

Draw the calendar in this IANA zone instead of the browser's.

Extra gutter zone columns, in order.

Figma-style design mode (⌥D). { hint: false } hides the hint bar.

⌘K. false removes the binding and the menu; { commands } narrows the built-ins — spread BUILT_IN_COMMANDS and filter.

Let ⌘K / ⌘Z / ⌥D fire when focus is outside the calendar.

What ←/→ move by. PageUp / PageDown always step the range.

Who "you" are. Enables RSVP, per-person conflicts and showDeclinedEvents.

Draw events you have declined.

Overrides for the remappable mnemonics.

Scope a theme to this calendar and its portals — no <html> attribute, no localStorage. Omit to follow the page (setTheme). See Theming.

Pin this calendar's colour scheme regardless of the page's .dark. Omit to follow the page.

Slot overrides — swap any visual piece; the engine keeps the physics.

Id factory for everything the calendar creates.

Render the event layer on the server too. Only hydration-safe with controlled events, a date and displayTimeZone.

How an event maps onto a lane, for view="timeline". See Resources & lanes.

The timeline's visible span and slot size — controlled (pass start and end) or derived from the anchor date. See Resource timeline.

An event was clicked or opened from the keyboard, not dragged.

Double-click on an event; fires after onEventClick.

An empty slot was clicked, snapped like drag-create.

The selection changed, in reading order.

The gutter-corner zone labels were pressed; providing it renders them as a button.

"Customize shortcuts…" was pressed in the ? sheet.