DatePicker API

API reference docs for the React DatePicker component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import { DatePicker } from '@mui/x-date-pickers/DatePicker';
// or
import { DatePicker } from '@mui/x-date-pickers';
// or
import { DatePicker } from '@mui/x-date-pickers-pro';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Name	Type	Default	Description
autoFocus	bool	-	If `true`, the main element is focused during the first mount. This main element is: - the element chosen by the visible view if any (i.e: the selected day on the `day` view). - the `input` element if there is a field rendered.
closeOnSelect	bool	`true` for desktop, `false` for mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop).	If `true`, the popover or modal will close after submitting the full date.
dayOfWeekFormatter	func	(date: TDate) => adapter.format(date, 'weekdayShort').charAt(0).toUpperCase()	Formats the day of week displayed in the calendar header. Signature:`function(date: TDate) => string` `date` The date of the day of week provided by the adapter. Returns: The name to display.
defaultValue	object	-	The default value. Used when the component is not controlled.
desktopModeMediaQuery	string	'@media (pointer: fine)'	CSS media query when `Mobile` mode will be changed to `Desktop`.
disabled	bool	false	If `true`, the picker and text field are disabled.
disableFuture	bool	false	If `true`, disable values after the current date for date components, time for time components and both for date time components.
disableHighlightToday	bool	false	If `true`, today's date is rendering without highlighting with circle.
disableOpenPicker	bool	false	If `true`, the open picker button will not be rendered (renders only the field).
disablePast	bool	false	If `true`, disable values before the current date for date components, time for time components and both for date time components.
displayWeekNumber	bool	-	If `true`, the week number will be display in the calendar.
fixedWeekNumber	number	-	The day view will show as many weeks as needed after the end of the current month to match this value. Put it to 6 to have a fixed number of weeks in Gregorian calendars
format	string	-	Format of the date when rendered in the input(s). Defaults to localized format based on the used `views`.
formatDensity	'dense' \| 'spacious'	"dense"	Density of the format when rendered in the input. Setting `formatDensity` to `"spacious"` will add a space before and after each `/`, `-` and `.` character.
inputRef	ref	-	Pass a ref to the `input` element.
label	node	-	The label content.
loading	bool	false	If `true`, calls `renderLoading` instead of rendering the day calendar. Can be used to preload information and show it in calendar.
localeText	object	-	Locale for components texts. Allows overriding texts coming from `LocalizationProvider` and `theme`.
maxDate	object	2099-12-31	Maximal selectable date.
minDate	object	1900-01-01	Minimal selectable date.
monthsPerRow	3 \| 4	3	Months rendered per row.
name	string	-	Name attribute used by the `input` element in the Field.
onAccept	func	-	Callback fired when the value is accepted. Signature:`function(value: TValue, context: FieldChangeHandlerContext) => void` `value` The value that was just accepted. `context` The context containing the validation result of the current value.
onChange	func	-	Callback fired when the value changes. Signature:`function(value: TValue, context: FieldChangeHandlerContext) => void` `value` The new value. `context` The context containing the validation result of the current value.
onClose	func	-	Callback fired when the popup requests to be closed. Use in controlled mode (see `open`).
onError	func	-	Callback fired when the error associated with the current value changes. When a validation error is detected, the `error` parameter contains a non-null value. This can be used to render an appropriate form error. Signature:`function(error: TError, value: TValue) => void` `error` The reason why the current value is not valid. `value` The value associated with the error.
onMonthChange	func	-	Callback fired on month change. Signature:`function(month: TDate) => void` `month` The new month.
onOpen	func	-	Callback fired when the popup requests to be opened. Use in controlled mode (see `open`).
onSelectedSectionsChange	func	-	Callback fired when the selected sections change. Signature:`function(newValue: FieldSelectedSections) => void` `newValue` The new selected sections.
onViewChange	func	-	Callback fired on view change. Signature:`function(view: TView) => void` `view` The new view.
onYearChange	func	-	Callback fired on year change. Signature:`function(year: TDate) => void` `year` The new year.
open	bool	false	Control the popup or dialog open state.
openTo	'day' \| 'month' \| 'year'	-	The default visible view. Used when the component view is not controlled. Must be a valid option from `views` list.
orientation	'landscape' \| 'portrait'	-	Force rendering in particular orientation.
reduceAnimations	bool	`@media(prefers-reduced-motion: reduce)` \|\| `navigator.userAgent` matches Android <10 or iOS <13	If `true`, disable heavy animations.
referenceDate	object	The closest valid date-time using the validation props, except callbacks like `shouldDisable<...>`.	The date used to generate the new value when both `value` and `defaultValue` are empty.
renderLoading	func	() => <span data-mui-test="loading-progress">...</span>	Component displaying when passed `loading` true. Signature:`function() => React.ReactNode` Returns: The node to render when loading.
selectedSections	'all' \| 'day' \| 'empty' \| 'hours' \| 'meridiem' \| 'minutes' \| 'month' \| 'seconds' \| 'weekDay' \| 'year' \| number	-	The currently selected sections. This prop accepts four formats: 1. If a number is provided, the section at this index will be selected. 2. If a string of type `FieldSectionType` is provided, the first section with that name will be selected. 3. If `"all"` is provided, all the sections will be selected. 4. If `null` is provided, no section will be selected. If not provided, the selected sections will be handled internally.
shouldDisableDate	func	-	Disable specific date. Warning: This function can be called multiple times (for example when rendering date calendar, checking if focus can be moved to a certain date, etc.). Expensive computations can impact performance. Signature:`function(day: TDate) => boolean` `day` The date to test. Returns: If `true` the date will be disabled.
shouldDisableMonth	func	-	Disable specific month. Signature:`function(month: TDate) => boolean` `month` The month to test. Returns: If `true`, the month will be disabled.
shouldDisableYear	func	-	Disable specific year. Signature:`function(year: TDate) => boolean` `year` The year to test. Returns: If `true`, the year will be disabled.
showDaysOutsideCurrentMonth	bool	false	If `true`, days outside the current month are rendered: - if `fixedWeekNumber` is defined, renders days to have the weeks requested. - if `fixedWeekNumber` is not defined, renders day to fill the first and last week of the current month. - ignored if `calendars` equals more than `1` on range pickers.
slotProps	object	{}	The props used for each component slot.
slots	object	{}	Overridable component slots. See Slots API below for more details.
sx	Array<func \| object \| bool> \| func \| object	-	The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
timezone	string	The timezone of the `value` or `defaultValue` prop is defined, 'default' otherwise.	Choose which timezone to use for the value. Example: "default", "system", "UTC", "America/New_York". If you pass values from other timezones to some props, they will be converted to this timezone before being used. See the timezones documentation for more details.
value	object	-	The selected value. Used when the component is controlled.
view	'day' \| 'month' \| 'year'	-	The visible view. Used when the component view is controlled. Must be a valid option from `views` list.
viewRenderers	{ day?: func, month?: func, year?: func }	-	Define custom view renderers for each section. If `null`, the section will only have field editing. If `undefined`, internally defined view will be used.
views	Array<'day' \| 'month' \| 'year'>	-	Available views.
yearsOrder	'asc' \| 'desc'	'asc'	Years are displayed in ascending (chronological) order by default. If `desc`, years are displayed in descending order.
yearsPerRow	3 \| 4	4 on desktop, 3 on mobile	Years rendered per row.

