DateRangePicker API
API documentation for the React DateRangePicker component. Learn about the available props and the CSS API.
Import
import DateRangePicker from '@mui/lab/DateRangePicker';
// or
import { DateRangePicker } from '@mui/lab';Props
| Name | Type | Default | Description |
|---|---|---|---|
| onChange* | func | Callback fired when the value (the selected date range) changes @DateIOType. | |
| 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. | |
| value* | Array<any | Date | number | string> | The value of the date range picker. | |
| acceptRegex | RegExp | /\dap/gi | Regular expression to detect "accepted" symbols. |
| allowSameDateSelection | bool | false | If true, onChange is fired on click even if the same date is selected. |
| calendars | 1 | 2 | 3 | 2 | The number of calendars that render on desktop. |
| cancelText | node | 'Cancel' | Cancel text message. |
| className | string | className applied to the root component. | |
| clearable | bool | false | If true, it shows the clear action in the picker dialog. |
| clearText | node | 'Clear' | Clear text message. |
| components | { LeftArrowButton?: elementType, LeftArrowIcon?: elementType, OpenPickerIcon?: elementType, RightArrowButton?: elementType, RightArrowIcon?: elementType, SwitchViewButton?: elementType, SwitchViewIcon?: elementType } | {} | The components used for each slot. Either a string to use a HTML element or a component. |
| componentsProps | { leftArrowButton?: object, rightArrowButton?: object, switchViewButton?: object } | {} | The props used for each slot inside. |
| defaultCalendarMonth | any | Default calendar month displayed when value={null}. | |
| desktopModeMediaQuery | string | '@media (pointer: fine)' | CSS media query when Mobile mode will be changed to Desktop. |
| DialogProps | object | Props applied to the Dialog element. | |
| disableAutoMonthSwitching | bool | false | If true, after selecting start date calendar will not automatically switch to the month of end date. |
| disableCloseOnSelect | bool | `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. |
| disabled | bool | false | If true, the picker and text field are disabled. |
| disableHighlightToday | bool | false | If true, todays date is rendering without highlighting with circle. |
| disableMaskedInput | bool | false | Disable mask on the keyboard, this should be used rarely. Consider passing proper mask for your format. |
| disableOpenPicker | bool | false | Do not render open picker button (renders only text field with validation). |
| endText | node | 'End' | Text for end input label and toolbar placeholder. |
| getOpenDialogAriaText | func | (value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}` | Get aria-label text for control that opens picker dialog. Aria-label text must include selected date. @DateIOType |
| getViewSwitchingButtonText | func | Get aria-label text for switching between views button. | |
| InputAdornmentProps | object | Props to pass to keyboard input adornment. | |
| inputFormat | string | Format string. | |
| inputRef | func | { current?: object } | Pass a ref to the input element. | |
| leftArrowButtonText | string | Left arrow icon aria-label text. | |
| loading | bool | false | If true renders LoadingComponent in calendar instead of calendar view. Can be used to preload information and show it in calendar. |
| mask | string | '__/__/____' | Custom mask. Can be used to override generate from format. (e.g. __/__/____ __:__ or __/__/____ __:__ _M). |
| maxDate | any | defaultMaxDate | Max selectable date. @DateIOType |
| minDate | any | defaultMinDate | Min selectable date. @DateIOType |
| okText | node | 'OK' | Ok button text. |
| onAccept | func | Callback fired when date is accepted @DateIOType. | |
| onClose | func | Callback fired when the popup requests to be closed. Use in controlled mode (see open). | |
| onError | func | 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. | |
| onMonthChange | func | Callback firing on month change. @DateIOType | |
| onOpen | func | Callback fired when the popup requests to be opened. Use in controlled mode (see open). | |
| onViewChange | func | Callback fired on view change. | |
| open | bool | false | Control the popup or dialog open state. |
| OpenPickerButtonProps | object | Props to pass to keyboard adornment button. | |
| orientation | 'landscape' | 'portrait' | Force rendering in particular orientation. | |
| PaperProps | object | Paper props passed down to Paper component. | |
| PopperProps | object | Popper props passed down to Popper component. | |
| readOnly | bool | false | Make picker read only. |
| reduceAnimations | bool | typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent) | Disable heavy animations. |
| renderDay | func | Custom renderer for <DateRangePicker /> days. @DateIOType | |
| renderLoading | func | () => <span data-mui-test="loading-progress">...</span> | Component displaying when passed loading true. |
| rifmFormatter | func | Custom formatter to be passed into Rifm component. | |
| rightArrowButtonText | string | Right arrow icon aria-label text. | |
| shouldDisableDate | func | Disable specific date. @DateIOType | |
| shouldDisableYear | func | Disable specific years dynamically. Works like shouldDisableDate but for year selection view @DateIOType. | |
| showDaysOutsideCurrentMonth | bool | false | If true, days that have outsideCurrentMonth={true} are displayed. |
| showTodayButton | bool | false | If true, the today button is displayed. Note that showClearButton has a higher priority. |
| showToolbar | bool | false | If true, show the toolbar even in desktop mode. |
| startText | node | 'Start' | Text for start input label and toolbar placeholder. |
| todayText | node | 'Today' | Today text message. |
| ToolbarComponent | elementType | Component that will replace default toolbar renderer. | |
| toolbarFormat | string | Date format, that is displaying in toolbar. | |
| toolbarPlaceholder | node | '–' | Mobile picker date value placeholder, displaying if value === null. |
| toolbarTitle | node | 'Select date range' | Mobile picker title, displaying in the toolbar. |
| TransitionComponent | elementType | Custom component for popper Transition. |
The
ref is forwarded to the root element.