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

For examples and details on the usage of this React component, visit the component demo pages:

Import

import PickersLayout from '/packages/x-date-pickers/src/PickersLayout';
// or
import { PickersLayout } from '/packages/x-date-pickers/src';
Learn about the difference by reading this guide on minimizing bundle size.

Props

components

Overridable components.

Type:

object

Default:

{}

componentsProps

The props used for each component slot.

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.

Type:

object

Default:

{}

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.


.MuiPickersLayout-rootroot

Styles applied to the root element.


.MuiPickersLayout-landscapelandscape

Styles applied to the root element in landscape orientation.


.MuiPickersLayout-contentWrappercontentWrapper

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


.MuiPickersLayout-toolbartoolbar

Styles applied to the toolbar.


.MuiPickersLayout-actionBaractionBar

Styles applied to the action bar.


.MuiPickersLayout-tabstabs

Styles applied to the tabs.


.MuiPickersLayout-shortcutsshortcuts

Styles applied to the shortcuts container.


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

Slots

actionBar

Default: PickersActionBar

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


layout

Default:

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


shortcuts

Default: PickersShortcuts

Description: Custom component for the shortcuts.


tabs

Default:

Description: Tabs enabling toggling between views.


toolbar

Default:

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


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