Skip to content

PickersLayout API

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

Demos

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

NameTypeDefaultDescription
isRtl*bool-

true if the application is in right-to-left direction.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

orientation'landscape'
| 'portrait'
-

Force rendering in particular orientation.

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
actionBar.MuiPickersLayout-actionBarPickersActionBarCustom component for the action bar, it is placed below the picker views.
layoutCustom component for wrapping the layout. It wraps the toolbar, views, action bar, and shortcuts.
shortcuts.MuiPickersLayout-shortcutsPickersShortcutsCustom component for the shortcuts.
tabs.MuiPickersLayout-tabsTabs enabling toggling between views.
toolbar.MuiPickersLayout-toolbarCustom 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.

Class nameRule nameDescription
.MuiPickersLayout-contentWrappercontentWrapperStyles applied to the contentWrapper element (which contains the tabs and the view itself).
.MuiPickersLayout-landscapelandscapeStyles applied to the root element in landscape orientation.
.MuiPickersLayout-rootrootStyles applied to the root element.

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