MobileDateRangePicker API
API reference docs for the React MobileDateRangePicker component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import { MobileDateRangePicker } from '@mui/x-date-pickers-pro/MobileDateRangePicker';
// or
import { MobileDateRangePicker } from '@mui/x-date-pickers-pro';
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) => string
day
The day of week provided by the adapter. Deprecated, will be removed in v7: Usedate
instead.date
The date of the day of week provided by the adapter.
Returns: The name to display.
The initial position in the edited date range. Used when the component is not controlled.
Type:'end'
| 'start'
Default:'start'
If true
, after selecting start
date calendar will not automatically switch to the month of end
date.
Type:bool
Default:false
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
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
Name attribute used by the input
element in the Field. Ignored if the field has several inputs.
Type:string
Callback fired when the value is accepted.
Type:func
function(value: TValue) => void
value
The value that was just accepted.
Callback fired when the value changes.
Type:func
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
).
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) => 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.
Type:func
function(month: TDate) => void
month
The new month.
Callback fired when the popup requests to be opened. Use in controlled mode (see open
).
Type:func
Callback fired when the range position changes.
Type:func
function(rangePosition: RangePosition) => void
rangePosition
The new range position.
Callback fired when the selected sections change.
Type:func
function(newValue: FieldSelectedSections) => void
newValue
The new selected sections.
The position in the currently edited date range. Used when the component position is controlled.
Type:'end'
| 'start'
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:() => "..."
function() => React.ReactNode
Returns: 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 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, position: string) => boolean
day
The date to test.position
The date to test, 'start' or 'end'.
Returns: Returns true
if the date should 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
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.
ref
is forwarded to the root element.Custom component for the action bar, it is placed below the picker views.
Default component: PickersActionBar
Custom component for day in range pickers. Check the DateRangePickersDay component.
Default component: DateRangePickersDay
Custom component for the dialog inside which the views are rendered on mobile.
Default component: PickersModalDialogRoot
Custom component for wrapping the layout. It wraps the toolbar, views, action bar, and shortcuts.
Custom component for the paper rendered inside the mobile picker's Dialog.
Default component: Paper from '@mui/material'.
Custom component for the mobile dialog Transition.
Default component: Fade 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 a date or time inside the default field. It is rendered twice: once for the start element and once for the end element. Receives the same props as @mui/material/TextField
.
Default component: TextField from '@mui/material'