TimePicker API
API documentation for the React TimePicker component. Learn about the available props and the CSS API.
Import
import TimePicker from '@mui/lab/TimePicker';
// or
import { TimePicker } from '@mui/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 | /\dap/gi | Regular expression to detect "accepted" symbols. |
| ampm | bool | false | 12h/24h view for hour selection clock. |
| ampmInClock | bool | false | Display ampm controls under the clock (instead of in the toolbar). |
| cancelText | node | 'Cancel' | Cancel text message. |
| className | string | className applied to the root component. | |
| clearable | bool | false | If true, it shows the clear action in the picker dialog. |
| clearText | node | 'Clear' | Clear text message. |
| components | { OpenPickerIcon?: elementType } | The components used for each slot. Either a string to use a HTML element or a component. | |
| desktopModeMediaQuery | string | '@media (pointer: fine)' | CSS media query when Mobile mode will be changed to Desktop. |
| DialogProps | object | Props applied to the Dialog element. | |
| disableCloseOnSelect | bool | `true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop). | 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. |
| disableIgnoringDatePartForTimeValidation | bool | false | Do not ignore date part when validating min/max time. |
| 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). |
| getClockLabelText | func | <TDate extends any>( view: ClockView, time: TDate | null, adapter: MuiPickersAdapter<TDate>, ) => `Select ${view}. ${ time === null ? 'No time selected' : `Selected time is ${adapter.format(time, 'fullTime')}` }` | Accessible text that helps user to understand which time and view is selected. |
| getOpenDialogAriaText | func | (value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}` | 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. | |
| inputRef | func | { current?: object } | Pass a ref to the input element. | |
| mask | string | Custom mask. Can be used to override generate from format. (e.g. __/__/____ __:__ or __/__/____ __:__ _M). | |
| maxTime | any | Max time acceptable time. For input validation date part of passed object will be ignored if disableIgnoringDatePartForTimeValidation not specified. | |
| minTime | any | Min time acceptable time. For input validation date part of passed object will be ignored if disableIgnoringDatePartForTimeValidation not specified. | |
| minutesStep | number | 1 | Step over minutes. |
| okText | node | 'OK' | Ok button text. |
| 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). | |
| onViewChange | func | Callback fired on view change. | |
| open | bool | false | Control the popup or dialog open state. |
| OpenPickerButtonProps | object | Props to pass to keyboard adornment button. | |
| openTo | 'hours' | 'minutes' | 'seconds' | First view to show. | |
| orientation | 'landscape' | 'portrait' | Force rendering in particular orientation. | |
| PaperProps | object | Paper props passed down to Paper component. | |
| PopperProps | object | Popper props passed down to Popper component. | |
| readOnly | bool | false | Make picker read only. |
| rifmFormatter | func | Custom formatter to be passed into Rifm component. | |
| shouldDisableTime | func | Dynamically check if time is disabled or not. If returns false appropriate time point will ot be acceptable. | |
| showTodayButton | bool | false | If true, the today button is displayed. Note that showClearButton has a higher priority. |
| showToolbar | bool | false | If true, show the toolbar even in desktop mode. |
| todayText | node | 'Today' | Today text message. |
| ToolbarComponent | elementType | TimePickerToolbar | 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 | 'Select time' | Mobile picker title, displaying in the toolbar. |
| TransitionComponent | elementType | Custom component for popper Transition. | |
| value | any | Date | number | string | The value of the picker. | |
| views | Array<'hours' | 'minutes' | 'seconds'> | Array of views to show. |
The
ref is forwarded to the root element.