| format | "PlainDate" | "PlainDate" | The value format used for date serialization. Determines the type of
value, defaultValue, min, max, and callback parameters. |
| min | PlainDate | — | Earliest selectable date. Dates before this are disabled. |
| max | PlainDate | — | Latest selectable date. Dates after this are disabled. |
| disabled | boolean | false | When true, the entire calendar is disabled. |
| readOnly | boolean | false | When true, the calendar is read-only. Keyboard navigation still works
but selection is prevented. |
| isDateDisabled | (date: PlainDate) => boolean | — | Callback to disable individual dates. Return true to disable a date.
Called in addition to min/max bounds checking. |
| timeZone | string | The system's current time zone. | IANA time zone identifier used for date/time conversions. |
| locale | string | "en-US" | BCP 47 locale string used for formatting month names, weekday labels,
and other locale-sensitive output. |
| temporal | TemporalNamespace | — | The Temporal implementation to use. Not bundled — provide a Temporal
namespace (e.g. from temporal-polyfill or @js-temporal/polyfill) unless
the host exposes native Temporal. See RootOwnProps.temporal for links. |
| weekStartDay | WeekStartDay | 0 | Day of the week the calendar grid starts on.
0 = Sunday, 1 = Monday, ..., 6 = Saturday. |
| children | React.ReactNode | — | React children. |
| selectionMode | "single" | "range" | "multiple" | "single" | |
| value | PlainDate | PlainDate[] | DateRange<"PlainDate"> | null | — | The controlled selected date. Pass null to clear. |
| defaultValue | PlainDate | PlainDate[] | DateRange<"PlainDate"> | — | |
| onValueChange | ((value: PlainDate | null, meta: ValueChangeMeta<PlainDate | null>) => void) | ((value: PlainDate | null, meta: ValueChangeMeta<PlainDate | null>) => void) | ((value: DateRange<"PlainDate"> | null, meta: ValueChangeMeta<DateRange<"PlainDate"> | null>) => void) | ((value: DateRange<"PlainDate"> | null, meta: ValueChangeMeta<DateRange<"PlainDate"> | null>) => void) | ((value: PlainDate[], meta: ValueChangeMeta<PlainDate[]>) => void) | ((value: PlainDate[], meta: ValueChangeMeta<PlainDate[]>) => void) | — | |
| 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. |
| ref | React.Ref<WeeksViewRootHandle> | undefined | — | Allows getting a ref to the component instance.
Once the component unmounts, React will set ref.current to null
(or call the ref with null if you passed a callback ref). |
| key | React.Key | null | undefined | — | |