API Reference

WeeksViewRootProps

interface

Props accepted by WeeksView.Root.

Defined in package/src/weeks-view-types.ts:12

Prop Type Default Description

weekCount* number — Number of week rows to display simultaneously.

firstWeek FirstWeekSpec | undefined — The controlled first visible week. When provided, the component is controlled.

defaultFirstWeek FirstWeekSpec | undefined — The initial first visible week (uncontrolled).

onFirstWeekChange ((date: PlainDate) => void) | undefined — Called 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.

outOfRangeBehavior OutOfRangeBehavior | 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) | undefined — Called when the visible window changes.

children React.ReactNode — React children.

Prop	Type	Default	Description
weekCount*	number	—	Number of week rows to display simultaneously.
firstWeek	FirstWeekSpec \| undefined	—	The controlled first visible week. When provided, the component is controlled.
defaultFirstWeek	FirstWeekSpec \| undefined	—	The initial first visible week (uncontrolled).
onFirstWeekChange	((date: PlainDate) => void) \| undefined	—	Called 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.
outOfRangeBehavior	OutOfRangeBehavior \| 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) \| undefined	—	Called when the visible window changes.
children	React.ReactNode	—	React children.