Skip to content

PickersDay API

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

Demos

Import

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

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

Props

Props of the native component are also available.

NameTypeDefaultDescription
day*object-

The date to show.

isFirstVisibleCell*bool-

If true, day is the first visible cell of the month. Either the first day of the month or the first day of the week depending on showDaysOutsideCurrentMonth.

isLastVisibleCell*bool-

If true, day is the last visible cell of the month. Either the last day of the month or the last day of the week depending on showDaysOutsideCurrentMonth.

outsideCurrentMonth*bool-

If true, day is outside of month and will be hidden.

actionfunc
| { current?: { focusVisible: func } }
-

A ref for imperative actions. It currently only supports focusVisible() action.

centerRippleboolfalse

If true, the ripples are centered. They won't start at the cursor interaction position.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

disabledboolfalse

If true, renders as disabled.

disableHighlightTodayboolfalse

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

disableMarginboolfalse

If true, days are rendering without margin. Useful for displaying linked range of days.

disableRippleboolfalse

If true, the ripple effect is disabled.
⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the .Mui-focusVisible class.

disableTouchRippleboolfalse

If true, the touch ripple effect is disabled.

focusRippleboolfalse

If true, the base button will have a keyboard focus ripple.

focusVisibleClassNamestring-

This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.

onFocusVisiblefunc-

Callback fired when the component is focused with a keyboard. We trigger a onFocus callback too.

selectedboolfalse

If true, renders as selected.

showDaysOutsideCurrentMonthboolfalse

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.

sxArray<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.

todayboolfalse

If true, renders as today date.

TouchRipplePropsobject-

Props applied to the TouchRipple element.

touchRippleReffunc
| { current?: { pulsate: func, start: func, stop: func } }
-

A ref that points to the TouchRipple element.

The ref is forwarded to the root element.

Theme default props

You can use MuiPickersDay to change the default props of this component with the theme.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.Mui-disabledState class applied to the root element if disabled=true.
.Mui-selectedState class applied to the root element if selected=true.
.MuiPickersDay-dayOutsideMonthdayOutsideMonthStyles applied to the root element if outsideCurrentMonth=true and showDaysOutsideCurrentMonth=true.
.MuiPickersDay-dayWithMargindayWithMarginStyles applied to the root element if disableMargin=false.
.MuiPickersDay-hiddenDaySpacingFillerhiddenDaySpacingFillerStyles applied to the root element if outsideCurrentMonth=true and showDaysOutsideCurrentMonth=false.
.MuiPickersDay-rootrootStyles applied to the root element.
.MuiPickersDay-todaytodayStyles applied to the root element if disableHighlightToday=false and today=true.

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