DEVELOPER REFERENCE · v4.0.0

CalendarYearGrid API

Props, callbacks and methods. Select an underlined type to explore its fields, allowed values and callback arguments.

CalendarYearGrid8 props2 callbacks0 methods

CalendarYearGrid props
Name	Type	Description
`month`Required	`ISODateString`Inspect type	Month currently displayed, expressed as a library ISO date string.
`system`Optional	`DisplayCalendarSystem \| undefined`Inspect type	Calendar system used to render month and year values.
`referenceDate`Optional	`ISODateString \| undefined`Inspect type	Reference ISO date used for Today and relative calendar presentation.
`minDate`Optional	`ISODateString \| undefined`Inspect type	Earliest selectable calendar date in the library ISO date representation.
`maxDate`Optional	`ISODateString \| undefined`Inspect type	Latest selectable calendar date in the library ISO date representation.
`isMonthDisabled`Optional	`((month: ISODateString) => boolean) \| undefined`Inspect type	Return true to prevent selection of the supplied month.
`locale`Required	`string`	Locale identifier or localized label configuration used for formatting and accessible text.
`ariaLabel`Required	`string`	Accessible name announced by assistive technology.

CalendarYearGrid events and callbacks
Name	Type	Description
`onSelect`Required	`(month: ISODateString) => void`Inspect type	Called when the user selects an item. The signature identifies the selected value and any additional context.
`onEscape`Required	`() => void`Inspect type	Handles Escape from the month/year grid.

No component-specific imperative methods. Use props and callbacks to control this component.