Component composition
The component is built using the DateField
for the keyboard editing and the DateCalendar
for the view editing.
Check-out their documentation page for more information:
You can check the available props of the combined component on the dedicated API page.
Some DateField props are not available on the Picker component, you can use slotProps.field
to pass them to the field.
Uncontrolled vs. controlled value
The value of the component can be uncontrolled or controlled.
Available components
The component is available in four variants:
The
DesktopDatePicker
component which works best for mouse devices and large screens. It renders the views inside a popover and allows editing values directly inside the field.The
MobileDatePicker
component which works best for touch devices and small screens. It renders the view inside a modal and does not allow editing values directly inside the field.The
DatePicker
component which rendersDesktopDatePicker
orMobileDatePicker
depending on the device it runs on.The
StaticDatePicker
component which renders without the popover/modal and field.
Desktop variant
Mobile variant
Responsive variant
Static variant
By default, the DatePicker
component renders the desktop version if the media query @media (pointer: fine)
matches.
This can be customized with the desktopModeMediaQuery
prop.
Form props
The component can be disabled or read-only.
Views
The component supports three views: day
, month
, and year
.
By default, the day
and year
views are enabled.
Use the views
prop to change this behavior:
By default, the component renders the day
view on mount.
Use the openTo
prop to change this behavior:
Order of years
By default, years are displayed in ascending order, chronologically from the minimum year to the maximum.
Set the yearsOrder
prop to desc
to show the years in descending order.
Landscape orientation
By default, the Date Picker component automatically sets the orientation based on the window.orientation
value.
You can force a specific orientation using the orientation
prop:
Helper text
You can show a helper text with the date format accepted:
MM/DD/YYYY
Clearing the value
You can enable the clearable behavior:
DesktopDatePicker
Localization
See the Date format and localization and Translated components documentation pages for more details.
Validation
See the Validation documentation page for more details.
Customization
You can check out multiple examples of how to customize the date pickers and their subcomponents.
API
See the documentation below for a complete reference to all of the props and classes available to the components mentioned here.