Skip to content

StaticDateTimePicker API

API reference docs for the React StaticDateTimePicker component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

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

Learn about the difference by reading this guide on minimizing bundle size.

Props

NameTypeDefaultDescription
ampmboolutils.is12HourCycleInCurrentLocale()

12h/24h view for hour selection clock.

ampmInClockbooltrue on desktop, false on mobile

Display ampm controls under the clock (instead of in the toolbar).

autoFocusbool-

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.

dayOfWeekFormatterfunc(date: TDate) => adapter.format(date, 'weekdayShort').charAt(0).toUpperCase()

Formats the day of week displayed in the calendar header.

Signature:function(date: TDate) => string
  • date The date of the day of week provided by the adapter.

Returns: The name to display.

defaultValueobject-

The default value. Used when the component is not controlled.

disabledboolfalse

If true, the picker and text field are disabled.

disableFutureboolfalse

If true, disable values after the current date for date components, time for time components and both for date time components.

disableHighlightTodayboolfalse

If true, today's date is rendering without highlighting with circle.

disableIgnoringDatePartForTimeValidationboolfalse

Do not ignore date part when validating min/max time.

disablePastboolfalse

If true, disable values before the current date for date components, time for time components and both for date time components.

displayStaticWrapperAs'desktop'
| 'mobile'
"mobile"

Force static wrapper inner components to be rendered in mobile or desktop mode.

displayWeekNumberbool-

If true, the week number will be display in the calendar.

fixedWeekNumbernumber-

The day view will show as many weeks as needed after the end of the current month to match this value. Put it to 6 to have a fixed number of weeks in Gregorian calendars

loadingboolfalse

If true, calls renderLoading instead of rendering the day calendar. Can be used to preload information and show it in calendar.

localeTextobject-

Locale for components texts. Allows overriding texts coming from LocalizationProvider and theme.

maxDateobject2099-12-31

Maximal selectable date.

maxDateTimeobject-

Maximal selectable moment of time with binding to date, to set max time in each day use maxTime.

maxTimeobject-

Maximal selectable time. The date part of the object will be ignored unless props.disableIgnoringDatePartForTimeValidation === true.

minDateobject1900-01-01

Minimal selectable date.

minDateTimeobject-

Minimal selectable moment of time with binding to date, to set min time in each day use minTime.

minTimeobject-

Minimal selectable time. The date part of the object will be ignored unless props.disableIgnoringDatePartForTimeValidation === true.

minutesStepnumber1

Step over minutes.

monthsPerRow3
| 4
3

Months rendered per row.

onAcceptfunc-

Callback fired when the value is accepted.

Signature:function(value: TValue, context: FieldChangeHandlerContext) => void
  • value The value that was just accepted.
  • context The context containing the validation result of the current value.
onChangefunc-

Callback fired when the value changes.

Signature:function(value: TValue, context: FieldChangeHandlerContext) => void
  • value The new value.
  • context The context containing the validation result of the current value.
onClosefunc-

Callback fired when component requests to be closed. Can be fired when selecting (by default on desktop mode) or clearing a value.

onErrorfunc-

Callback fired when the error associated with the current value changes. When a validation error is detected, the error parameter contains a non-null value. This can be used to render an appropriate form error.

Signature:function(error: TError, value: TValue) => void
  • error The reason why the current value is not valid.
  • value The value associated with the error.
onMonthChangefunc-

Callback fired on month change.

Signature:function(month: TDate) => void
  • month The new month.
onViewChangefunc-

Callback fired on view change.

Signature:function(view: TView) => void
  • view The new view.
onYearChangefunc-

Callback fired on year change.

Signature:function(year: TDate) => void
  • year The new year.
openTo'day'
| 'hours'
| 'minutes'
| 'month'
| 'seconds'
| 'year'
-

The default visible view. Used when the component view is not controlled. Must be a valid option from views list.

orientation'landscape'
| 'portrait'
-

Force rendering in particular orientation.

