TimeField

A time field allows users to enter and edit time values using a keyboard. Each part of a time value is displayed in an individually editable segment.

Theme 
Time
––––AM
 
granularity 
isDisabled 
Example
TimeField.tsx
TimeField.css
import {TimeField} from './TimeField';

<TimeField label="Time" />

Value

Use the value or defaultValue prop to set the time value, using objects in the @internationalized/date package. TimeField accepts plain Time, CalendarDateTime, or ZonedDateTime, but only displays the time.

1145AM

Selected time: 11:45:00

import {Time} from '@internationalized/date';
import {TimeField} from './TimeField';
import {useState} from 'react';

function Example() {
  let [time, setTime] = useState<Time | null>(new Time(11, 45));

  return (
    <>
      <TimeField
        value={time}
        onChange={setTime} />
      <p>Selected time: {time ? time.toString() : '--'}</p>
    </>
  );
}

Format options

The time format is automatically determined based on the user's locale. TimeField supports several props to control how values are displayed.

Time
545PMPST
granularity 
hourCycle 
hideTimeZone 
shouldForceLeadingZeros 
import {parseZonedDateTime} from '@internationalized/date';
import {TimeField} from './TimeField';

<TimeField
  label="Time"
  defaultValue={parseZonedDateTime('2025-02-03T17:45:00[America/Los_Angeles]')} />

Forms

Use the name prop to submit the selected date to the server as an ISO 8601 string. Set the isRequired, minValue, or maxValue props to validate the value, or implement custom client or server-side validation. See the Forms guide to learn more.

Appointment time
––––AM
import {Time} from '@internationalized/date';
import {TimeField} from './TimeField';
import {Button} from './Button';
import {Form} from './Form';;

<Form>
  <TimeField
    label="Appointment time"
    name="time"
    isRequired
    minValue={new Time(9)}
    maxValue={new Time(17)}
    validate={time => time?.minute % 15 !== 0 ? 'Appointments start every 15 minutes.' : null}
  />
  <Button type="submit">Submit</Button>
</Form>

API

Shows a time field with labels pointing to its parts, including the label, field, and segments.Appointment time12 : 45 PMSegmentFieldLabel
<TimeField>
  <Label />
  <DateInput>
    {segment => <DateSegment segment={segment} />}
  </DateInput>
  <Text slot="description" />
  <FieldError />
</TimeField>

TimeField

A time field allows users to enter and edit time values using a keyboard. Each part of a time value is displayed in an individually editable segment.

NameTypeDefault
hourCycle1224Default:
Whether to display the time in 12 or 24 hour format. By default, this is determined by the user's locale.
granularity'hour''minute''second'Default: 'minute'
Determines the smallest unit that is displayed in the time picker.
hideTimeZonebooleanDefault:
Whether to hide the time zone abbreviation.
shouldForceLeadingZerosbooleanDefault:
Whether to always show leading zeros in the hour field. By default, this is determined by the user's locale.
placeholderValueDefault:
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.
isDisabledbooleanDefault:
Whether the input is disabled.
isReadOnlybooleanDefault:
Whether the input can be selected but not changed by the user.
children<>Default:
The children of the component. A function may be provided to alter the children based on component state.
valuenullDefault:
The current value (controlled).
defaultValuenullDefault:
The default value (uncontrolled).
onChange(value: <>null) => voidDefault:
Handler that is called when the value changes.

Default className: react-aria-TimeField

Render PropCSS Selector
stateCSS Selector:
State of the date field.
isInvalidCSS Selector: [data-invalid]
Whether the date field is invalid.
isDisabledCSS Selector: [data-disabled]
Whether the date field is disabled.
isReadOnlyCSS Selector: [data-readonly]
Whether the date field is read only.

DateInput

A date input groups the editable date segments within a date field.

NameType
children(segment: ) => ReactElement

Default className: react-aria-DateInput

Render PropCSS Selector
isHoveredCSS Selector: [data-hovered]
Whether the date input is currently hovered with a mouse.
isFocusWithinCSS Selector: [data-focus-within]
Whether an element within the date input is focused, either via a mouse or keyboard.
isFocusVisibleCSS Selector: [data-focus-visible]
Whether an element within the date input is keyboard focused.
isDisabledCSS Selector: [data-disabled]
Whether the date input is disabled.
isInvalidCSS Selector: [data-invalid]
Whether the date input is invalid.

DateSegment

A date segment displays an individual unit of a date and time, and allows users to edit the value by typing or using the arrow keys to increment and decrement.

NameType
segment
children<>
The children of the component. A function may be provided to alter the children based on component state.

Default className: react-aria-DateSegment

Render PropCSS Selector
isHoveredCSS Selector: [data-hovered]
Whether the segment is currently hovered with a mouse.
isFocusedCSS Selector: [data-focused]
Whether the segment is focused, either via a mouse or keyboard.
isFocusVisibleCSS Selector: [data-focus-visible]
Whether the segment is keyboard focused.
isPlaceholderCSS Selector: [data-placeholder]
Whether the value is a placeholder.
isReadOnlyCSS Selector: [data-readonly]
Whether the segment is read only.
isDisabledCSS Selector: [data-disabled]
Whether the date field is disabled.
isInvalidCSS Selector: [data-invalid]
Whether the date field is in an invalid state.
typeCSS Selector: [data-type="..."]
The type of segment. Values include literal, year, month, day, etc.
textCSS Selector:
The formatted text for the segment.
placeholderCSS Selector:
A placeholder string for the segment.