Skip to content

MobileDatePicker API

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



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

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


Props of the native component are also available.


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.

closeOnSelectbool`true` for desktop, `false` for mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop).

If true, the popover or modal will close after submitting the full date.

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.


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


If true, the picker and text field are disabled.


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


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


If true, the open picker button will not be rendered (renders only the field).


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


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


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


Format of the date when rendered in the input(s). Defaults to localized format based on the used views.

| 'spacious'

Density of the format when rendered in the input. Setting formatDensity to "spacious" will add a space before and after each /, - and . character.


Pass a ref to the input element.


The label content.


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


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


Maximal selectable date.


Minimal selectable date.

| 4

Months rendered per row.


Name attribute used by the input element in the Field.


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.

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.

Callback fired when the popup requests to be closed. Use in controlled mode (see open).


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.

Signature:function(error: TError, value: TValue) => void
  • error The new error describing why the current value is not valid.
  • value The value associated to the error.

Callback fired on month change.

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

Callback fired when the popup requests to be opened. Use in controlled mode (see open).


Callback fired when the selected sections change.

Signature:function(newValue: FieldSelectedSections) => void
  • newValue The new selected sections.

Callback fired on view change.

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

Callback fired on year change.

Signature:function(year: TDate) => void
  • year The new year.

Control the popup or dialog open state.

| 'month'
| 'year'

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

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

    | 'day'
    | 'empty'
    | 'hours'
    | 'meridiem'
    | 'minutes'
    | 'month'
    | 'seconds'
    | 'weekDay'
    | 'year'
    | number

    The currently selected sections. This prop accepts four formats: 1. If a number is provided, the section at this index will be selected. 2. If a string of type FieldSectionType is provided, the first section with that name will be selected. 3. If "all" is provided, all the sections will be selected. 4. If null is provided, no section will be selected. If not provided, the selected sections will be handled internally.


    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.


    Disable specific month.

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

    Returns: If true, the month will be disabled.


    Disable specific year.

    Signature:function(year: TDate) => boolean
    • year The 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.


    The props used for each component slot.


    Overridable component slots.

    See Slots API below for more details.

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


    The selected value. Used when the component is controlled.

    | 'month'
    | 'year'

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

    viewRenderers{ day?: func, month?: 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.

    | 'month'
    | 'year'>

    Available views.

    | 4

    Years rendered per row.

    The component cannot hold a ref.


    Slot nameClass nameDefault componentDescription
    toolbarDatePickerToolbarCustom component for the toolbar rendered above the views.
    calendarHeaderPickersCalendarHeaderCustom component for calendar header. Check the PickersCalendarHeader component.
    switchViewButtonIconButtonButton displayed to switch between different calendar views.
    switchViewIconArrowDropDownIcon displayed in the SwitchViewButton. Rotated by 180° when the open view is "year".
    previousIconButtonIconButtonButton allowing to switch to the left view.
    nextIconButtonIconButtonButton allowing to switch to the right view.
    leftArrowIconArrowLeftIcon displayed in the left view switch button.
    rightArrowIconArrowRightIcon displayed in the right view switch button.
    dayPickersDayCustom component for day. Check the PickersDay component.
    monthButtonMonthCalendarButtonButton displayed to render a single month in the "month" view.
    yearButtonYearCalendarButtonButton displayed to render a single year in the "year" view.
    actionBarPickersActionBarCustom component for the action bar, it is placed below the picker views.
    shortcutsPickersShortcutsCustom component for the shortcuts.
    dialogPickersModalDialogRootCustom component for the dialog inside which the views are rendered on mobile.
    textFieldTextField from '@mui/material' or PickersTextField if `enableAccessibleFieldDOMStructure` is `true`.Form control with an input to render the value inside the default field.
    layoutCustom component for wrapping the layout. It wraps the toolbar, views, action bar, and shortcuts.
    mobilePaperPaper from '@mui/material'.Custom component for the paper rendered inside the mobile picker's Dialog.
    mobileTransitionFade from '@mui/material'.Custom component for the mobile dialog Transition.
    fieldComponent used to enter the date with the keyboard.