reduceAnimationsbool`@media(prefers-reduced-motion: reduce)` || `navigator.userAgent` matches Android <10 or iOS <13

If true, disable heavy animations.

referenceDateobjectThe closest valid date-time using the validation props, except callbacks like `shouldDisable<...>`.

The date used to generate the new value when both value and defaultValue are empty.

renderLoadingfunc() => <span data-mui-test="loading-progress">...</span>

Component displaying when passed loading true.

Signature:function() => React.ReactNode

    Returns: The node to render when loading.

    shouldDisableDatefunc-

    Disable specific date.
    Warning: This function can be called multiple times (for example when rendering date calendar, checking if focus can be moved to a certain date, etc.). Expensive computations can impact performance.

    Signature:function(day: TDate) => boolean
    • day The date to test.

    Returns: If true the date will be disabled.

    shouldDisableMonthfunc-

    Disable specific month.

    Signature:function(month: TDate) => boolean
    • month The month to test.

    Returns: If true, the month will be disabled.

    shouldDisableTimefunc-

    Disable specific time.

    Signature:function(value: TDate, view: TimeView) => boolean
    • value The value to check.
    • view The clock type of the timeValue.

    Returns: If true the time will be disabled.

    shouldDisableYearfunc-

    Disable specific year.

    Signature:function(year: TDate) => boolean
    • year The year to test.

    Returns: If true, the year will be disabled.

    showDaysOutsideCurrentMonthboolfalse

    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.

    slotPropsobject{}

    The props used for each component slot.

    slotsobject{}

    Overridable component slots.

    See Slots API below for more details.

    sxArray<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.

    timezonestringThe timezone of the `value` or `defaultValue` prop is defined, 'default' otherwise.

    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 documentation for more details.

    valueobject-

    The selected value. Used when the component is controlled.

    view'day'
    | 'hours'
    | 'minutes'
    | 'month'
    | 'seconds'
    | 'year'
    -

    The visible view. Used when the component view is controlled. Must be a valid option from views list.

    viewRenderers{ day?: func, hours?: func, minutes?: func, month?: func, seconds?: func, year?: func }-

    Define custom view renderers for each section. If null, the section will only have field editing. If undefined, internally defined view will be used.

    viewsArray<'day'
    | 'hours'
    | 'minutes'
    | 'month'
    | 'seconds'
    | 'year'>
    -

    Available views.

    yearsOrder'asc'
    | 'desc'
    'asc'

    Years are displayed in ascending (chronological) order by default. If desc, years are displayed in descending order.

    yearsPerRow3
    | 4
    `4` when `displayStaticWrapperAs === 'desktop'`, `3` otherwise.

    Years rendered per row.

    The ref is forwarded to the root element.

    Slots

    Slot nameClass nameDefault componentDescription
    actionBarPickersActionBarCustom component for the action bar, it is placed below the picker views.
    calendarHeaderPickersCalendarHeaderCustom component for calendar header. Check the PickersCalendarHeader component.
    dayPickersDayCustom component for day. Check the PickersDay component.
    layoutCustom component for wrapping the layout. It wraps the toolbar, views, action bar, and shortcuts.
    leftArrowIconArrowLeftIcon displayed in the left view switch button.
    monthButtonMonthCalendarButtonButton displayed to render a single month in the month view.
    nextIconButtonIconButtonButton allowing to switch to the right view.
    previousIconButtonIconButtonButton allowing to switch to the left view.
    rightArrowIconArrowRightIcon displayed in the right view switch button.
    shortcutsPickersShortcutsCustom component for the shortcuts.
    switchViewButtonIconButtonButton displayed to switch between different calendar views.
    switchViewIconArrowDropDownIcon displayed in the SwitchViewButton. Rotated by 180° when the open view is year.
    tabsDateTimePickerTabsTabs enabling toggling between date and time pickers.
    toolbarDateTimePickerToolbarCustom component for the toolbar rendered above the views.
    yearButtonYearCalendarButtonButton displayed to render a single year in the year view.

    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.