Skip to content

StaticDateRangePicker API

API documentation for the React StaticDateRangePicker component. Learn about the available props, and the CSS API.

Import

import StaticDateRangePicker from '@material-ui/lab/StaticDateRangePicker';
// or
import { StaticDateRangePicker } from '@material-ui/lab';
You can learn about the difference by reading this guide on minimizing bundle size.

Props

NameTypeDefaultDescription
onChange*funcCallback fired when the value (the selected date range) changes @DateIOType.
renderInput*funcThe 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.
acceptRegexRegExp/\dap/giRegular expression to detect "accepted" symbols.
allowKeyboardControlboolfalseEnables keyboard listener for moving between days in calendar. Defaults to true unless the ClockPicker is used inside a Static* picker component.
allowSameDateSelectionboolfalseIf true, onChange is fired on click even if the same date is selected.
calendars1
| 2
| 3
2The number of calendars that render on desktop.
classNamestringclassName applied to the root component.
components{ LeftArrowButton?: elementType, LeftArrowIcon?: 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.
componentsPropsobject{}The props used for each slot inside.
defaultCalendarMonthanyDefault calendar month displayed when value={null}.
disableAutoMonthSwitchingboolfalseIf true, after selecting start date calendar will not automatically switch to the month of end date.
disableCloseOnSelectbool`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.
disabledboolfalseIf true, the picker and text field are disabled.
disableHighlightTodayboolfalseIf true, todays date is rendering without highlighting with circle.
disableMaskedInputboolfalseDisable mask on the keyboard, this should be used rarely. Consider passing proper mask for your format.
disableOpenPickerboolfalseDo not render open picker button (renders only text field with validation).
displayStaticWrapperAs'desktop'
| 'mobile'
'mobile'Force static wrapper inner components to be rendered in mobile or desktop mode.
endTextnode'End'Text for end input label and toolbar placeholder.
getOpenDialogAriaTextfunc(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
getViewSwitchingButtonTextfuncGet aria-label text for switching between views button.
InputAdornmentPropsobjectProps to pass to keyboard input adornment.
inputFormatstringFormat string.
inputReffunc
| { current?: object }
Pass a ref to the input element.
leftArrowButtonTextstringLeft arrow icon aria-label text.
loadingboolfalseIf 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).
maxDateanydefaultMaxDateMax selectable date. @DateIOType
minDateanydefaultMinDateMin selectable date. @DateIOType
onAcceptfuncCallback fired when date is accepted @DateIOType.
onClosefuncCallback fired when the popup requests to be closed. Use in controlled mode (see open).
onErrorfuncCallback 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.
onMonthChangefuncCallback firing on month change. @DateIOType
onOpenfuncCallback fired when the popup requests to be opened. Use in controlled mode (see open).
onViewChangefuncCallback fired on view change.
openboolfalseControl the popup or dialog open state.
OpenPickerButtonPropsobjectProps to pass to keyboard adornment button.
openPickerIconnodeIcon displaying for open picker button.
orientation'landscape'
| 'portrait'
Force rendering in particular orientation.
readOnlyboolfalseMake picker read only.
reduceAnimationsbooltypeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)Disable heavy animations.
renderDayfuncCustom renderer for <DateRangePicker /> days. @DateIOType
renderLoadingfunc() => <span data-mui-test="loading-progress">...</span>Component displaying when passed loading true.
rifmFormatterfuncCustom formatter to be passed into Rifm component.
rightArrowButtonTextstringRight arrow icon aria-label text.
shouldDisableDatefuncDisable specific date. @DateIOType
shouldDisableYearfuncDisable specific years dynamically. Works like shouldDisableDate but for year selection view @DateIOType.
showDaysOutsideCurrentMonthboolfalseIf true, days that have outsideCurrentMonth={true} are displayed.
showToolbarboolfalseIf true, show the toolbar even in desktop mode.
startTextnode'Start'Text for start input label and toolbar placeholder.
ToolbarComponentelementTypeComponent that will replace default toolbar renderer.
toolbarFormatstringDate format, that is displaying in toolbar.
toolbarPlaceholdernode"–"Mobile picker date value placeholder, displaying if value === null.
toolbarTitlenode"SELECT DATE"Mobile picker title, displaying in the toolbar.

The ref is forwarded to the root element.

Demos