DatePicker API
Demos
For examples and details on the usage of this React component, visit the component demo pages:
Import
import DatePicker from '/packages/x-date-pickers/src/DatePicker';
// or
import { DatePicker } from '/packages/x-date-pickers/src';
Props
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
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).
Formats the day of week displayed in the calendar header.
Type:
func
Default:
(day) => day.charAt(0).toUpperCase()
Signature:
function(day: string) => string
day
The day of week provided by the adapter's methodgetWeekdays
.
Returns: The name to display.
CSS media query when Mobile
mode will be changed to Desktop
.
Type:
string
Default:
'@media (pointer: fine)'
If true
, disable values after the current date for date components, time for time components and both for date time components.
Type:
bool
If true
, the open picker button will not be rendered (renders only the field).
Type:
bool
If true
, disable values before the current date for date components, time for time components and both for date time components.
Type:
bool
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 of the date when rendered in the input(s). Defaults to localized format based on the used views
.
Type:
string
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"
If true
, calls renderLoading
instead of rendering the day calendar. Can be used to preload information and show it in calendar.
Type:
bool
Locale for components texts. Allows overriding texts coming from LocalizationProvider
and theme
.
Type:
object
Callback fired when the value is accepted.
Type:
func
Signature:
function(value: TValue) => void
value
The value that was just accepted.
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.
Callback fired when the popup requests to be closed. Use in controlled mode (see open
).
Type:
func
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.
Callback fired on month change.
Type:
func
Signature:
function(month: TDate) => void
month
The new month.
Callback fired when the popup requests to be opened. Use in controlled mode (see open
).
Type:
func
Callback fired when the selected sections change.
Type:
func
Signature:
function(newValue: FieldSelectedSections) => void
newValue
The new selected sections.
Callback fired on view change.
Type:
func
Signature:
function(view: TView) => void
view
The new view.
Callback fired on year change.
Type:
func
Signature:
function(year: TDate) => void
year
The new year.
The default visible view. Used when the component view is not controlled. Must be a valid option from views
list.
Type:
'day' | 'month' | 'year'
Disable heavy animations.
Type:
bool
Default:
typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)
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.
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 }
Disable specific date.
Type:
func
Signature:
function(day: TDate) => boolean
day
The date to test.
Returns: If true
the date will be disabled.
Disable specific month.
Type:
func
Signature:
function(month: TDate) => boolean
month
The month to test.
Returns: If true
, the month will be disabled.
Disable specific year.
Type:
func
Signature:
function(year: TDate) => boolean
year
The year to test.
Returns: If true
, the year will be disabled.
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
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
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.
The visible view. Used when the component view is controlled. Must be a valid option from views
list.
Type:
'day' | 'month' | 'year'
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 }
Slots
Default: PickersActionBar
Description: Custom component for the action bar, it is placed below the picker views.
Default: PickersCalendarHeader
Description: Custom component for calendar header. Check the PickersCalendarHeader component.
Default: PickersPopperPaper
Description: Custom component for the paper rendered inside the desktop picker's Popper.
Default: TrapFocus from '@mui/material'.
Description: Custom component for trapping the focus inside the views on desktop.
Default: PickersModalDialogRoot
Description: Custom component for the dialog inside which the views are rendered on mobile.
Default: InputAdornment
Description: Component displayed on the start or end input adornment used to open the picker on desktop.
Default:
Description: Custom component for wrapping the layout. It wraps the toolbar, views, action bar, and shortcuts.
Default: Paper from '@mui/material'.
Description: Custom component for the paper rendered inside the mobile picker's Dialog.
Default: Popper from '@mui/material'.
Description: Custom component for the popper inside which the views are rendered on desktop.
Default: IconButton
Description: Button displayed to switch between different calendar views.
Default: ArrowDropDown
Description: Icon displayed in the SwitchViewButton. Rotated by 180° when the open view is 'year'.
Default: TextField from '@mui/material'
Description: Form control with an input to render the value inside the default field.
Receives the same props as @mui/material/TextField
.
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.