Skip to components
DEVELOPER REFERENCE · v4.0.0

CalendarHeader API

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

CalendarHeader10 props2 callbacks0 methods

Props10

CalendarHeader props
NameTypeDescription
labelRequiredstringLabel content or accessible name for the component, as rendered by this control.
previousLabelRequiredstringAccessible text for moving to the previous page or period.
nextLabelRequiredstringAccessible text for moving to the next page or period.
captionOptional
ComponentChildrenInspect type
Custom content replacing the calendar caption.
labelActionOptional
{ ariaLabel: string; onClick: () => void; } | undefinedInspect type
Optional action associated with the month/year label.
showLabelOptionalboolean | undefinedShows the current period label.
showPreviousOptionalboolean | undefinedShows the previous-period button.
showNextOptionalboolean | undefinedShows the next-period button.
previousDisabledOptionalboolean | undefinedDisables the previous-period button.
nextDisabledOptionalboolean | undefinedDisables the next-period button.

Events and callbacks2

CalendarHeader events and callbacks
NameTypeDescription
onPreviousRequired
() => voidInspect type
Requests navigation to the previous period.
onNextRequired
() => voidInspect type
Requests navigation to the next period.

Methods0

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