API Reference

MonthViewRootProps

interface

Props accepted by MonthView.Root.

Defined in package/src/month-view-types.ts:10

Prop Type Default Description

numberOfMonths number | undefined 1 Number of months to display simultaneously (1–12).

fixedWeeks boolean | undefined false When true, always render 6 week rows per month grid. Prevents layout shifts when navigating between months.

outsideDays OutsideDays | undefined "enabled" Controls how days from adjacent months are displayed.

overflowBehavior MonthOverflowBehavior | undefined "unbounded" How month navigation behaves at min/max bounds. - "unbounded" — navigation is always allowed. - "stop" — navigation buttons disable at the boundary.

month PlainYearMonth | undefined — The controlled visible month. When provided, the component is controlled. Interpreted in the ISO calendar (the year/month are read as ISO values). The locale only affects how the month is displayed, so this value round-trips directly with onMonthChange.

defaultMonth PlainYearMonth | undefined — The initial visible month (uncontrolled). Interpreted in the ISO calendar.

onMonthChange ((month: PlainYearMonth) => void) | undefined — Called when the visible month changes via navigation or focus movement. Not called on initial mount. The argument is an ISO PlainYearMonth.

children React.ReactNode — React children.

Prop	Type	Default	Description
numberOfMonths	number \| undefined	1	Number of months to display simultaneously (1–12).
fixedWeeks	boolean \| undefined	false	When `true`, always render 6 week rows per month grid. Prevents layout shifts when navigating between months.
outsideDays	OutsideDays \| undefined	"enabled"	Controls how days from adjacent months are displayed.
overflowBehavior	MonthOverflowBehavior \| undefined	"unbounded"	How month navigation behaves at `min`/`max` bounds. - `"unbounded"` — navigation is always allowed. - `"stop"` — navigation buttons disable at the boundary.
month	PlainYearMonth \| undefined	—	The controlled visible month. When provided, the component is controlled. Interpreted in the ISO calendar (the year/month are read as ISO values). The `locale` only affects how the month is displayed, so this value round-trips directly with onMonthChange.
defaultMonth	PlainYearMonth \| undefined	—	The initial visible month (uncontrolled). Interpreted in the ISO calendar.
onMonthChange	((month: PlainYearMonth) => void) \| undefined	—	Called when the visible month changes via navigation or focus movement. Not called on initial mount. The argument is an ISO `PlainYearMonth`.
children	React.ReactNode	—	React children.