The ref is forwarded to the root element.

Slots

Slot name	Default component	Description
actionBar	`PickersActionBar`	Custom component for the action bar, it is placed below the picker views.
calendarHeader	`PickersCalendarHeader`	Custom component for calendar header. Check the PickersCalendarHeader component.
clearButton	`IconButton`	Button to clear the value.
clearIcon	`ClearIcon`	Icon to display inside the clear button.
day	`PickersDay`	Custom component for day. Check the PickersDay component.
desktopPaper	`PickersPopperPaper`	Custom component for the paper rendered inside the desktop picker's Popper.
desktopTransition	Grow or Fade from '@mui/material' when `reduceAnimations` is `true`.	Custom component for the desktop popper Transition.
desktopTrapFocus	`TrapFocus from '@mui/material'.`	Custom component for trapping the focus inside the views on desktop.
dialog	`PickersModalDialogRoot`	Custom component for the dialog inside which the views are rendered on mobile.
field		Component used to enter the date with the keyboard.
inputAdornment	`InputAdornment`	Component displayed on the start or end input adornment used to open the picker on desktop.
layout		Custom component for wrapping the layout. It wraps the toolbar, views, action bar, and shortcuts.
leftArrowIcon	`ArrowLeft`	Icon displayed in the left view switch button.
mobilePaper	`Paper from '@mui/material'.`	Custom component for the paper rendered inside the mobile picker's Dialog.
mobileTransition	`Fade from '@mui/material'.`	Custom component for the mobile dialog Transition.
monthButton	`MonthCalendarButton`	Button displayed to render a single month in the `month` view.
nextIconButton	`IconButton`	Button allowing to switch to the right view.
openPickerButton	`IconButton`	Button to open the picker on desktop.
openPickerIcon		Icon displayed in the open picker button on desktop.
popper	`Popper from '@mui/material'.`	Custom component for the popper inside which the views are rendered on desktop.
previousIconButton	`IconButton`	Button allowing to switch to the left view.
rightArrowIcon	`ArrowRight`	Icon displayed in the right view switch button.
shortcuts	`PickersShortcuts`	Custom component for the shortcuts.
switchViewButton	`IconButton`	Button displayed to switch between different calendar views.
switchViewIcon	`ArrowDropDown`	Icon displayed in the SwitchViewButton. Rotated by 180° when the open view is `year`.
textField	TextField from '@mui/material' or PickersTextField if `enableAccessibleFieldDOMStructure` is `true`.	Form control with an input to render the value inside the default field.
toolbar	`DatePickerToolbar`	Custom component for the toolbar rendered above the views.
yearButton	`YearCalendarButton`	Button displayed to render a single year in the `year` view.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.