TimeInput

ReactProps

Props

API reference for TimeInput. For usage examples, see the React tab.

Name	Type	Default
children	ChildrenOrFunction<DateFieldRenderProps>	—
The children of the component. A function may be provided to alter the children based on component state.
description	string	—
Adds a description to the input
granularity	"hour" | "minute" | "second"	'minute'
Determines the smallest unit that is displayed in the time picker.
hideTimeZone	boolean	—
Whether to hide the time zone abbreviation.
hourCycle	12 | 24	—
Whether to display the time in 12 or 24 hour format. By default, this is determined by the user's locale.
isDisabled	boolean	—
Whether the input is disabled.
isInvalid	boolean	—
Whether the input value is invalid.
isReadOnly	boolean	—
Whether the input can be selected but not changed by the user.
isRequired	boolean	—
Whether user input is required on the input before form submission.
label	string	—
Adds a label to the input
maxValue	TimeValue | null	—
The maximum allowed time that a user may select.
minValue	TimeValue | null	—
The minimum allowed time that a user may select.
placeholderValue	TimeValue	—
A placeholder time that influences the format of the placeholder shown when no value is selected. Defaults to 12:00 AM or 00:00 depending on the hour cycle.
shouldForceLeadingZeros	boolean	—
Whether to always show leading zeros in the hour field. By default, this is determined by the user's locale.
size	"lg" | "md" | "sm"	md
Controls field height, padding, and segment typography.
compactDeprecated	boolean	—
Use size="md" instead. This prop is a no-op.

Accessibility (5)(5 props)

Advanced (9)(9 props)

Events (70)(70 props)

Forms (7)(7 props)

Styling (2)(2 props)