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.
overflowBehaviorOverflowBehavior | undefined"unbounded"How navigation behaves at min/max bounds.
onWindowChange((info: WindowInfo) => void) | undefinedCalled when the visible window changes.
childrenReact.ReactNodeReact children.