PickersDay API
API documentation for the React PickersDay component. Learn about the available props, and the CSS API.
Import
import PickersDay from '@material-ui/lab/PickersDay';
// or
import { PickersDay } from '@material-ui/lab';Component name
The nameMuiPickersDay can be used when providing default props or style overrides in the theme.Props
| Name | Type | Default | Description |
|---|---|---|---|
| day* | any | The date to show. | |
| outsideCurrentMonth* | bool | false | If true, day is outside of month and will be hidden. |
| allowKeyboardControl | bool | false | If true, keyboard control and focus management is enabled. |
| allowSameDateSelection | bool | false | If true, onChange is fired on click even if the same date is selected. |
| children | node | The content of the component. | |
| 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. |
| today | bool | false | If true, renders as today date. |
The
ref is forwarded to the root element.Any other props supplied will be provided to the root element (native element).
CSS
| Rule name | Global class | Description |
|---|---|---|
| root | .MuiPickersDay-root | |
| dayWithMargin | .MuiPickersDay-dayWithMargin | |
| dayOutsideMonth | .MuiPickersDay-dayOutsideMonth | |
| hiddenDaySpacingFiller | .MuiPickersDay-hiddenDaySpacingFiller | |
| today | .MuiPickersDay-today | |
| selected | .Mui-selected | |
| disabled | .Mui-disabled |
You can override the style of the component using one of these customization options:
- With a rule name of the
classesobject prop. - With a global class name.
- With a theme and an
styleOverridesproperty.