PickersDay API
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';
Component name
The nameMuiPickersDay
can be used when providing default props or style overrides in the theme.Props
Props of the native component are also available.
Name | Type | Default | Description |
---|---|---|---|
day* | any | The date to show. | |
outsideCurrentMonth* | bool | false | If true , day is outside of month and will be hidden. |
action | func | { current?: { focusVisible: func } } | A ref for imperative actions. It currently only supports focusVisible() action. | |
centerRipple | bool | false | If true , the ripples are centered. They won't start at the cursor interaction position. |
classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
disabled | bool | false | If true , renders as disabled. |
disableHighlightToday | bool | false | If true , today's date is rendering without highlighting with circle. |
disableMargin | bool | false | If true , days are rendering without margin. Useful for displaying linked range of days. |
disableRipple | bool | false | 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. |
disableTouchRipple | bool | false | If true , the touch ripple effect is disabled. |
focusRipple | bool | false | If true , the base button will have a keyboard focus ripple. |
focusVisibleClassName | string | 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. | |
onFocusVisible | func | Callback fired when the component is focused with a keyboard. We trigger a onFocus callback too. | |
selected | bool | false | If true , renders as selected. |
showDaysOutsideCurrentMonth | bool | false | If true , days that have outsideCurrentMonth={true} are displayed. |
sx | Array<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. | |
today | bool | false | If true , renders as today date. |
TouchRippleProps | object | Props applied to the TouchRipple element. | |
touchRippleRef | func | { 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 name | Global class | Description |
---|---|---|
root | .MuiPickersDay-root | Styles applied to the root element. |
dayWithMargin | .MuiPickersDay-dayWithMargin | Styles applied to the root element if disableMargin=false . |
dayOutsideMonth | .MuiPickersDay-dayOutsideMonth | Styles applied to the root element if outsideCurrentMonth=true and showDaysOutsideCurrentMonth=true . |
hiddenDaySpacingFiller | .MuiPickersDay-hiddenDaySpacingFiller | Styles applied to the root element if outsideCurrentMonth=true and showDaysOutsideCurrentMonth=false . |
today | .MuiPickersDay-today | Styles applied to the root element if disableHighlightToday=false and today=true . |
selected | .Mui-selected | State class applied to the root element if selected=true . |
disabled | .Mui-disabled | State class applied to the root element if disabled=true . |
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.