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

autoFocus

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.

Type:

bool

className

Class name applied to the root element.

Type:

string

closeOnSelect

If true, the popover or modal will close after submitting the full date.

Type:

bool

Default:

`true` for desktop, `false` for mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop).

components

Overridable components.

Deprecated - Please use slots.

Type:

object

Default:

{}

componentsProps

The props used for each component slot.

Deprecated - Please use slotProps.

Type:

object

Default:

{}

dayOfWeekFormatter

Formats the day of week displayed in the calendar header.

Type:

func

Default:

(_day: string, date: TDate) => adapter.format(date, 'weekdayShort').charAt(0).toUpperCase()

Signature:

function(day: string, date: TDate) => string

day The day of week provided by the adapter. Deprecated, will be removed in v7: Use date instead.
date The date of the day of week provided by the adapter.

Returns: The name to display.

defaultCalendarMonth

Default calendar month displayed when value and defaultValue are empty.

Type:

any

defaultValue

The default value. Used when the component is not controlled.

Type:

any

desktopModeMediaQuery

CSS media query when Mobile mode will be changed to Desktop.

Type:

string

Default:

'@media (pointer: fine)'

disabled

If true, the picker and text field are disabled.

Type:

bool

disableFuture

If true, disable values after the current date for date components, time for time components and both for date time components.

Type:

bool

disableHighlightToday

If true, today's date is rendering without highlighting with circle.

Type:

bool

disableOpenPicker

If true, the open picker button will not be rendered (renders only the field).

Type:

bool

disablePast

If true, disable values before the current date for date components, time for time components and both for date time components.

Type:

bool

displayWeekNumber

If true, the week number will be display in the calendar.

Type:

bool

fixedWeekNumber

Calendar will show more weeks in order to match this value. Put it to 6 for having fix number of week in Gregorian calendars

Type:

number

Default:

undefined

format

Format of the date when rendered in the input(s). Defaults to localized format based on the used views.

Type:

string

formatDensity

Density of the format when rendered in the input. Setting formatDensity to "spacious" will add a space before and after each /, - and . character.

Type:

'dense' | 'spacious'

Default:

"dense"

inputRef

Pass a ref to the input element.

Type:

ref

label

The label content.

Type:

node

If true, calls renderLoading instead of rendering the day calendar. Can be used to preload information and show it in calendar.

Type:

bool

localeText

Locale for components texts. Allows overriding texts coming from LocalizationProvider and theme.

Type:

object

maxDate

Maximal selectable date.

Type:

any

minDate

Minimal selectable date.

Type:

any

monthsPerRow

Months rendered per row.

Type:

3 | 4

Default:

3

onAccept

Callback fired when the value is accepted.

Type:

func

Signature:

function(value: TValue) => void

value The value that was just accepted.

onChange

Callback fired when the value changes.

Type:

func

Signature:

function(value: TValue, context: FieldChangeHandlerContext) => void

value The new value.
context The context containing the validation result of the current value.

onClose

Callback fired when the popup requests to be closed. Use in controlled mode (see open).

Type:

func

onError

Callback fired when the error associated to the current value changes. If the error has a non-null value, then the TextField will be rendered in error state.

Type:

func

Signature:

function(error: TError, value: TValue) => void

error The new error describing why the current value is not valid.
value The value associated to the error.

onMonthChange

Callback fired on month change.

Type:

func

Signature:

function(month: TDate) => void

month The new month.

onOpen

Callback fired when the popup requests to be opened. Use in controlled mode (see open).

Type:

func

onSelectedSectionsChange

Callback fired when the selected sections change.

Type:

func

Signature:

function(newValue: FieldSelectedSections) => void

newValue The new selected sections.

onViewChange

Callback fired on view change.

Type:

func

Signature:

function(view: TView) => void

view The new view.

onYearChange

Callback fired on year change.

Type:

func

Signature:

function(year: TDate) => void

year The new year.

open

Control the popup or dialog open state.

Type:

bool

openTo

The default visible view. Used when the component view is not controlled. Must be a valid option from views list.

Type:

'day' | 'month' | 'year'

orientation

Force rendering in particular orientation.

Type:

'landscape' | 'portrait'

reduceAnimations

If true, disable heavy animations.

Type:

bool

Default:

`@media(prefers-reduced-motion: reduce)` || `navigator.userAgent` matches Android <10 or iOS <13

referenceDate

The date used to generate the new value when both value and defaultValue are empty.

Type:

any

Default:

The closest valid date-time using the validation props, except callbacks like `shouldDisable<...>`.

renderLoading

Component displaying when passed loading true.

Type:

func

