DesktopDateTimePicker API

API documentation for the React DesktopDateTimePicker component. Learn about the available props and the CSS API.

Import

import DesktopDateTimePicker from '@mui/x-date-pickers-pro/DesktopDateTimePicker';
// or
import DesktopDateTimePicker from '@mui/x-date-pickers/DesktopDateTimePicker';
// or
import { DesktopDateTimePicker } from '@mui/x-date-pickers-pro';
// or
import { DesktopDateTimePicker } from '@mui/x-date-pickers';

You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiDesktopDateTimePicker can be used when providing default props or style overrides in the theme.

Props

Name	Type	Default	Description
onChange^*	func		Callback fired when the value (the selected date) changes @DateIOType. Signature: `function(value: TValue, keyboardInputValue: string) => void` value: The new value. keyboardInputValue: The current value of the keyboard input.
renderInput^*	func		The `renderInput` prop allows you to customize the rendered input. The `props` argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the `ref` and `inputProps` keys. Signature: `function(props: MuiTextFieldPropsType) => React.ReactNode` props: The props of the input. returns (React.ReactNode): The node to render as the input.
acceptRegex	RegExp	/\dap/gi	Regular expression to detect "accepted" symbols.
ampm	bool	`utils.is12HourCycleInCurrentLocale()`	12h/24h view for hour selection clock.
ampmInClock	bool	false	Display ampm controls under the clock (instead of in the toolbar).
className	string		className applied to the root component.
closeOnSelect	bool	`true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop).	If `true` the popup or dialog will immediately close after submitting full date.
components	object	{}	Overrideable components.
componentsProps	object	{}	The props used for each component slot.
dateRangeIcon	node		Date tab icon.
dayOfWeekFormatter	func	(day) => day.charAt(0).toUpperCase()	Formats the day of week displayed in the calendar header. Signature: `function(day: string) => string` day: The day of week provided by the adapter's method `getWeekdays`. returns (string): The name to display.
defaultCalendarMonth	any		Default calendar month displayed when `value={null}`.
disabled	bool	false	If `true`, the picker and text field are disabled.
disableFuture	bool	false	If `true` disable values before the current time
disableHighlightToday	bool	false	If `true`, today's date is rendering without highlighting with circle.
disableIgnoringDatePartForTimeValidation	bool	false	Do not ignore date part when validating min/max time.
disableMaskedInput	bool	false	Disable mask on the keyboard, this should be used rarely. Consider passing proper mask for your format.
disableOpenPicker	bool	false	Do not render open picker button (renders only text field with validation).
disablePast	bool	false	If `true` disable values after the current time.
fixedWeekNumber	number	undefined	Calendar will show more weeks in order to match this value. Put it to 6 for having fix number of week in Gregorian calendars
getOpenDialogAriaText	func	(date, utils) => `Choose date, selected date is ${utils.format(date, 'fullDate')}`	Get aria-label text for control that opens picker dialog. Aria-label text must include selected date. @DateIOType Signature: `function(date: TDate \| null, utils: MuiPickersAdapter<TDate>) => string` date: The date from which we want to add an aria-text. utils: The utils to manipulate the date. returns (string): The aria-text to render inside the dialog.
InputAdornmentProps	object		Props to pass to keyboard input adornment.
inputFormat	string		Format string.
inputRef	func \| { current?: object }		Pass a ref to the `input` element.
loading	bool	false	If `true` renders `LoadingComponent` in calendar instead of calendar view. Can be used to preload information and show it in calendar.
localeText	object		Locale for components texts
mask	string		Custom mask. Can be used to override generate from format. (e.g. `__/__/____ __:__` or `__/__/____ __:__ _M`).
maxDate	any		Maximal selectable date. @DateIOType
maxDateTime	any		Maximal selectable moment of time with binding to date, to set max time in each day use `maxTime`.
maxTime	any		Max time acceptable time. For input validation date part of passed object will be ignored if `disableIgnoringDatePartForTimeValidation` not specified.
minDate	any		Minimal selectable date. @DateIOType
minDateTime	any		Minimal selectable moment of time with binding to date, to set min time in each day use `minTime`.
minTime	any		Min time acceptable time. For input validation date part of passed object will be ignored if `disableIgnoringDatePartForTimeValidation` not specified.
minutesStep	number	1	Step over minutes.
onAccept	func		Callback fired when date is accepted @DateIOType. Signature: `function(value: TValue) => void` value: The value that was just accepted.
onClose	func		Callback fired when the popup requests to be closed. Use in controlled mode (see open).
onError	func		Callback that fired when input value or new `value` prop validation returns new validation error (or value is valid after error). In case of validation error detected `reason` prop return non-null value and `TextField` must be displayed in `error` state. This can be used to render appropriate form error. Read the guide about form integration and error displaying. Signature: `function(reason: TError, value: TValue) => void` reason: The reason why the current value is not valid. value: The invalid value.
onMonthChange	func		Callback firing on month change @DateIOType. Signature: `function(month: TDate) => void \| Promise` month: The new month. returns (void \| Promise): -
onOpen	func		Callback fired when the popup requests to be opened. Use in controlled mode (see open).
onViewChange	func		Callback fired on view change. Signature: `function(view: CalendarOrClockPickerView) => void` view: The new view.
onYearChange	func		Callback firing on year change @DateIOType. Signature: `function(year: TDate) => void` year: The new year.
open	bool	false	Control the popup or dialog open state.
OpenPickerButtonProps	object		Props to pass to keyboard adornment button.
openTo	'day' \| 'hours' \| 'minutes' \| 'month' \| 'seconds' \| 'year'	'day'	First view to show. Must be a valid option from `views` list
orientation	'landscape' \| 'portrait'		Force rendering in particular orientation.
readOnly	bool	false	Make picker read only.
reduceAnimations	bool	typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)	Disable heavy animations.
renderLoading	func	() => <span data-mui-test="loading-progress">...</span>	Component displaying when passed `loading` true. Signature: `function() => React.ReactNode` returns (React.ReactNode): The node to render when loading.
rifmFormatter	func		Custom formatter to be passed into Rifm component. Signature: `function(str: string) => string` str: The un-formatted string. returns (string): The formatted string.
shouldDisableDate	func		Disable specific date. @DateIOType Signature: `function(day: TDate) => boolean` day: The date to test. returns (boolean): Returns `true` if the date should be disabled.
shouldDisableMonth	func		Disable specific months dynamically. Works like `shouldDisableDate` but for month selection view @DateIOType. Signature: `function(month: TDate) => boolean` month: The month to check. returns (boolean): If `true` the month will be disabled.
shouldDisableTime	func		Dynamically check if time is disabled or not. If returns `false` appropriate time point will ot be acceptable. Signature: `function(timeValue: number, view: ClockPickerView) => boolean` timeValue: The value to check. view: The clock type of the timeValue. returns (boolean): Returns `true` if the time should be disabled
shouldDisableYear	func		Disable specific years dynamically. Works like `shouldDisableDate` but for year selection view @DateIOType. Signature: `function(year: TDate) => boolean` year: The year to test. returns (boolean): Returns `true` if the year should be disabled.
showDaysOutsideCurrentMonth	bool	false	If `true`, days that have `outsideCurrentMonth={true}` are displayed.
showToolbar	bool	false	If `true`, show the toolbar even in desktop mode.
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.
timeIcon	node		Time tab icon.
value	any		The value of the picker.
views	Array<'day' \| 'hours' \| 'minutes' \| 'month' \| 'seconds' \| 'year'>	['year', 'day', 'hours', 'minutes']	Array of views to show.

Slots

Name	Type	Default	Description
ActionBar	elementType	PickersActionBar	Custom component for the action bar, it is placed bellow the picker views.
Day	elementType	PickersDay	Custom component for day. Check the PickersDay component.
DesktopPaper	elementType	PickersPopperPaper	Custom component for the paper rendered inside the desktop picker's Popper.
DesktopTransition	elementType	Grow from @mui/material	Custom component for the desktop popper Transition.
DesktopTrapFocus	elementType	TrapFocus from @mui/material	Custom component for trapping the focus inside the views on desktop.
LeftArrowIcon	elementType	ArrowLeft	Icon displayed in the left view switch button.
NextIconButton	elementType	IconButton	Button allowing to switch to the right view.
OpenPickerIcon	elementType	Calendar or Clock	Icon displayed in the open picker button.
PaperContent	elementType	React.Fragment	Custom component wrapping the views of the desktop and static pickers (it is the direct child of the Paper component).
Popper	elementType	Popper from @mui/material	Custom component for the popper inside which the views are rendered on desktop.
PreviousIconButton	elementType	IconButton	Button allowing to switch to the left view.
RightArrowIcon	elementType	ArrowRight	Icon displayed in the right view switch button.
SwitchViewButton	elementType	IconButton	Button displayed to switch between different calendar views.
SwitchViewIcon	elementType	ArrowDropDown	Icon displayed in the SwitchViewButton. Rotated by 180° when the open view is 'year'.
Tabs	elementType	DateTimePickerTabs	Tabs enabling toggling between date and time pickers.
Toolbar	elementType	DateTimePickerToolbar	Custom component for the toolbar rendered above the views.

The component cannot hold a ref.

DesktopDateTimePicker API

Import

Component name

Props

Slots

Demos