Skip to content

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

NameTypeDefaultDescription
classesobject-

Override or extend the styles applied to the component.

See CSS API below for more details.

formatstring`${adapter.formats.month} ${adapter.formats.year}`

Format used to display the date.

slotPropsobject{}

The props used for each component slot.

slotsobject{}

Overridable component slots.

See Slots API below for more details.

sxArray<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 component cannot hold a ref.

Slots

Slot nameClass nameDefault componentDescription
switchViewButton.MuiPickersCalendarHeader-switchViewButtonIconButtonButton displayed to switch between different calendar views.
switchViewIcon.MuiPickersCalendarHeader-switchViewIconArrowDropDownIcon displayed in the SwitchViewButton. Rotated by 180° when the open view is 'year'.
previousIconButtonIconButtonButton allowing to switch to the left view.
nextIconButtonIconButtonButton allowing to switch to the right view.
leftArrowIconArrowLeftIcon displayed in the left view switch button.
rightArrowIconArrowRightIcon displayed in the right view switch button.

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 nameRule nameDescription
.MuiPickersCalendarHeader-labellabelStyles applied to the label element.
.MuiPickersCalendarHeader-labelContainerlabelContainerStyles applied to the label container element.
.MuiPickersCalendarHeader-rootrootStyles applied to the root element.

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