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

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

Import

import { PickersDay } from '@mui/x-date-pickers-pro/PickersDay';
// or
import { PickersDay } from '@mui/x-date-pickers/PickersDay';
// or
import { PickersDay } from '@mui/x-date-pickers-pro';
// or
import { PickersDay } from '@mui/x-date-pickers';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiPickersDay can be used when providing default props or style overrides in the theme.

Props

Props of the native component are also available.

NameTypeDefaultDescription
day*any
The date to show.
outsideCurrentMonth*boolfalse
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 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 that have outsideCurrentMonth={true} are displayed.
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.

CSS

Rule nameGlobal classDescription
root.MuiPickersDay-rootStyles applied to the root element.
dayWithMargin.MuiPickersDay-dayWithMarginStyles applied to the root element if disableMargin=false.
dayOutsideMonth.MuiPickersDay-dayOutsideMonthStyles applied to the root element if outsideCurrentMonth=true and showDaysOutsideCurrentMonth=true.
hiddenDaySpacingFiller.MuiPickersDay-hiddenDaySpacingFillerStyles applied to the root element if outsideCurrentMonth=true and showDaysOutsideCurrentMonth=false.
today.MuiPickersDay-todayStyles applied to the root element if disableHighlightToday=false and today=true.
selected.Mui-selectedState class applied to the root element if selected=true.
disabled.Mui-disabledState class applied to the root element if disabled=true.

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