Skip to content
Edit this page

DateCalendar API

API reference docs for the React DateCalendar 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 DateCalendar from '/packages/x-date-pickers/src/DateCalendar';
// or
import { DateCalendar } from '/packages/x-date-pickers/src';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

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
components

Overridable components.

Type:

object

Default:

{}
componentsProps

The props used for each component slot.

Type:

object

Default:

{}
dayOfWeekFormatter

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 method getWeekdays.

Returns: The name to display.

defaultCalendarMonth

Default calendar month displayed when value and defaultValue are empty.

Type:

any
defaultValue

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

Type:

any
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
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
focusedView

Controlled focused view.

Type:

'day' | 'month' | 'year'
loading

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

Type:

bool
maxDate

Maximal selectable date.

Type:

any
minDate

Minimal selectable date.

Type:

any
monthsPerRow

Months rendered per row.

Type:

3 | 4

Default:

3
onChange

Callback fired when the value changes.

Type:

func

Signature:

function(value: TDate | null, selectionState: PickerSelectionState | undefined) => void
  • value The new value.
  • selectionState Indicates if the date selection is complete.
onFocusedViewChange

Callback fired on focused view change.

Type:

func

Signature:

function(view: TView, hasFocus: boolean) => void
  • view The new view to focus or not.
  • hasFocus true if the view should be focused.
onMonthChange

Callback fired on month change.

Type:

func

Signature:

function(month: TDate) => void
  • month The new month.
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.
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'
readOnly

Make picker read only.

Type:

bool
reduceAnimations

Disable heavy animations.

Type:

bool

Default:

typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)
referenceDate

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

Type:

any

Default:

The closest valid date using the validation props, except callbacks such as `shouldDisableDate`.
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.

    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:

    {}
    sx

    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'
    views

    Available views.

    Type:

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

    Years rendered per row.

    Type:

    3 | 4

    Default:

    3
    The ref is forwarded to the root element.

    CSS

    The following class names are useful for styling with CSS (the state classes are marked).
    To learn more, visit the component customization page.


    .MuiDateCalendar-rootroot

    Styles applied to the root element.

    .MuiDateCalendar-viewTransitionContainerviewTransitionContainer

    Styles applied to the transition group element.

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

    Slots

    calendarHeader

    Default: PickersCalendarHeader

    Description: Custom component for calendar header. Check the PickersCalendarHeader component.

    day

    Default: PickersDay

    Description: Custom component for day. Check the PickersDay component.

    leftArrowIcon

    Default: ArrowLeft

    Description: Icon displayed in the left view switch button.

    nextIconButton

    Default: IconButton

    Description: Button allowing to switch to the right view.

    previousIconButton

    Default: IconButton

    Description: Button allowing to switch to the left view.

    rightArrowIcon

    Default: ArrowRight

    Description: Icon displayed in the right view switch button.

    switchViewButton

    Default: IconButton

    Description: Button displayed to switch between different calendar views.

    switchViewIcon

    Default: ArrowDropDown

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

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