| 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. |
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
- Temporal
- 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
- MonthOverflowBehavior
- MonthSeparatorState
- MonthViewProps
- MonthViewRootProps
- MonthViewStableContextValue
- MonthViewStateContextValue
- MonthYearStringProps
- MonthYearStringState
- NavButtonState
- NextMonthButtonProps
- NextWeeksButtonProps
- OutsideDays
- OverflowBehavior
- 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