API Reference

WeeksViewRoot

component

Defined in package/src/weeks-view.tsx:90

PropTypeDefaultDescription
weekCount*numberNumber of week rows to display simultaneously.
firstWeekFirstWeekSpec | undefinedThe controlled first visible week. When provided, the component is controlled.
defaultFirstWeekFirstWeekSpec | undefinedThe initial first visible week (uncontrolled).
onFirstWeekChange((date: PlainDate) => void) | undefinedCalled when the first visible week changes via navigation or focus movement.
scrollBy"row" | "page" | undefined"row"How much to scroll per navigation step. - "row" — scroll one week row at a time. - "page" — scroll a full page (all visible rows) at a time.
outOfRangeBehaviorOutOfRangeBehavior | undefined"unbounded"How the visible window behaves at the min/max bounds. min/max always restrict which **days are selectable**; this controls whether the window may scroll beyond them, and how the edge is handled. See OutOfRangeBehavior. - "unbounded" — navigation is never restricted by min/max. - "stop" — navigation halts once the next step has no in-range day. - "stop-shrink" — like "stop", but the window shrinks at the edge. - "snap" — overshooting jumps snap the window edge to the last/first in-range week. - "snap-shrink" — snap to the boundary, shrinking if still out of range.
onWindowChange((info: WindowInfo) => void) | undefinedCalled when the visible window changes.
childrenReact.ReactNodeReact children.