PickersDay API
API documentation for the React PickersDay component. Learn about the available props and the CSS API.
Import
import PickersDay from '@mui/lab/PickersDay';
// or
import { PickersDay } from '@mui/lab';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. |
| allowSameDateSelection | bool | false | If true, onChange is fired on click even if the same date is selected. |
| children | node | The content of the component. | |
| 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, todays date is rendering without highlighting with circle. |
| disableMargin | bool | false | If true, days are rendering without margin. Useful for displaying linked range of days. |
| 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. |
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
styleOverridesproperty in a custom theme.