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:

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

Name	Type	Default	Description
isRtl*	bool	-	`true` if the application is in right-to-left direction.
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
disabled	bool	false	If `true`, the component is disabled. When disabled, the value cannot be changed and no interaction is possible.
orientation	'landscape' \| 'portrait'	-	Force rendering in particular orientation.
readOnly	bool	false	If `true`, the component is read-only. When read-only, the value cannot be changed but the user can interact with the interface.
slotProps	object	{}	The props used for each component slot.
slots	object	{}	Overridable component slots. See Slots API below for more details.
sx	Array<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 name	Class name	Default component	Description
actionBar	.MuiPickersLayout-actionBar	`PickersActionBar`	Custom component for the action bar, it is placed below the picker views.
layout			Custom component for wrapping the layout. It wraps the toolbar, views, action bar, and shortcuts.
shortcuts	.MuiPickersLayout-shortcuts	`PickersShortcuts`	Custom component for the shortcuts.
tabs	.MuiPickersLayout-tabs		Tabs enabling toggling between views.
toolbar	.MuiPickersLayout-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.

Class name	Rule name	Description
.MuiPickersLayout-contentWrapper	contentWrapper	Styles applied to the contentWrapper element (which contains the tabs and the view itself).
.MuiPickersLayout-landscape	landscape	Styles applied to the root element in landscape orientation.
.MuiPickersLayout-root	root	Styles applied to the root element.

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.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.