Default:

() => <span data-mui-test="loading-progress">...</span>

Signature:

function() => React.ReactNode

Returns: The node to render when loading.

selectedSections

The currently selected sections. This prop accept four formats: 1. If a number is provided, the section at this index will be selected. 2. If an object with a startIndex and endIndex properties are provided, the sections between those two indexes will be selected. 3. If a string of type FieldSectionType is provided, the first section with that name will be selected. 4. If null is provided, no section will be selected If not provided, the selected sections will be handled internally.

Type:

'all' | 'day' | 'hours' | 'meridiem' | 'minutes' | 'month' | 'seconds' | 'weekDay' | 'year' | number | { endIndex: number, startIndex: number }

shouldDisableDate

Disable specific date.

Type:

func

Signature:

function(day: TDate) => boolean

day The date to test.

Returns: If true the date will be disabled.

shouldDisableMonth

Disable specific month.

Type:

func

Signature:

function(month: TDate) => boolean

month The month to test.

Returns: If true, the month will be disabled.

shouldDisableYear

Disable specific year.

Type:

func

Signature:

function(year: TDate) => boolean

year The year to test.

Returns: If true, the year will be disabled.

showDaysOutsideCurrentMonth

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.

Type:

bool

slotProps

The props used for each component slot.

Type:

object

Default:

{}

slots

Overridable component slots.

Type:

object

Default:

{}

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object

timezone

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 documention for more details.

Type:

string

Default:

The timezone of the `value` or `defaultValue` prop is defined, 'default' otherwise.

value

The selected value. Used when the component is controlled.

Type:

any

view

The visible view. Used when the component view is controlled. Must be a valid option from views list.

Type:

'day' | 'month' | 'year'

viewRenderers

Define custom view renderers for each section. If null, the section will only have field editing. If undefined, internally defined view will be the used.

Type:

{ day?: func, month?: func, year?: func }

views

Available views.

Type:

Array<'day' | 'month' | 'year'>

yearsPerRow

Years rendered per row.

Type:

3 | 4

Default:

4 on desktop, 3 on mobile

The component cannot hold a ref.

Slots

actionBar

Custom component for the action bar, it is placed below the picker views.

Default: PickersActionBar

calendarHeader

Custom component for calendar header. Check the PickersCalendarHeader component.

Default: PickersCalendarHeader

day

Custom component for day. Check the PickersDay component.

Default: PickersDay

desktopPaper

Custom component for the paper rendered inside the desktop picker's Popper.

Default: PickersPopperPaper

desktopTransition

Custom component for the desktop popper Transition.

Default: Grow or Fade from '@mui/material' when `reduceAnimations` is `true`.

desktopTrapFocus

Custom component for trapping the focus inside the views on desktop.

Default: FocusTrap from '@mui/base'.

dialog

Custom component for the dialog inside which the views are rendered on mobile.

Default: PickersModalDialogRoot

field

Component used to enter the date with the keyboard.

inputAdornment

Component displayed on the start or end input adornment used to open the picker on desktop.

Default: InputAdornment

layout

Custom component for wrapping the layout. It wraps the toolbar, views, action bar, and shortcuts.

leftArrowIcon

Icon displayed in the left view switch button.

Default: ArrowLeft

mobilePaper

Custom component for the paper rendered inside the mobile picker's Dialog.

Default: Paper from '@mui/material'.

mobileTransition

Custom component for the mobile dialog Transition.

Default: Fade from '@mui/material'.

nextIconButton

Button allowing to switch to the right view.

Default: IconButton

openPickerButton

Button to open the picker on desktop.

Default: IconButton

openPickerIcon

Icon displayed in the open picker button on desktop.

popper

Custom component for the popper inside which the views are rendered on desktop.

Default: Popper from '@mui/material'.

previousIconButton

Button allowing to switch to the left view.

Default: IconButton

rightArrowIcon

Icon displayed in the right view switch button.

Default: ArrowRight

shortcuts

Custom component for the shortcuts.

Default: PickersShortcuts

switchViewButton

Button displayed to switch between different calendar views.

Default: IconButton

switchViewIcon

Icon displayed in the SwitchViewButton. Rotated by 180° when the open view is 'year'.

Default: ArrowDropDown

textField

Form control with an input to render the value inside the default field. Receives the same props as @mui/material/TextField.

Default: TextField from '@mui/material'

Custom component for the toolbar rendered above the views.

Default: DatePickerToolbar

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Have any feedback about this new API display design?

We've heard from you and iterated on making the design of API content documentation more scalable and easier to parse! We value your input, so please don't hesitate to share any additional feedback you may have.