Перейти к контенту

DesktopDatePicker API

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

Import

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

Props

ИмяТипПо-умолчаниюОписание
onChange*funcCallback fired when the value (the selected date) changes @DateIOType.
renderInput*funcThe renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.
acceptRegexRegExp/\dap/giRegular expression to detect "accepted" symbols.
allowKeyboardControlboolfalse
allowSameDateSelectionboolfalse
classNamestringclassName applied to the root component.
components{ LeftArrowButton?: elementType, LeftArrowIcon?: elementType, RightArrowButton?: elementType, RightArrowIcon?: elementType, SwitchViewButton?: elementType, SwitchViewIcon?: elementType }{}
componentsPropsobject{}
defaultCalendarMonthany
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.
disableHighlightTodayboolfalse
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).
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
getViewSwitchingButtonTextfunc
InputAdornmentPropsobjectProps to pass to keyboard input adornment.
inputFormatstringFormat string.
inputReffunc
| { current?: object }
leftArrowButtonTextstring
loadingboolfalse
maskstringCustom mask. Can be used to override generate from format. (e.g. //__ __: or //__ __: _M)
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.
onMonthChangefunc
onOpenfuncCallback fired when the popup requests to be opened. Use in controlled mode (see open).
onViewChangefunc
onYearChangefunc
openboolfalseControl the popup or dialog open state.
OpenPickerButtonPropsobjectProps to pass to keyboard adornment button.
openPickerIconnodeIcon displaying for open picker button.
openTo'day'
| 'month'
| 'year'
orientation'landscape'
| 'portrait'
Force rendering in particular orientation.
PopperPropsobjectPopper props passed down to Popper component.
readOnlyboolfalseMake picker read only.
reduceAnimationsbooltypeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)
renderDayfunc
renderLoadingfunc() => <span data-mui-test="loading-progress">...</span>
rifmFormatterfuncCustom formatter to be passed into Rifm component.
rightArrowButtonTextstring
shouldDisableDatefunc
shouldDisableYearfunc
showDaysOutsideCurrentMonthboolfalse
showToolbarboolfalseIf true, show the toolbar even in desktop mode.
ToolbarComponentelementTypeDatePickerToolbarComponent 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.
TransitionComponentelementTypeCustom component for popper Transition.
valueany
| Date
| number
| string
The value of the picker.
viewsArray<'day'
| 'month'
| 'year'>

The component cannot hold a ref.
Any other props supplied will be provided to the root element (native element).

Demos