跳转到内容

MobileDateRangePicker API

想要学习更多组件属性和 CSS API,可以查阅 React MobileDateRangePicker 组件的 API 文档。

导入

import MobileDateRangePicker from '@mui/x-date-pickers-pro/MobileDateRangePicker';
// 或
import { MobileDateRangePicker } from '@mui/x-date-pickers-pro';
You can learn about the difference by reading this guide on minimizing bundle size.

组件名称

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

属性

名称类型默认值描述
onChange*func
Callback fired when the value (the selected date range) changes @DateIOType.

Signature:
function(date: DateRange<TDate>, keyboardInputValue: string) => void
date: The new parsed date range.
keyboardInputValue: The current value of the keyboard input.
renderInput*func
The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

Signature:
function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
startProps: Props that you need to forward to the range start input.
endProps: Props that you need to forward to the range end input.
returns (React.ReactElement): The range input to render.
value*Array<any>
The value of the picker.
acceptRegexRegExp/\dap/gi
Regular expression to detect "accepted" symbols.
calendars1
| 2
| 3
2
The number of calendars that render on desktop.
classNamestring
className applied to the root component.
closeOnSelectbool`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.
componentsobject{}
Overrideable components.
componentsPropsobject{}
The props used for each component slot.
defaultCalendarMonthany
Default calendar month displayed when value={null}.
DialogPropsobject
Props applied to the Dialog element.
disableAutoMonthSwitchingboolfalse
If true, after selecting start date calendar will not automatically switch to the month of end date.
disabledboolfalse
If true, the picker and text field are disabled.
disableFutureboolfalse
If true future days are disabled.
disableHighlightTodayboolfalse
If true, today's date is rendering without highlighting with circle.
disableMaskedInputboolfalse
Disable mask on the keyboard, this should be used rarely. Consider passing proper mask for your format.
disableOpenPickerboolfalse
Do not render open picker button (renders only text field with validation).
disablePastboolfalse
If true past days are disabled.
endTextnode'End'
Text for end input label and toolbar placeholder.
getOpenDialogAriaTextfunc(date, utils) => `Choose date, selected date is ${utils.format(utils.date(date), 'fullDate')}`
Get aria-label text for control that opens picker dialog. Aria-label text must include selected date. @DateIOType

Signature:
function(date: TInputDate, 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.
getViewSwitchingButtonTextfunc
Get aria-label text for switching between views button.

Signature:
function(currentView: CalendarPickerView) => string
currentView: The view from which we want to get the button text.
returns (string): The label of the view.
InputAdornmentPropsobject
Props to pass to keyboard input adornment.
inputFormatstring
Format string.
inputReffunc
| { current?: object }
Pass a ref to the input element.
leftArrowButtonTextstring
Left arrow icon aria-label text.
loadingboolfalse
If true renders LoadingComponent in calendar instead of calendar view. Can be used to preload information and show it in calendar.
maskstring'__/__/____'
Custom mask. Can be used to override generate from format. (e.g. __/__/____ __:__ or __/__/____ __:__ _M).
maxDateany
Maximal selectable date. @DateIOType
minDateany
Minimal selectable date. @DateIOType
onAcceptfunc
Callback fired when date is accepted @DateIOType.

Signature:
function(value: TValue) => void
value: The value that was just accepted.
onClosefunc
Callback fired when the popup requests to be closed. Use in controlled mode (see open).
onErrorfunc
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: TInputValue) => void
reason: The reason why the current value is not valid.
value: The invalid value.
onMonthChangefunc
Callback firing on month change @DateIOType.

Signature:
function(month: TDate) => void | Promise
month: The new month.
returns (void | Promise): -
onOpenfunc
Callback fired when the popup requests to be opened. Use in controlled mode (see open).
onViewChangefunc
Callback fired on view change.

Signature:
function(view: CalendarPickerView) => void
view: The new view.
openboolfalse
Control the popup or dialog open state.
OpenPickerButtonPropsobject
Props to pass to keyboard adornment button.
readOnlyboolfalse
Make picker read only.
reduceAnimationsbooltypeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)
Disable heavy animations.
renderDayfunc
Custom renderer for <DateRangePicker /> days. @DateIOType

Signature:
function(day: TDate, dateRangePickerDayProps: DateRangePickerDayProps<TDate>) => JSX.Element
day: The day to render.
dateRangePickerDayProps: The props of the day to render.
returns (JSX.Element): The element representing the day.
renderLoadingfunc() => <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.
rifmFormatterfunc
Custom formatter to be passed into Rifm component.

Signature:
function(str: string) => string
str: The un-formatted string.
returns (string): The formatted string.
rightArrowButtonTextstring
Right arrow icon aria-label text.
shouldDisableDatefunc
Disable specific date. @DateIOType

Signature:
function(day: TDate) => boolean
day: The date to test.
returns (boolean): Returns true if the date should be disabled.
shouldDisableMonthfunc
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.
shouldDisableYearfunc
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.
showDaysOutsideCurrentMonthboolfalse
If true, days that have outsideCurrentMonth={true} are displayed.
showToolbarboolfalse
If true, show the toolbar even in desktop mode.
startTextnode'Start'
Text for start input label and toolbar placeholder.
toolbarFormatstring
Date format, that is displaying in toolbar.
toolbarTitlenode'Select date range'
Mobile picker title, displaying in the toolbar.

ref 则会被传递到根元素中。

演示项目