| 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. |
Guides
Components
Components
- CalendarProvider
- DateString
- DayButton
- DayCellTemplate
- Grid
- GridBody
- GridHeader
- GridHeaderCell
- MonthSeparator
- MonthSeparatorCell
- MonthSeparatorMonth
- MonthSeparatorRow
- MonthSeparatorWeekCount
- MonthSeparatorYear
- MonthView
- MonthViewRoot
- MonthYearString
- NextMonthButton
- NextWeeksButton
- PrevMonthButton
- PrevWeeksButton
- RangeEndDragHandle
- RangePreview
- RangeSelected
- RangeStartDragHandle
- TimeString
- WeekCount
- WeekNumberCell
- WeekNumberHeader
- WeeksView
- WeeksViewRoot
- WeekTemplate
Hooks
Types
- CalendarProviderProps
- CalendarStableContextValue
- CalendarStateContextValue
- DateRange
- DateStringProps
- DateStringState
- DateValueObject
- DayButtonProps
- DayButtonState
- DayCellTemplateProps
- DayCellTemplateState
- DragHandleOwnProps
- DragHandleState
- FirstWeekSpec
- GridBodyProps
- GridBodyState
- GridHeaderCellProps
- GridHeaderCellState
- GridHeaderProps
- GridHeaderState
- GridProps
- GridState
- MonthData
- MonthOutOfRangeBehavior
- MonthSeparatorState
- MonthViewProps
- MonthViewRootProps
- MonthViewStableContextValue
- MonthViewStateContextValue
- MonthYearStringProps
- MonthYearStringState
- NavButtonState
- NextMonthButtonProps
- NextWeeksButtonProps
- OutOfRangeBehavior
- OutsideDays
- PlainDateObject
- PrevMonthButtonProps
- PrevWeeksButtonProps
- RangeEndDragHandleProps
- RangeMode
- RangePreviewProps
- RangePreviewState
- RangeSelectedProps
- RangeSelectedState
- RangeStartDragHandleProps
- RawValueForFormat
- RootState
- ScrollToWeekSnap
- TemporalNamespace
- TimeStringProps
- TimeStringState
- ValueChangeMeta
- ValueForFormat
- ValueFormat
- ViewContextValue
- VisibleMonth
- WeekCountProps
- WeekCountState
- WeekDescriptor
- WeekNumberCellProps
- WeekNumberCellState
- WeekNumberHeaderProps
- WeekNumberHeaderState
- WeeksNavButtonOwnProps
- WeeksNavButtonState
- WeekStartDay
- WeeksViewProps
- WeeksViewRootHandle
- WeeksViewRootProps
- WeeksViewStableContextValue
- WeeksViewStateContextValue
- WeekTemplateProps
- WeekTemplateState
- WindowInfo