DatePicker API
API documentation for the React DatePicker component. Learn about the available props and the CSS API.
Import
import { DatePicker } from '@mui/x-date-pickers-pro/DatePicker';
// or
import { DatePicker } from '@mui/x-date-pickers/DatePicker';
// or
import { DatePicker } from '@mui/x-date-pickers-pro';
// or
import { DatePicker } from '@mui/x-date-pickers';
Component name
The nameMuiDatePicker
can be used when providing default props or style overrides in the theme.Props
Name | Type | Default | Description |
---|---|---|---|
onChange* | func | Callback fired when the value (the selected date) changes @DateIOType. Signature: function(value: TValue, keyboardInputValue: string) => void value: The new parsed value. keyboardInputValue: The current value of the keyboard input. | |
renderInput* | func | The 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.Signature: function(props: MuiTextFieldPropsType) => React.ReactNode props: The props of the input. returns (React.ReactNode): The node to render as the input. | |
acceptRegex | RegExp | /\dap/gi | Regular expression to detect "accepted" symbols. |
className | string | className applied to the root component. | |
closeOnSelect | 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. |
components | object | {} | Overrideable components. |
componentsProps | object | {} | The props used for each component slot. |
dayOfWeekFormatter | func | (day) => day.charAt(0).toUpperCase() | Formats the day of week displayed in the calendar header. Signature: function(day: string) => string day: The day of week provided by the adapter's method getWeekdays .returns (string): The name to display. |
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. | |
disabled | bool | false | If true , the picker and text field are disabled. |
disableFuture | bool | false | If true future days are disabled. |
disableHighlightToday | bool | false | If true , today's 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). |
disablePast | bool | false | If true past days are disabled. |
getOpenDialogAriaText | func | (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. |
getViewSwitchingButtonText | func | 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. | |
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 | Maximal selectable date. @DateIOType | |
minDate | any | Minimal selectable date. @DateIOType | |
onAccept | func | Callback fired when date is accepted @DateIOType. Signature: function(value: TValue) => void value: The value that was just accepted. | |
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. Signature: function(reason: TError, value: TInputValue) => void reason: The reason why the current value is not valid. value: The invalid value. | |
onMonthChange | func | Callback firing on month change @DateIOType. Signature: function(month: TDate) => void | Promise month: The new month. returns (void | Promise): - | |
onOpen | func | Callback fired when the popup requests to be opened. Use in controlled mode (see open). | |
onViewChange | func | Callback fired on view change. Signature: function(view: CalendarPickerView) => void view: The new view. | |
onYearChange | func | Callback firing on year change @DateIOType. Signature: function(year: TDate) => void year: The new year. | |
open | bool | false | Control the popup or dialog open state. |
OpenPickerButtonProps | object | Props to pass to keyboard adornment button. | |
openTo | 'day' | 'month' | 'year' | 'day' | First view to show. Must be a valid option from views list |
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 day. Check the PickersDay component. Signature: function(day: TDate, selectedDays: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element day: The day to render. selectedDays: The days currently selected. pickersDayProps: The props of the day to render. returns (JSX.Element): The element representing the day. | |
renderLoading | func | () => <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. |
rifmFormatter | func | Custom formatter to be passed into Rifm component. Signature: function(str: string) => string str: The un-formatted string. returns (string): The formatted string. | |
rightArrowButtonText | string | Right arrow icon aria-label text. | |
shouldDisableDate | func | Disable specific date. @DateIOType Signature: function(day: TDate) => boolean day: The date to test. returns (boolean): Returns true if the date should be disabled. | |
shouldDisableMonth | func | 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. | |
shouldDisableYear | func | 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. | |
showDaysOutsideCurrentMonth | bool | false | If true , days that have outsideCurrentMonth={true} are displayed. |
showToolbar | bool | false | If true , show the toolbar even in desktop mode. |
ToolbarComponent | elementType | DatePickerToolbar | 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' | Mobile picker title, displaying in the toolbar. |
TransitionComponent | elementType | Custom component for popper Transition. | |
value | any | The value of the picker. | |
views | Array<'day' | 'month' | 'year'> | ['year', 'day'] | Array of views to show. |
Slots
Name | Type | Default | Description |
---|---|---|---|
ActionBar | elementType | PickersActionBar | The action bar placed bellow picker views. |
LeftArrowButton | elementType | IconButton | Button allowing to switch to the left view. |
LeftArrowIcon | elementType | ArrowLeft | Icon displayed in the left view switch button. |
OpenPickerIcon | elementType | Calendar or Clock | Icon displayed in the open picker button. |
PaperContent | elementType | React.Fragment | The content of the Paper wrapping views. |
RightArrowButton | elementType | IconButton | Button allowing to switch to the right view. |
RightArrowIcon | elementType | ArrowRight | Icon displayed in the right view switch button. |
SwitchViewButton | elementType | IconButton | Button displayed to switch between different calendar views. |
SwitchViewIcon | elementType | ArrowDropDown | Icon displayed in the SwitchViewButton. Rotated by 180° when the open view is 'year'. |