PickersCalendarHeader API

API reference docs for the React PickersCalendarHeader component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Custom slots and subcomponents

Import

import { PickersCalendarHeader } from '@mui/x-date-pickers/PickersCalendarHeader';
// or
import { PickersCalendarHeader } from '@mui/x-date-pickers';
// or
import { PickersCalendarHeader } from '@mui/x-date-pickers-pro';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

Name	Type	Default	Description
currentMonth*	{}	-
maxDate*	{}	-
minDate*	{}	-
onMonthChange*	func	-	Signature:`function(date: any) => void`
reduceAnimations*	bool	-
timezone*	string	-
view*	'day' \| 'month' \| 'year'	-
views*	Array<'day' \| 'month' \| 'year'>	-
classes	Partial	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
disabled	bool	-
disableFuture	bool	-
disablePast	bool	-
format	string	`${adapter.formats.month} ${adapter.formats.year}`	Format used to display the date.
labelId	string	-	Id of the calendar text element. It is used to establish an `aria-labelledby` relationship with the calendar `grid` element.
onViewChange	func	-	Signature:`function(view: DateView) => void`
slotProps	PickersCalendarHeaderSlotProps	{}	The props used for each component slot.
slots	PickersCalendarHeaderSlots	{}	Overridable component slots. See Slots API below for more details.
sx	Array<func \| object \| bool> \| func \| object	-	The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

The ref is forwarded to the root element.

Theme default props

You can use MuiPickersCalendarHeader to change the default props of this component with the theme.

Slots

Slot name	Class name	Default component	Description
leftArrowIcon		`ArrowLeft`	Icon displayed in the left view switch button.
nextIconButton		`IconButton`	Button allowing to switch to the right view.
previousIconButton		`IconButton`	Button allowing to switch to the left view.
rightArrowIcon		`ArrowRight`	Icon displayed in the right view switch button.
switchViewButton	.MuiPickersCalendarHeader-switchViewButton	`IconButton`	Button displayed to switch between different calendar views.
switchViewIcon	.MuiPickersCalendarHeader-switchViewIcon	`ArrowDropDown`	Icon displayed in the SwitchViewButton. Rotated by 180° when the open view is `year`.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.MuiPickersCalendarHeader-label	label	Styles applied to the label element.
.MuiPickersCalendarHeader-labelContainer	labelContainer	Styles applied to the label container element.
.MuiPickersCalendarHeader-root	root	Styles applied to the root element.
.MuiPickersCalendarHeader-switchViewButton	switchViewButton	Styles applied to the switch view button element.
.MuiPickersCalendarHeader-switchViewIcon	switchViewIcon	Styles applied to the switch view icon element.

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.