StaticDatePicker API
API documentation for the React StaticDatePicker component. Learn about the available props, and the CSS API.
Import
import StaticDatePicker from '@material-ui/lab/StaticDatePicker';
// or
import { StaticDatePicker } from '@material-ui/lab';Props
| Name | Type | Default | Description |
|---|---|---|---|
| onChange* | func | Callback fired when the value (the selected date) changes @DateIOType. | |
| renderInput* | func | The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys. | |
| acceptRegex | RegExp | Regular expression to detect "accepted" symbols. | |
| className | string | className applied to the root component. | |
| dateAdapter | object | Allows to pass configured date-io adapter directly. More info here. jsx dateAdapter={new AdapterDateFns({ locale: ruLocale })} | |
| disableCloseOnSelect | bool | false | If true the popup or dialog will immediately close after submitting full date. |
| disabled | bool | false | If true, the picker and text field are disabled. |
| disableMaskedInput | bool | false | Disable mask on the keyboard, this should be used rarely. Consider passing proper mask for your format. |
| disableOpenPicker | bool | false | Do not render open picker button (renders only text field with validation). |
| displayStaticWrapperAs | 'desktop' | 'mobile' | Force static wrapper inner components to be rendered in mobile or desktop mode. | |
| getOpenDialogAriaText | func | Get aria-label text for control that opens picker dialog. Aria-label text must include selected date. @DateIOType | |
| InputAdornmentProps | object | Props to pass to keyboard input adornment. | |
| inputFormat | string | Format string. | |
| mask | string | Custom mask. Can be used to override generate from format. (e.g. __/__/____ __:__ or __/__/____ __:__ _M). | |
| onAccept | func | Callback fired when date is accepted @DateIOType. | |
| onClose | func | Callback fired when the popup requests to be closed. Use in controlled mode (see open). | |
| onError | func | Callback that fired when input value or new value prop validation returns new validation error (or value is valid after error). In case of validation error detected reason prop return non-null value and TextField must be displayed in error state. This can be used to render appropriate form error.Read the guide about form integration and error displaying. | |
| onOpen | func | Callback fired when the popup requests to be opened. Use in controlled mode (see open). | |
| open | bool | false | Control the popup or dialog open state. |
| OpenPickerButtonProps | object | Props to pass to keyboard adornment button. | |
| openPickerIcon | node | Icon displaying for open picker button. | |
| orientation | 'landscape' | 'portrait' | Force rendering in particular orientation. | |
| readOnly | bool | false | Make picker read only. |
| rifmFormatter | func | Custom formatter to be passed into Rifm component. | |
| showToolbar | bool | false | If true, show the toolbar even in desktop mode. |
| ToolbarComponent | elementType | Component that will replace default toolbar renderer. | |
| toolbarFormat | string | Date format, that is displaying in toolbar. | |
| toolbarPlaceholder | node | Mobile picker date value placeholder, displaying if value === null. | |
| toolbarTitle | node | Mobile picker title, displaying in the toolbar. | |
| value | any | Date | number | string | The value of the picker. |
The component cannot hold a ref.
Any other props supplied will be provided to the root element (native element).