TimeInput

This component is in beta

While fully functional, the API may change depending on user feedback. We encourage you to try it out and share your experience, as this will help us improve component functionality and stability.

Guidelines React

Github Storybook Markdown Copy for LLM

The TextInput component is composed of a label, input field (input or textarea), and description. It supports built-in accessibility attributes and validation states.

Alternatives

For different time selection patterns, you can use:

Select-based TimePicker

• A dropdown time selection with predefined options.

Combobox-based TimePicker

• A searchable time selection with custom input.

Import

import { UNSTABLE_TimeInput } from "@cfa/react-core";
import { ZonedDateTime } from "@internationalized/date";

Live Editor

Examples

Default

A basic TimeInput with a label.

Required

Use the isRequired prop to indicate that the field must have a value.

With Description

Provide additional context with the description prop.

With Value

Use the value prop to set the value of the input.

With Error Message

Use the errorMessage prop to show an error message.

Props

Visit the Documentation Site for the full list of props.

TimeInput

Name	Type	Default	Description
compact	boolean	false	Renders a compact version of the DateInput
description	string	-	Adds a description to the input
errorMessage	string | ((validation: ValidationResult) => string)	-	Custom error message to display when the input is invalid
label	string	-	Adds a label to the input
aria-describedby	string	-	Identifies the element (or elements) that describes the object.
aria-details	string	-	Identifies the element (or elements) that provide a detailed, extended description for the object.
aria-label	string	-	Defines a string value that labels the current element.
aria-labelledby	string	-	Identifies the element (or elements) that labels the current element.
autoFocus	boolean	-	Whether the element should receive focus on render.
children	ChildrenOrFunction<DateFieldRenderProps>	-	The children of the component. A function may be provided to alter the children based on component state.
className	ClassNameOrFunction<DateFieldRenderProps>	'react-aria-TimeField'	The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state.
defaultValue	TimeValue	-	The default value (uncontrolled).
dir	string	-	-
form	string	-	The `<form>` element to associate the input with. The value of this attribute must be the id of a `<form>` in the same document. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#form).
granularity	"hour" | "minute" | "second"	'minute'	Determines the smallest unit that is displayed in the time picker.
hidden	boolean	-	-
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.
id	string	-	The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id).
inert	boolean	-	-
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.
lang	string	-	-
maxValue	TimeValue	-	The maximum allowed time that a user may select.
minValue	TimeValue	-	The minimum allowed time that a user may select.
name	string	-	The name of the input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname).
onAnimationEnd	AnimationEventHandler<HTMLDivElement>	-	-
onAnimationEndCapture	AnimationEventHandler<HTMLDivElement>	-	-
onAnimationIteration	AnimationEventHandler<HTMLDivElement>	-	-
onAnimationIterationCapture	AnimationEventHandler<HTMLDivElement>	-	-
onAnimationStart	AnimationEventHandler<HTMLDivElement>	-	-
onAnimationStartCapture	AnimationEventHandler<HTMLDivElement>	-	-
onAuxClick	MouseEventHandler<HTMLDivElement>	-	-
onAuxClickCapture	MouseEventHandler<HTMLDivElement>	-	-
onBlur	(e: FocusEvent<Element, Element>) => void	-	Handler that is called when the element loses focus.
onChange	(value: MappedTimeValue<T>) => void	-	Handler that is called when the value changes.
onClick	MouseEventHandler<HTMLDivElement>	-	-
onClickCapture	MouseEventHandler<HTMLDivElement>	-	-
onContextMenu	MouseEventHandler<HTMLDivElement>	-	-
onContextMenuCapture	MouseEventHandler<HTMLDivElement>	-	-
onDoubleClick	MouseEventHandler<HTMLDivElement>	-	-
onDoubleClickCapture	MouseEventHandler<HTMLDivElement>	-	-
onFocus	(e: FocusEvent<Element, Element>) => void	-	Handler that is called when the element receives focus.
onFocusChange	(isFocused: boolean) => void	-	Handler that is called when the element's focus status changes.
onGotPointerCapture	PointerEventHandler<HTMLDivElement>	-	-
onGotPointerCaptureCapture	PointerEventHandler<HTMLDivElement>	-	-
onKeyDown	(e: KeyboardEvent) => void	-	Handler that is called when a key is pressed.
onKeyUp	(e: KeyboardEvent) => void	-	Handler that is called when a key is released.
onLostPointerCapture	PointerEventHandler<HTMLDivElement>	-	-
onLostPointerCaptureCapture	PointerEventHandler<HTMLDivElement>	-	-
onMouseDown	MouseEventHandler<HTMLDivElement>	-	-
onMouseDownCapture	MouseEventHandler<HTMLDivElement>	-	-
onMouseEnter	MouseEventHandler<HTMLDivElement>	-	-
onMouseLeave	MouseEventHandler<HTMLDivElement>	-	-
onMouseMove	MouseEventHandler<HTMLDivElement>	-	-
onMouseMoveCapture	MouseEventHandler<HTMLDivElement>	-	-
onMouseOut	MouseEventHandler<HTMLDivElement>	-	-
onMouseOutCapture	MouseEventHandler<HTMLDivElement>	-	-
onMouseOver	MouseEventHandler<HTMLDivElement>	-	-
onMouseOverCapture	MouseEventHandler<HTMLDivElement>	-	-
onMouseUp	MouseEventHandler<HTMLDivElement>	-	-
onMouseUpCapture	MouseEventHandler<HTMLDivElement>	-	-
onPointerCancel	PointerEventHandler<HTMLDivElement>	-	-
onPointerCancelCapture	PointerEventHandler<HTMLDivElement>	-	-
onPointerDown	PointerEventHandler<HTMLDivElement>	-	-
onPointerDownCapture	PointerEventHandler<HTMLDivElement>	-	-
onPointerEnter	PointerEventHandler<HTMLDivElement>	-	-
onPointerLeave	PointerEventHandler<HTMLDivElement>	-	-
onPointerMove	PointerEventHandler<HTMLDivElement>	-	-
onPointerMoveCapture	PointerEventHandler<HTMLDivElement>	-	-
onPointerOut	PointerEventHandler<HTMLDivElement>	-	-
onPointerOutCapture	PointerEventHandler<HTMLDivElement>	-	-
onPointerOver	PointerEventHandler<HTMLDivElement>	-	-
onPointerOverCapture	PointerEventHandler<HTMLDivElement>	-	-
onPointerUp	PointerEventHandler<HTMLDivElement>	-	-
onPointerUpCapture	PointerEventHandler<HTMLDivElement>	-	-
onScroll	UIEventHandler<HTMLDivElement>	-	-
onScrollCapture	UIEventHandler<HTMLDivElement>	-	-
onTouchCancel	TouchEventHandler<HTMLDivElement>	-	-
onTouchCancelCapture	TouchEventHandler<HTMLDivElement>	-	-
onTouchEnd	TouchEventHandler<HTMLDivElement>	-	-
onTouchEndCapture	TouchEventHandler<HTMLDivElement>	-	-
onTouchMove	TouchEventHandler<HTMLDivElement>	-	-
onTouchMoveCapture	TouchEventHandler<HTMLDivElement>	-	-
onTouchStart	TouchEventHandler<HTMLDivElement>	-	-
onTouchStartCapture	TouchEventHandler<HTMLDivElement>	-	-
onTransitionCancel	TransitionEventHandler<HTMLDivElement>	-	-
onTransitionCancelCapture	TransitionEventHandler<HTMLDivElement>	-	-
onTransitionEnd	TransitionEventHandler<HTMLDivElement>	-	-
onTransitionEndCapture	TransitionEventHandler<HTMLDivElement>	-	-
onTransitionRun	TransitionEventHandler<HTMLDivElement>	-	-
onTransitionRunCapture	TransitionEventHandler<HTMLDivElement>	-	-
onTransitionStart	TransitionEventHandler<HTMLDivElement>	-	-
onTransitionStartCapture	TransitionEventHandler<HTMLDivElement>	-	-
onWheel	WheelEventHandler<HTMLDivElement>	-	-
onWheelCapture	WheelEventHandler<HTMLDivElement>	-	-
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.
render	DOMRenderFunction<"div", DateFieldRenderProps>	-	Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: * You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). * Only a single root DOM element can be rendered (no fragments). * You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.
shouldForceLeadingZeros	boolean	-	Whether to always show leading zeros in the hour field. By default, this is determined by the user's locale.
slot	string	-	A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent.
style	StyleOrFunction<DateFieldRenderProps>	-	The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state.
translate	"yes" | "no"	-	-
validate	(value: MappedTimeValue<T>) => true | ValidationError	-	A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if `validationBehavior="native"`. For realtime validation, use the `isInvalid` prop instead.
validationBehavior	"native" | "aria"	'native'	Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.
value	TimeValue	-	The current value (controlled).