PickersLayout API

API reference docs for the React PickersLayout 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 layout

Import

import { PickersLayout } from '@mui/x-date-pickers/PickersLayout';
// or
import { PickersLayout } from '@mui/x-date-pickers';
// or
import { PickersLayout } 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

componentsDeprecated

Overridable components.

Deprecated - Please use slots.

Type:object

Default:{}

componentsPropsDeprecated

The props used for each component slot.

Deprecated - Please use slotProps.

Type:object

Default:{}

orientation

Force rendering in particular orientation.

Type:'landscape' | 'portrait'

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:{}

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

ActionBar

Custom component for the action bar, it is placed below the picker views.

Default component: PickersActionBar

Layout

Custom component for wrapping the layout. It wraps the toolbar, views, action bar, and shortcuts.

Shortcuts

Custom component for the shortcuts.

Default component: PickersShortcuts

Tabs

Tabs enabling toggling between views.

Toolbar

Custom component for the toolbar. It is placed above the picker views.

CSS classes

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

.MuiPickersLayout-actionBar

Styles applied to the action bar.

Rule name:actionBar

.MuiPickersLayout-contentWrapper

Styles applied to the contentWrapper element (which contains the tabs and the view itself).

Rule name:contentWrapper

.MuiPickersLayout-landscape

Styles applied to the root element in landscape orientation.

Rule name:landscape

.MuiPickersLayout-root

Styles applied to the root element.

Rule name:root

.MuiPickersLayout-shortcuts

Styles applied to the shortcuts container.

Rule name:shortcuts

.MuiPickersLayout-tabs

Styles applied to the tabs.

Rule name:tabs

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.