DesktopDateTimePicker API
API reference docs for the React DesktopDateTimePicker component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import { DesktopDateTimePicker } from '@mui/x-date-pickers/DesktopDateTimePicker';
// or
import { DesktopDateTimePicker } from '@mui/x-date-pickers';
// or
import { DesktopDateTimePicker } from '@mui/x-date-pickers-pro';Props of the native component are also available.
Display ampm controls under the clock (instead of in the toolbar).
Type:bool
Default:true on desktop, false on mobile
If true, the main element is focused during the first mount. This main element is: - the element chosen by the visible view if any (i.e: the selected day on the day view). - the input element if there is a field rendered.
Type:bool
If true, the popover or modal will close after submitting the full date.
Type:bool
Default:`true` for desktop, `false` for mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop).
Formats the day of week displayed in the calendar header.
Type:func
Default:(_day: string, date: TDate) => adapter.format(date, 'weekdayShort').charAt(0).toUpperCase()
function(day: string, date: TDate) => stringdayThe day of week provided by the adapter. Deprecated, will be removed in v7: Usedateinstead.dateThe date of the day of week provided by the adapter.
Returns: The name to display.
Default calendar month displayed when value and defaultValue are empty.
Type:any
If true, disable values after the current date for date components, time for time components and both for date time components.
Type:bool
Default:false
If true, today's date is rendering without highlighting with circle.
Type:bool
Default:false
Do not ignore date part when validating min/max time.
Type:bool
Default:false
If true, the open picker button will not be rendered (renders only the field).
Type:bool
Default:false
If true, disable values before the current date for date components, time for time components and both for date time components.
Type:bool
Default:false
Calendar will show more weeks in order to match this value. Put it to 6 for having fix number of week in Gregorian calendars
Type:number
Default:undefined
Format of the date when rendered in the input(s). Defaults to localized format based on the used views.
Type:string
Density of the format when rendered in the input. Setting formatDensity to "spacious" will add a space before and after each /, - and . character.
Type:'dense'
| 'spacious'
Default:"dense"
If true, calls renderLoading instead of rendering the day calendar. Can be used to preload information and show it in calendar.
Type:bool
Default:false
Locale for components texts. Allows overriding texts coming from LocalizationProvider and theme.
Type:object
Maximal selectable moment of time with binding to date, to set max time in each day use maxTime.
Type:any
Maximal selectable time. The date part of the object will be ignored unless props.disableIgnoringDatePartForTimeValidation === true.
Type:any
Minimal selectable moment of time with binding to date, to set min time in each day use minTime.
Type:any
Minimal selectable time. The date part of the object will be ignored unless props.disableIgnoringDatePartForTimeValidation === true.
Type:any
Callback fired when the value is accepted.
Type:func
function(value: TValue) => voidvalueThe value that was just accepted.
Callback fired when the value changes.
Type:func
function(value: TValue, context: FieldChangeHandlerContext) => void valueThe new value.contextThe context containing the validation result of the current value.
Callback fired when the popup requests to be closed. Use in controlled mode (see open).
Type:func
Callback fired when the error associated to the current value changes. If the error has a non-null value, then the TextField will be rendered in error state.
Type:func
function(error: TError, value: TValue) => voiderrorThe new error describing why the current value is not valid.valueThe value associated to the error.
Callback fired on month change.
Type:func
function(month: TDate) => voidmonthThe new month.
Callback fired when the popup requests to be opened. Use in controlled mode (see open).
Type:func
Callback fired when the selected sections change.
Type:func
function(newValue: FieldSelectedSections) => voidnewValueThe new selected sections.
Callback fired on view change.
Type:func
function(view: TView) => voidviewThe new view.
Callback fired on year change.
Type:func
function(year: TDate) => voidyearThe new year.
The default visible view. Used when the component view is not controlled. Must be a valid option from views list.
Type:'day'
| 'hours'
| 'meridiem'
| 'minutes'
| 'month'
| 'seconds'
| 'year'
If true, disable heavy animations.
Type:bool
Default:`@media(prefers-reduced-motion: reduce)` || `navigator.userAgent` matches Android <10 or iOS <13
The date used to generate the new value when both value and defaultValue are empty.
Type:any
Default:The closest valid date-time using the validation props, except callbacks like `shouldDisable<...>`.
Component displaying when passed loading true.
Type:func
Default:() => <span data-mui-test="loading-progress">...</span>
function() => React.ReactNodeReturns: The node to render when loading.
The currently selected sections. This prop accept four formats: 1. If a number is provided, the section at this index will be selected. 2. If an object with a startIndex and endIndex properties are provided, the sections between those two indexes will be selected. 3. If a string of type FieldSectionType is provided, the first section with that name will be selected. 4. If null is provided, no section will be selected If not provided, the selected sections will be handled internally.
Type:'all'
| 'day'
| 'hours'
| 'meridiem'
| 'minutes'
| 'month'
| 'seconds'
| 'weekDay'
| 'year'
| number
| { endIndex: number, startIndex: number }
Disable specific clock time.
Type:func
function(clockValue: number, view: TimeView) => booleanclockValueThe value to check.viewThe clock type of the timeValue.
Returns: If true the time will be disabled.
Disable specific date.
Warning: This function can be called multiple times (e.g. when rendering date calendar, checking if focus can be moved to a certain date, etc.). Expensive computations can impact performance.
Type:func
function(day: TDate) => booleandayThe date to test.
Returns: If true the date will be disabled.
Disable specific month.
Type:func
function(month: TDate) => booleanmonthThe month to test.
Returns: If true, the month will be disabled.
Disable specific time.
Type:func
function(value: TDate, view: TimeView) => booleanvalueThe value to check.viewThe clock type of the timeValue.
Returns: If true the time will be disabled.
Disable specific year.
Type:func
function(year: TDate) => booleanyearThe year to test.
Returns: If true, the year will be disabled.
If true, days outside the current month are rendered:
- if fixedWeekNumber is defined, renders days to have the weeks requested.
- if fixedWeekNumber is not defined, renders day to fill the first and last week of the current month.
- ignored if calendars equals more than 1 on range pickers.
Type:bool
Default:false
The system prop that allows defining system overrides as well as additional CSS styles.
See the `sx` page for more details.
Type:Array<func
| object
| bool>
| func
| object
Amount of time options below or at which the single column time renderer is used.
Type:number
Default:24
The time steps between two time unit options. For example, if timeStep.minutes = 8, then the available minute options will be [0, 8, 16, 24, 32, 40, 48, 56]. When single column time renderer is used, only timeStep.minutes will be used.
Type:{ hours?: number, minutes?: number, seconds?: number }
Default:{ hours: 1, minutes: 5, seconds: 5 }
Choose which timezone to use for the value. Example: "default", "system", "UTC", "America/New_York". If you pass values from other timezones to some props, they will be converted to this timezone before being used.
See the timezones documention for more details.
Type:string
Default:The timezone of the `value` or `defaultValue` prop is defined, 'default' otherwise.
The visible view. Used when the component view is controlled. Must be a valid option from views list.
Type:'day'
| 'hours'
| 'meridiem'
| 'minutes'
| 'month'
| 'seconds'
| 'year'
Define custom view renderers for each section. If null, the section will only have field editing. If undefined, internally defined view will be the used.
Type:{ day?: func, hours?: func, meridiem?: func, minutes?: func, month?: func, seconds?: func, year?: func }
Custom component for the action bar, it is placed below the picker views.
Default component: PickersActionBar
Custom component for calendar header. Check the PickersCalendarHeader component.
Default component: PickersCalendarHeader
Custom component for the paper rendered inside the desktop picker's Popper.
Default component: PickersPopperPaper
Custom component for the desktop popper Transition.
Default component: Grow or Fade from '@mui/material' when `reduceAnimations` is `true`.
Custom component for trapping the focus inside the views on desktop.
Default component: FocusTrap from '@mui/base'.
Component responsible for rendering a single digital clock item.
Default component: MenuItem from '@mui/material'
Component responsible for rendering a single multi section digital clock section item.
Default component: MenuItem from '@mui/material'
Component displayed on the start or end input adornment used to open the picker on desktop.
Default component: InputAdornment
Custom component for wrapping the layout. It wraps the toolbar, views, action bar, and shortcuts.
Custom component for the popper inside which the views are rendered on desktop.
Default component: Popper from '@mui/material'.
Button displayed to switch between different calendar views.
Default component: IconButton
Icon displayed in the SwitchViewButton. Rotated by 180° when the open view is 'year'.
Default component: ArrowDropDown
Form control with an input to render the value inside the default field. Receives the same props as @mui/material/TextField.
Default component: TextField from '@mui/material'