API Reference

MonthViewRootProps

interface

Props accepted by MonthView.Root.

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

Prop Type Default Description

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

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

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

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

month PlainYearMonth — The controlled visible month. When provided, the component is controlled.

defaultMonth PlainYearMonth — The initial visible month (uncontrolled).

onMonthChange (month: PlainYearMonth) => void — Called when the visible month changes via navigation or focus movement. Not called on initial mount.

children React.ReactNode — React children.

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