Skip to content

TimePicker API

API documentation for the React TimePicker component. Learn about the available props, and the CSS API.

Import

import TimePicker from '@material-ui/lab/TimePicker';
// or
import { TimePicker } from '@material-ui/lab';
You can learn about the difference by reading this guide on minimizing bundle size.

Props

NameTypeDefaultDescription
onChange*funcCallback fired when the value (the selected date) changes. @DateIOType.
renderInput*funcThe 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.
acceptRegexRegExpRegular expression to detect "accepted" symbols.
allowKeyboardControlboolfalseEnables keyboard listener for moving between days in calendar.
ampmboolfalse12h/24h view for hour selection clock.
ampmInClockboolfalseDisplay ampm controls under the clock (instead of in the toolbar).
cancelTextnodeCancel text message
classNamestringclassName applied to the root component.
clearableboolfalseIf true, it shows the clear action in the picker dialog.
clearTextnodeClear text message
dateAdapterobjectAllows to pass configured date-io adapter directly. More info here jsx dateAdapter={new AdapterDateFns({ locale: ruLocale })}
desktopModeMediaQuerystringCSS media query when Mobile mode will be changed to Desktop.
DialogPropsobjectProps applied to the Dialog element.
disableCloseOnSelectboolfalseIf true the popup or dialog will immediately close after submitting full date.
disabledboolfalseIf true, the picker and text field are disabled.
disableIgnoringDatePartForTimeValidationboolfalseDo not ignore date part when validating min/max time.
disableMaskedInputboolfalseDisable mask on the keyboard, this should be used rarely. Consider passing proper mask for your format.
disableOpenPickerboolfalseDo not render open picker button (renders only text field with validation).
getClockLabelTextfuncAccessible text that helps user to understand which time and view is selected.
getOpenDialogAriaTextfuncGet aria-label text for control that opens picker dialog. Aria-label text must include selected date. @DateIOType
InputAdornmentPropsobjectProps to pass to keyboard input adornment.
inputFormatstringFormat string.
maskstringCustom mask. Can be used to override generate from format. (e.g. //__ __: or //__ __: _M)
minutesStepnumberStep over minutes.
okTextnodeOk button text.
onAcceptfuncCallback fired when date is accepted @DateIOType.
onClosefuncCallback fired when the popup requests to be closed. Use in controlled mode (see open).
onErrorfuncCallback 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.
onOpenfuncCallback fired when the popup requests to be opened. Use in controlled mode (see open).
openboolfalseControl the popup or dialog open state.
OpenPickerButtonPropsobjectProps to pass to keyboard adornment button.
openPickerIconnodeIcon displaying for open picker button.
openTo'date'
| 'hours'
| 'minutes'
| 'month'
| 'seconds'
| 'year'
First view to show.
orientation'landscape'
| 'portrait'
Force rendering in particular orientation.
PopperPropsobjectPopper props passed down to Popper component.
readOnlyboolfalseMake picker read only.
rifmFormatterfuncCustom formatter to be passed into Rifm component.
shouldDisableTimefuncDynamically check if time is disabled or not. If returns false appropriate time point will ot be acceptable.
showTodayButtonboolfalseIf true, the today button is displayed. Note that showClearButton has a higher priority.
showToolbarboolfalseIf true, show the toolbar even in desktop mode.
todayTextnodeToday text message
ToolbarComponentelementTypeComponent that will replace default toolbar renderer.
toolbarFormatstringDate format, that is displaying in toolbar.
toolbarPlaceholdernodeMobile picker date value placeholder, displaying if value === null.
toolbarTitlenodeMobile picker title, displaying in the toolbar.
TransitionComponentelementTypeCustom component for popper Transition.
valueany
| Date
| number
| string
The value of the picker.
viewsArray<'hours'
| 'minutes'
| 'seconds'>
Array of views to show.

The ref is forwarded to the root element.

Demos