Skip to content
Influence MUI X's 2024 roadmap! Participate in the latest Developer Survey

PickersCalendarHeader API

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

Component demos

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

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

format

Format used to display the date.

Type:string

Default:`${adapter.formats.month} ${adapter.formats.year}`

slotProps

The props used for each component slot.

Type:object

Default:{}

slots

Overridable component slots.

See Slots API below for more details.

Type:object

Default:{}

sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:Array<func
| object
| bool>
| func
| object

The component cannot hold a ref.

Slots

switchViewButton

Button displayed to switch between different calendar views.

Class name: .MuiPickersCalendarHeader-switchViewButton

Default component: IconButton

switchViewIcon

Icon displayed in the SwitchViewButton. Rotated by 180° when the open view is 'year'.

Class name: .MuiPickersCalendarHeader-switchViewIcon

Default component: ArrowDropDown

previousIconButton

Button allowing to switch to the left view.

Default component: IconButton

nextIconButton

Button allowing to switch to the right view.

Default component: IconButton

leftArrowIcon

Icon displayed in the left view switch button.

Default component: ArrowLeft

rightArrowIcon

Icon displayed in the right view switch button.

Default component: ArrowRight

CSS classes

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

.MuiPickersCalendarHeader-label

Styles applied to the label element.

Rule name:label

.MuiPickersCalendarHeader-labelContainer

Styles applied to the label container element.

Rule name:labelContainer

.MuiPickersCalendarHeader-root

Styles applied to the root element.

Rule name:root


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