API Reference

WeeksViewRootProps

interface

Props accepted by WeeksView.Root.

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

Prop Type Default Description

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

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

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

onFirstWeekChange (date: PlainDate) => void — Called when the first visible week changes via navigation or focus movement.

scrollBy "row" | "page" "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.

overflowBehavior OverflowBehavior "unbounded" How navigation behaves at min/max bounds.

onWindowChange (info: WindowInfo) => void — 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	—	The controlled first visible week. When provided, the component is controlled.
defaultFirstWeek	FirstWeekSpec	—	The initial first visible week (uncontrolled).
onFirstWeekChange	(date: PlainDate) => void	—	Called when the first visible week changes via navigation or focus movement.
scrollBy	"row" \| "page"	"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.
overflowBehavior	OverflowBehavior	"unbounded"	How navigation behaves at `min`/`max` bounds.
onWindowChange	(info: WindowInfo) => void	—	Called when the visible window changes.
children	React.ReactNode	—	React children.