API Reference

MonthView

component

Defined in package/src/month-view.tsx:370

PropTypeDefaultDescription
formatF"PlainDate"The value format used for date serialization. Determines the type of value, defaultValue, min, max, and callback parameters.
minRawValueForFormat<F>Earliest selectable date. Dates before this are disabled.
maxRawValueForFormat<F>Latest selectable date. Dates after this are disabled.
disabledbooleanfalseWhen true, the entire calendar is disabled.
readOnlybooleanfalseWhen true, the calendar is read-only. Keyboard navigation still works but selection is prevented.
isDateDisabled(date: PlainDate) => booleanCallback to disable individual dates. Return true to disable a date. Called in addition to min/max bounds checking.
timeZonestringThe system's current time zone.IANA time zone identifier used for date/time conversions.
localestring"en-US"BCP 47 locale string used for formatting month names, weekday labels, and other locale-sensitive output.
temporalTemporalNamespaceCustom Temporal namespace for environments without native Temporal support.
weekStartDayWeekStartDay0Day of the week the calendar grid starts on. 0 = Sunday, 1 = Monday, ..., 6 = Saturday.
childrenReact.ReactNodeReact children.
selectionMode"single" | "range" | "multiple""single"
valueRawValueForFormat<F> | DateRange<F> | RawValueForFormat<F>[] | nullThe controlled selected date. Pass null to clear.
defaultValueRawValueForFormat<F> | DateRange<F> | RawValueForFormat<F>[]
onValueChange((value: RawValueForFormat<F> | null, meta: ValueChangeMeta<RawValueForFormat<F> | null>) => void) | ((value: RawValueForFormat<F> | null, meta: ValueChangeMeta<RawValueForFormat<F> | null>) => void) | ((value: DateRange<F> | null, meta: ValueChangeMeta<DateRange<F> | null>) => void) | ((value: DateRange<F> | null, meta: ValueChangeMeta<DateRange<F> | null>) => void) | ((value: RawValueForFormat<F>[], meta: ValueChangeMeta<RawValueForFormat<F>[]>) => void) | ((value: RawValueForFormat<F>[], meta: ValueChangeMeta<RawValueForFormat<F>[]>) => void)
numberOfMonthsnumber1Number of months to display simultaneously (1–12).
fixedWeeksbooleanfalseWhen true, always render 6 week rows per month grid. Prevents layout shifts when navigating between months.
outsideDaysOutsideDays"enabled"Controls how days from adjacent months are displayed.
overflowBehaviorMonthOverflowBehavior"unbounded"How month navigation behaves at min/max bounds. - "unbounded" — navigation is always allowed. - "stop" — navigation buttons disable at the boundary.
monthPlainYearMonthThe controlled visible month. When provided, the component is controlled.
defaultMonthPlainYearMonthThe initial visible month (uncontrolled).
onMonthChange(month: PlainYearMonth) => voidCalled when the visible month changes via navigation or focus movement. Not called on initial mount.