PickersCalendarHeader API

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

Component 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

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

className

className applied to the root element.

Type:string

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.

Type:object

Default:{}

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.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

.MuiPickersCalendarHeader-root

Styles applied to the root element.

Rule name:root

.MuiPickersCalendarHeader-labelContainer

Styles applied to the label container element.

Rule name:labelContainer

.MuiPickersCalendarHeader-label

Styles applied to the label element.

Rule name:label

.MuiPickersCalendarHeader-switchViewButton

Styles applied to the switch view button element.

Rule name:switchViewButton

.MuiPickersCalendarHeader-switchViewIcon

Styles applied to the switch view icon element.

Rule name:switchViewIcon

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.

Slots

leftArrowIcon

Icon displayed in the left view switch button.

Default: ArrowLeft

nextIconButton

Button allowing to switch to the right view.

Default: IconButton

previousIconButton

Button allowing to switch to the left view.

Default: IconButton

rightArrowIcon

Icon displayed in the right view switch button.

Default: ArrowRight

switchViewButton

Button displayed to switch between different calendar views.

Default: IconButton

switchViewIcon

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

Default: ArrowDropDown