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.

install	`yarn add react-aria-components`
version	3.17.0
usage	`import {TimeField} from 'react-aria-components'`

View repository

GitHub

View package

NPM

Example#

import {TimeField, Label, DateInput, DateSegment} from 'react-aria-components';

<TimeField>
  <Label>Event time</Label>
  <DateInput>
    {segment => <DateSegment segment={segment} />}
  </DateInput>
</TimeField>

import {
  DateInput,
  DateSegment,
  Label,
  TimeField
} from 'react-aria-components';

<TimeField>
  <Label>Event time</Label>
  <DateInput>
    {(segment) => <DateSegment segment={segment} />}
  </DateInput>
</TimeField>

import {
  DateInput,
  DateSegment,
  Label,
  TimeField
} from 'react-aria-components';

<TimeField>
  <Label>
    Event time
  </Label>
  <DateInput>
    {(segment) => (
      <DateSegment
        segment={segment}
      />
    )}
  </DateInput>
</TimeField>

Show CSS

.react-aria-DateInput {
  display: flex;
  padding: 4px;
  border: 1px solid var(--spectrum-global-color-gray-400);
  border-radius: 6px;
  background: var(--spectrum-global-color-gray-50);
  width: fit-content;
  min-width: 150px;

  &:focus-within {
    border-color: slateblue;
    box-shadow: 0 0 0 1px slateblue;
  }
}

.react-aria-DateSegment {
  padding: 0 2px;
  font-variant-numeric: tabular-nums;
  text-align: end;

  &[data-type=literal] {
    padding: 0;
  }

  &[data-placeholder] {
    color: var(--spectrum-global-color-gray-700);
    font-style: italic;
  }

  &:focus {
    color: white;
    background: slateblue;
    outline: none;
    border-radius: 4px;
    caret-color: transparent;
  }

  &[aria-invalid] {
    color: var(--spectrum-global-color-red-600);

    &:focus {
      background: var(--spectrum-global-color-static-red-600);
      color: white;
    }
  }
}

.react-aria-TimeField {
  & [slot=description] {
    font-size: 12px;
  }

  & [slot=errorMessage] {
    font-size: 12px;
    color: var(--spectrum-global-color-red-600);
  }
}

.react-aria-DateInput {
  display: flex;
  padding: 4px;
  border: 1px solid var(--spectrum-global-color-gray-400);
  border-radius: 6px;
  background: var(--spectrum-global-color-gray-50);
  width: fit-content;
  min-width: 150px;

  &:focus-within {
    border-color: slateblue;
    box-shadow: 0 0 0 1px slateblue;
  }
}

.react-aria-DateSegment {
  padding: 0 2px;
  font-variant-numeric: tabular-nums;
  text-align: end;

  &[data-type=literal] {
    padding: 0;
  }

  &[data-placeholder] {
    color: var(--spectrum-global-color-gray-700);
    font-style: italic;
  }

  &:focus {
    color: white;
    background: slateblue;
    outline: none;
    border-radius: 4px;
    caret-color: transparent;
  }

  &[aria-invalid] {
    color: var(--spectrum-global-color-red-600);

    &:focus {
      background: var(--spectrum-global-color-static-red-600);
      color: white;
    }
  }
}

.react-aria-TimeField {
  & [slot=description] {
    font-size: 12px;
  }

  & [slot=errorMessage] {
    font-size: 12px;
    color: var(--spectrum-global-color-red-600);
  }
}

.react-aria-DateInput {
  display: flex;
  padding: 4px;
  border: 1px solid var(--spectrum-global-color-gray-400);
  border-radius: 6px;
  background: var(--spectrum-global-color-gray-50);
  width: fit-content;
  min-width: 150px;

  &:focus-within {
    border-color: slateblue;
    box-shadow: 0 0 0 1px slateblue;
  }
}

.react-aria-DateSegment {
  padding: 0 2px;
  font-variant-numeric: tabular-nums;
  text-align: end;

  &[data-type=literal] {
    padding: 0;
  }

  &[data-placeholder] {
    color: var(--spectrum-global-color-gray-700);
    font-style: italic;
  }

  &:focus {
    color: white;
    background: slateblue;
    outline: none;
    border-radius: 4px;
    caret-color: transparent;
  }

  &[aria-invalid] {
    color: var(--spectrum-global-color-red-600);

    &:focus {
      background: var(--spectrum-global-color-static-red-600);
      color: white;
    }
  }
}

.react-aria-TimeField {
  & [slot=description] {
    font-size: 12px;
  }

  & [slot=errorMessage] {
    font-size: 12px;
    color: var(--spectrum-global-color-red-600);
  }
}

Features#

A time field can be built using <input type="time">, but this is very limited in functionality, lacking in internationalization capabilities, inconsistent between browsers, and difficult to style. TimeField helps achieve accessible and international time fields that can be styled as needed.

International – Support for locale-specific formatting, number systems, hour cycles, and right-to-left layout.
Time zone aware – Times can optionally include a time zone. All modifications follow time zone rules such as daylight saving time.
Accessible – Each time unit is displayed as an individually focusable and editable segment, which allows users an easy way to edit times using the keyboard, in any format and locale.
Touch friendly – Time segments are editable using an easy to use numeric keypad, and all interactions are accessible using touch-based screen readers.
Customizable – As with all of React Aria, the DOM structure and styling of all elements can be fully customized.

Read our blog post for more details about the internationalization, accessibility, and user experience features implemented by TimeField.

Anatomy#

A time field consists of a label, and a group of segments representing each unit of a time (e.g. hours, minutes, and seconds). Each segment is individually focusable and editable by the user, by typing or using the arrow keys to increment and decrement the value. This approach allows values to be formatted and parsed correctly regardless of the locale or time format, and offers an easy and error-free way to edit times using the keyboard.

TimeField also supports optional description and error message elements, which can be used to provide more context about the field, and any validation messages. These are linked with the input via the aria-describedby attribute.

If the time field does not have a visible label, an aria-label or aria-labelledby prop must be passed instead to identify it to assistive technology.

Note that most of this anatomy is shared with DateField, so you can reuse many components between them if you have both.

Concepts#

TimeField makes use of the following concepts:

@internationalized/date

Composed components#

A TimeField uses the following components, which may also be used standalone or reused in other components.

Label

A label provides context for an input element.

Props#

TimeField#

Name	Type	Default	Description
`hourCycle`	`12 \| 24`	—	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'`	`'minute'`	Determines the smallest unit that is displayed in the time picker.
`hideTimeZone`	`boolean`	—	Whether to hide the time zone abbreviation.
`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.
`minValue`	`TimeValue`	—	The minimum allowed time that a user may select.
`maxValue`	`TimeValue`	—	The maximum allowed time that a user may select.
`isDisabled`	`boolean`	—	Whether the input is disabled.
`isReadOnly`	`boolean`	—	Whether the input can be selected but not changed by the user.
`validationState`	`ValidationState`	—	Whether the input should display its "valid" or "invalid" visual styling.
`isRequired`	`boolean`	—	Whether user input is required on the input before form submission. Often paired with the `necessityIndicator` prop to add a visual indicator to the input.
`autoFocus`	`boolean`	—	Whether the element should receive focus on render.
`value`	`TimeValue`	—	The current value (controlled).
`defaultValue`	`TimeValue`	—	The default value (uncontrolled).
`children`	`ReactNode \| ( (values: DateFieldState )) => ReactNode`	—
`className`	`string \| ( (values: DateFieldState )) => string`	—
`style`	`CSSProperties \| ( (values: DateFieldState )) => CSSProperties`	—

Events

Name	Type	Default	Description
`onFocus`	`( (e: FocusEvent )) => void`	—	Handler that is called when the element receives focus.
`onBlur`	`( (e: FocusEvent )) => void`	—	Handler that is called when the element loses focus.
`onFocusChange`	`( (isFocused: boolean )) => void`	—	Handler that is called when the element's focus status changes.
`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.
`onChange`	`( (value: MappedTimeValue<TimeValue> )) => void`	—	Handler that is called when the value changes.

Accessibility

Name	Type	Default	Description
`id`	`string`	—	The element's unique identifier. See MDN.
`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.
`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.

Label#

A <Label> accepts all HTML attributes.

DateInput#

The <DateInput> component renders a group of date segments. It accepts a function as its children, which is called to render a <DateSegment> for each segment.

Show props

Name	Type	Default	Description
`children`	`( (segment: DateSegment )) => ReactElement`	—
`className`	`string`	—
`style`	`CSSProperties`	—

Layout

Name	Type	Default	Description
`slot`	`string`	—

DateSegment#

The <DateSegment> component renders an individual segment.

Show props

Name	Type	Default	Description
`segment`	`DateSegment`	—
`children`	`ReactNode \| ( (values: DateSegmentRenderProps )) => ReactNode`	—
`className`	`string \| ( (values: DateSegmentRenderProps )) => string`	—
`style`	`CSSProperties \| ( (values: DateSegmentRenderProps )) => CSSProperties`	—

Styling#

React Aria components can be styled in many ways, including using CSS classes, inline styles, utility classes (e.g. Tailwind), CSS-in-JS (e.g. Styled Components), etc. By default, all components include a builtin className attribute which can be targeted using CSS selectors. These follow the react-aria-ComponentName naming convention.

.react-aria-TimeField {
  /* ... */
}

.react-aria-TimeField {
  /* ... */
}

.react-aria-TimeField {
  /* ... */
}

A custom className can also be specified on any component. This overrides the default className provided by React Aria with your own.

<DateInput className="my-date-input">
  {/* ... */}
</DateInput>

<DateInput className="my-date-input">
  {/* ... */}
</DateInput>

<DateInput className="my-date-input">
  {/* ... */}
</DateInput>;

In addition, some components support multiple UI states (e.g. focused, placeholder, readonly, etc.). React Aria components expose states using DOM attributes, which you can target in CSS selectors. These are ARIA attributes wherever possible, or data attributes when a relevant ARIA attribute does not exist. For example:

.react-aria-DateSegment[data-placeholder] {
  /* ... */
}

.react-aria-DateSegment[aria-readonly] {
  /* ... */
}

.react-aria-DateSegment[data-placeholder] {
  /* ... */
}

.react-aria-DateSegment[aria-readonly] {
  /* ... */
}

.react-aria-DateSegment[data-placeholder] {
  /* ... */
}

.react-aria-DateSegment[aria-readonly] {
  /* ... */
}

The className and style props also accept functions which receive states for styling. This lets you dynamically determine the classes or styles to apply, which is useful when using utility CSS libraries like Tailwind.

<DateSegment
  className={({ isPlaceholder }) =>
    isPlaceholder ? 'bg-gray-300' : 'bg-gray-600'}
/>;

<DateSegment
  className={({ isPlaceholder }) =>
    isPlaceholder ? 'bg-gray-300' : 'bg-gray-600'}
/>;

<DateSegment
  className={(
    { isPlaceholder }
  ) =>
    isPlaceholder
      ? 'bg-gray-300'
      : 'bg-gray-600'}
/>;

Render props may also be used as children to alter what elements are rendered based on the current state. For example, you could render the placeholder as a separate element to always reserve space for it.

<DateSegment>
  {({ text, placeholder, isPlaceholder }) => (
    <>
      <span style={{ visibility: isPlaceholder ? 'visible' : 'hidden' }}>
        {placeholder}
      </span>
      {isPlaceholder ? '' : text}
    </>
  )}
</DateSegment>;

<DateSegment>
  {({ text, placeholder, isPlaceholder }) => (
    <>
      <span
        style={{
          visibility: isPlaceholder ? 'visible' : 'hidden'
        }}
      >
        {placeholder}
      </span>
      {isPlaceholder ? '' : text}
    </>
  )}
</DateSegment>;

<DateSegment>
  {(
    {
      text,
      placeholder,
      isPlaceholder
    }
  ) => (
    <>
      <span
        style={{
          visibility:
            isPlaceholder
              ? 'visible'
              : 'hidden'
        }}
      >
        {placeholder}
      </span>
      {isPlaceholder
        ? ''
        : text}
    </>
  )}
</DateSegment>;

The states, selectors, and render props for each component used in a TimeField are documented below.

TimeField#

A TimeField can be targeted with the .react-aria-TimeField CSS selector, or by overriding with a custom className. It provides a DateFieldState object to its render props, which can be used to customize the className, style, or children.

Label#

A Label can be targeted with the .react-aria-Label CSS selector, or by overriding with a custom className.

DateInput#

A DateInput can be targeted with the .react-aria-DateInput CSS selector, or by overriding with a custom className.

DateSegment#

A DateSegment can be targeted with the .react-aria-DateSegment CSS selector, or by overriding with a custom className. It supports the following states and render props:

Name	CSS Selector	Description
`isPlaceholder`	`[data-placeholder]`	Whether the value is a placeholder.
`isReadOnly`	`[aria-readonly]`	Whether the segment is read only.
`isInvalid`	`[aria-invalid]`	Whether the date field is in an invalid state.
`type`	`[data-type="..."]`	The type of segment. Values include `literal`, `year`, `month`, `day`, etc.
`text`	`—`	The formatted text for the segment.
`value`	`—`	The numeric value for the segment, if applicable.
`minValue`	`—`	The minimum numeric value for the segment, if applicable.
`maxValue`	`—`	The maximum numeric value for the segment, if applicable.
`placeholder`	`—`	A placeholder string for the segment.

Reusable wrappers#

If you will use a TimeField in multiple places in your app, you can wrap all of the pieces into a reusable component. This way, the DOM structure, styling code, and other logic are defined in a single place and reused everywhere to ensure consistency.

This example wraps TimeField and all of its children together into a single component which accepts a label prop, which is passed to the right place. It also shows how to use the description and errorMessage slots to render help text (see below for details).

import {Text} from 'react-aria-components';

function MyTimeField({label, description, errorMessage, ...props}) {
  return (
    <TimeField {...props}>
      <Label>{label}</Label>
      <DateInput>
        {segment => <DateSegment segment={segment} />}
      </DateInput>
      {description && <Text slot="description">{description}</Text>}
      {errorMessage && <Text slot="errorMessage">{errorMessage}</Text>}
    </TimeField>
  );
}

<MyTimeField label="Event time" />

import {Text} from 'react-aria-components';

function MyTimeField(
  { label, description, errorMessage, ...props }
) {
  return (
    <TimeField {...props}>
      <Label>{label}</Label>
      <DateInput>
        {(segment) => <DateSegment segment={segment} />}
      </DateInput>
      {description && (
        <Text slot="description">{description}</Text>
      )}
      {errorMessage && (
        <Text slot="errorMessage">{errorMessage}</Text>
      )}
    </TimeField>
  );
}

<MyTimeField label="Event time" />

import {Text} from 'react-aria-components';

function MyTimeField(
  {
    label,
    description,
    errorMessage,
    ...props
  }
) {
  return (
    <TimeField
      {...props}
    >
      <Label>
        {label}
      </Label>
      <DateInput>
        {(segment) => (
          <DateSegment
            segment={segment}
          />
        )}
      </DateInput>
      {description && (
        <Text slot="description">
          {description}
        </Text>
      )}
      {errorMessage && (
        <Text slot="errorMessage">
          {errorMessage}
        </Text>
      )}
    </TimeField>
  );
}

<MyTimeField label="Event time" />

Usage#

The following examples show how to use the MyTimeField component created in the above example.

Value#

A TimeField displays a placeholder by default. An initial, uncontrolled value can be provided to the TimeField using the defaultValue prop. Alternatively, a controlled value can be provided using the value prop.

Time values are provided using objects in the @internationalized/date package. This library handles correct international date and time manipulation across calendars, time zones, and other localization concerns.

TimeField only supports selecting times, but values with date components are also accepted. By default, TimeField will emit Time objects in the onChange event, but if a CalendarDateTime or ZonedDateTime object is passed as the value or defaultValue, values of that type will be emitted, changing only the time and preserving the date components.

import {Time} from '@internationalized/date';

function Example() {
  let [value, setValue] = React.useState(new Time(11, 45));

  return (
    <>
      <MyTimeField
        label="Time (uncontrolled)"
        defaultValue={new Time(11, 45)} />
      <MyTimeField
        label="Time (controlled)"
        value={value}
        onChange={setValue} />
    </>
  );
}

import {Time} from '@internationalized/date';

function Example() {
  let [value, setValue] = React.useState(new Time(11, 45));

  return (
    <>
      <MyTimeField
        label="Time (uncontrolled)"
        defaultValue={new Time(11, 45)} />
      <MyTimeField
        label="Time (controlled)"
        value={value}
        onChange={setValue} />
    </>
  );
}

import {Time} from '@internationalized/date';

function Example() {
  let [value, setValue] =
    React.useState(
      new Time(11, 45)
    );

  return (
    <>
      <MyTimeField
        label="Time (uncontrolled)"
        defaultValue={new Time(
          11,
          45
        )}
      />
      <MyTimeField
        label="Time (controlled)"
        value={value}
        onChange={setValue}
      />
    </>
  );
}

Time values may also be parsed from strings using the parseTime function. This accepts ISO 8601 formatted time strings such as "04:45:23.123". The toString method of a Time object can also be used to convert a time object to a string.

Time zones#

TimeField is time zone aware when a ZonedDateTime object is provided as the value. In this case, the time zone abbreviation is displayed, and time zone concerns such as daylight saving time are taken into account when the value is manipulated.

In most cases, your data will come from and be sent to a server as an ISO 8601 formatted string. @internationalized/date includes functions for parsing strings in multiple formats into ZonedDateTime objects. Which format you use will depend on what information you need to store.

parseZonedDateTime – This function parses a date with an explicit time zone and optional UTC offset attached (e.g. "2021-11-07T00:45[America/Los_Angeles]" or "2021-11-07T00:45-07:00[America/Los_Angeles]"). This format preserves the maximum amount of information. If the exact local time and time zone that a user selected is important, use this format. Storing the time zone and offset that was selected rather than converting to UTC ensures that the local time is correct regardless of daylight saving rule changes (e.g. if a locale abolishes DST). Examples where this applies include calendar events, reminders, and other times that occur in a particular location.
parseAbsolute – This function parses an absolute date and time that occurs at the same instant at all locations on Earth. It can be represented in UTC (e.g. "2021-11-07T07:45:00Z"), or stored with a particular offset (e.g. "2021-11-07T07:45:00-07:00"). A time zone identifier, e.g. America/Los_Angeles, must be passed, and the result will be converted into that time zone. Absolute times are the best way to represent events that occurred in the past, or future events where an exact time is needed, regardless of time zone.
parseAbsoluteToLocal – This function parses an absolute date and time into the current user's local time zone. It is a shortcut for parseAbsolute, and accepts the same formats.

import {parseZonedDateTime} from '@internationalized/date';

<MyTimeField
  label="Event time"
  defaultValue={parseZonedDateTime('2022-11-07T00:45[America/Los_Angeles]')}
/>

import {parseZonedDateTime} from '@internationalized/date';

<MyTimeField
  label="Event time"
  defaultValue={parseZonedDateTime(
    '2022-11-07T00:45[America/Los_Angeles]'
  )}
/>

import {parseZonedDateTime} from '@internationalized/date';

<MyTimeField
  label="Event time"
  defaultValue={parseZonedDateTime(
    '2022-11-07T00:45[America/Los_Angeles]'
  )}
/>

TimeField displays times in the time zone included in the ZonedDateTime object. The above example is always displayed in Pacific Standard Time because the America/Los_Angeles time zone identifier is provided. @internationalized/date includes functions for converting dates between time zones, or parsing a date directly into a specific time zone or the user's local time zone, as shown below.

import {parseAbsoluteToLocal} from '@internationalized/date';

<MyTimeField
  label="Event time"
  defaultValue={parseAbsoluteToLocal('2021-11-07T07:45:00Z')}
/>

import {parseAbsoluteToLocal} from '@internationalized/date';

<MyTimeField
  label="Event time"
  defaultValue={parseAbsoluteToLocal(
    '2021-11-07T07:45:00Z'
  )}
/>

import {parseAbsoluteToLocal} from '@internationalized/date';

<MyTimeField
  label="Event time"
  defaultValue={parseAbsoluteToLocal(
    '2021-11-07T07:45:00Z'
  )}
/>

Events#

TimeField accepts an onChange prop which is triggered whenever the time is edited by the user. The example below uses onChange to update a separate element with a formatted version of the date in the user's locale and local time zone. This is done by converting the date to a native JavaScript Date object to pass to the formatter. TimeField allows editing the time components while keeping the date fixed.

import {useDateFormatter} from 'react-aria';
import {getLocalTimeZone} from '@internationalized/date';

function Example() {
  let [date, setDate] = React.useState(
    parseAbsoluteToLocal('2021-04-07T18:45:22Z')
  );
  let formatter = useDateFormatter({ dateStyle: 'long', timeStyle: 'long' });

  return (
    <>
      <MyTimeField label="Time" value={date} onChange={setDate} />
      <p>
        Selected date and time:{' '}
        {formatter.format(date.toDate(getLocalTimeZone()))}
      </p>
    </>
  );
}

import {useDateFormatter} from 'react-aria';
import {getLocalTimeZone} from '@internationalized/date';

function Example() {
  let [date, setDate] = React.useState(
    parseAbsoluteToLocal('2021-04-07T18:45:22Z')
  );
  let formatter = useDateFormatter({
    dateStyle: 'long',
    timeStyle: 'long'
  });

  return (
    <>
      <MyTimeField
        label="Time"
        value={date}
        onChange={setDate}
      />
      <p>
        Selected date and time:{' '}
        {formatter.format(date.toDate(getLocalTimeZone()))}
      </p>
    </>
  );
}

import {useDateFormatter} from 'react-aria';
import {getLocalTimeZone} from '@internationalized/date';

function Example() {
  let [date, setDate] =
    React.useState(
      parseAbsoluteToLocal(
        '2021-04-07T18:45:22Z'
      )
    );
  let formatter =
    useDateFormatter({
      dateStyle: 'long',
      timeStyle: 'long'
    });

  return (
    <>
      <MyTimeField
        label="Time"
        value={date}
        onChange={setDate}
      />
      <p>
        Selected date and
        time:{' '}
        {formatter
          .format(
            date.toDate(
              getLocalTimeZone()
            )
          )}
      </p>
    </>
  );
}

Granularity#

The granularity prop allows you to control the smallest unit that is displayed by TimeField. By default, times are displayed with "minute" granularity. More granular time values can be displayed by setting the granularity prop to "second".

<MyTimeField
  label="Event time"
  granularity="second"
  defaultValue={parseAbsoluteToLocal('2021-04-07T18:45:22Z')} />

<MyTimeField
  label="Event time"
  granularity="second"
  defaultValue={parseAbsoluteToLocal(
    '2021-04-07T18:45:22Z'
  )}
/>

<MyTimeField
  label="Event time"
  granularity="second"
  defaultValue={parseAbsoluteToLocal(
    '2021-04-07T18:45:22Z'
  )}
/>

Minimum and maximum values#

The minValue and maxValue props can also be used to perform builtin validation. This marks the time field as invalid using ARIA if the user enters an invalid time. You should implement a visual indication that the time field is invalid as well.

This example only accepts times between 9 AM and 5 PM.

<MyTimeField
  label="Meeting time"
  minValue={new Time(9)}
  maxValue={new Time(17)}
  defaultValue={new Time(8)} />

<MyTimeField
  label="Meeting time"
  minValue={new Time(9)}
  maxValue={new Time(17)}
  defaultValue={new Time(8)} />

<MyTimeField
  label="Meeting time"
  minValue={new Time(
    9
  )}
  maxValue={new Time(
    17
  )}
  defaultValue={new Time(
    8
  )}
/>

Help text#

The description slot can be used to associate additional help text with a date field. Additionally, the errorMessage slot can be used to help the user fix a validation error. It should be combined with the validationState prop to semantically mark the date field as invalid for assistive technologies.

This example validates that the selected time is on a 15 minute increment.

function Example() {
  let [time, setTime] = React.useState(new Time(9, 15));
  let isInvalid = time.minute % 15;

  return (
    <MyTimeField
      label="Meeting time"
      value={time}
      onChange={setTime}
      validationState={isInvalid ? 'invalid' : 'valid'}
      description={isInvalid ? null : 'Select a meeting time'}
      errorMessage={isInvalid ? 'Meetings start every 15 minutes.' : null} />
  );
}

function Example() {
  let [time, setTime] = React.useState(new Time(9, 15));
  let isInvalid = time.minute % 15;

  return (
    <MyTimeField
      label="Meeting time"
      value={time}
      onChange={setTime}
      validationState={isInvalid ? 'invalid' : 'valid'}
      description={isInvalid
        ? null
        : 'Select a meeting time'}
      errorMessage={isInvalid
        ? 'Meetings start every 15 minutes.'
        : null}
    />
  );
}

function Example() {
  let [time, setTime] =
    React.useState(
      new Time(9, 15)
    );
  let isInvalid =
    time.minute % 15;

  return (
    <MyTimeField
      label="Meeting time"
      value={time}
      onChange={setTime}
      validationState={isInvalid
        ? 'invalid'
        : 'valid'}
      description={isInvalid
        ? null
        : 'Select a meeting time'}
      errorMessage={isInvalid
        ? 'Meetings start every 15 minutes.'
        : null}
    />
  );
}

Placeholder value#

When no value is set, a placeholder is shown. The format of the placeholder is influenced by the granularity and placeholderValue props. placeholderValue also controls the default values of each segment when the user first interacts with them, e.g. using the up and down arrow keys. By default, the placeholderValue is midnight, but you can set it to a more appropriate value if needed.

<MyTimeField label="Meeting time" placeholderValue={new Time(9)} />

<MyTimeField
  label="Meeting time"
  placeholderValue={new Time(9)}
/>

<MyTimeField
  label="Meeting time"
  placeholderValue={new Time(
    9
  )}
/>

Hide time zone#

When a ZonedDateTime object is provided as the value to TimeField, the time zone abbreviation is displayed by default. However, if this is displayed elsewhere or implicit based on the usecase, it can be hidden using the hideTimeZone option.

<MyTimeField
  label="Appointment time"
  defaultValue={parseZonedDateTime('2022-11-07T10:45[America/Los_Angeles]')}
  hideTimeZone />

<MyTimeField
  label="Appointment time"
  defaultValue={parseZonedDateTime(
    '2022-11-07T10:45[America/Los_Angeles]'
  )}
  hideTimeZone
/>

<MyTimeField
  label="Appointment time"
  defaultValue={parseZonedDateTime(
    '2022-11-07T10:45[America/Los_Angeles]'
  )}
  hideTimeZone
/>

Hour cycle#

By default, TimeField displays times in either 12 or 24 hour hour format depending on the user's locale. However, this can be overridden using the hourCycle prop if needed for a specific usecase. This example forces TimeField to use 24-hour time, regardless of the locale.

<MyTimeField
  label="Appointment time"
  hourCycle={24} />

<MyTimeField
  label="Appointment time"
  hourCycle={24} />

<MyTimeField
  label="Appointment time"
  hourCycle={24}
/>

Advanced customization#

Composition#

If you need to customize one of the components within a TimeField, such as Label or DateSegment, in many cases you can create a wrapper component. This lets you customize the props passed to the component.

function MyDateSegment(props) {
  return <MyDateSegment {...props} className="my-date-segment" />
}

function MyDateSegment(props) {
  return (
    <MyDateSegment {...props} className="my-date-segment" />
  );
}

function MyDateSegment(
  props
) {
  return (
    <MyDateSegment
      {...props}
      className="my-date-segment"
    />
  );
}

Hooks#

If you need to customize things even further, such as accessing internal state or customizing DOM structure, you can drop down to the lower level Hook-based API. See useTimeField for more details.

Time
  | CalendarDateTime
  | ZonedDateTime

A Time represents a clock time without any date components.

Properties

Name	Type	Description
`hour`	`number`	The hour, numbered from 0 to 23.
`minute`	`number`	The minute in the hour.
`second`	`number`	The second in the minute.
`millisecond`	`number`	The millisecond in the second.

Methods

Method	Description
`constructor( hour: number, minute: number, second: number, millisecond: number ): void`
`copy(): Time`	Returns a copy of this time.
`add( (duration: TimeDuration )): void`	Returns a new `Time` with the given duration added to it.
`subtract( (duration: TimeDuration )): void`	Returns a new `Time` with the given duration subtracted from it.
`set( (fields: TimeFields )): void`	Returns a new `Time` with the given fields set to the provided values. Other fields will be constrained accordingly.
`cycle( field: TimeField, amount: number, options?: CycleTimeOptions ): void`	Returns a new `Time` with the given field adjusted by a specified amount. When the resulting value reaches the limits of the field, it wraps around.
`toString(): void`	Converts the time to an ISO 8601 formatted string.
`compare( (b: AnyTime )): void`	Compares this time with another. A negative result indicates that this time is before the given one, and a positive time indicates that it is after.

A CalendarDateTime represents a date and time without a time zone, in a specific calendar system.

Properties

Name	Type	Description
`calendar`	`Calendar`	The calendar system associated with this date, e.g. Gregorian.
`era`	`string`	The calendar era for this date, e.g. "BC" or "AD".
`year`	`number`	The year of this date within the era.
`month`	`number`	The month number within the year. Note that some calendar systems such as Hebrew may have a variable number of months per year. Therefore, month numbers may not always correspond to the same month names in different years.
`day`	`number`	The day number within the month.
`hour`	`number`	The hour in the day, numbered from 0 to 23.
`minute`	`number`	The minute in the hour.
`second`	`number`	The second in the minute.
`millisecond`	`number`	The millisecond in the second.

Methods

Method	Description
`constructor( (...args: any[] )): void`
`copy(): CalendarDateTime`	Returns a copy of this date.
`add( (duration: DateTimeDuration )): CalendarDateTime`	Returns a new `CalendarDateTime` with the given duration added to it.
`subtract( (duration: DateTimeDuration )): CalendarDateTime`	Returns a new `CalendarDateTime` with the given duration subtracted from it.
`set( (fields: DateFields & & TimeFields )): CalendarDateTime`	Returns a new `CalendarDateTime` with the given fields set to the provided values. Other fields will be constrained accordingly.
`cycle( field: DateField \| \| TimeField, amount: number, options?: CycleTimeOptions ): CalendarDateTime`	Returns a new `CalendarDateTime` with the given field adjusted by a specified amount. When the resulting value reaches the limits of the field, it wraps around.
`toDate( (timeZone: string, , disambiguation?: Disambiguation )): Date`	Converts the date to a native JavaScript Date object in the given time zone.
`toString(): string`	Converts the date to an ISO 8601 formatted string.
`compare( (b: CalendarDate \| CalendarDateTime \| ZonedDateTime )): number`	Compares this date with another. A negative result indicates that this date is before the given one, and a positive date indicates that it is after.

A CalendarDate represents a date without any time components in a specific calendar system.

Properties

Name	Type	Description
`calendar`	`Calendar`	The calendar system associated with this date, e.g. Gregorian.
`era`	`string`	The calendar era for this date, e.g. "BC" or "AD".
`year`	`number`	The year of this date within the era.
`month`	`number`	The month number within the year. Note that some calendar systems such as Hebrew may have a variable number of months per year. Therefore, month numbers may not always correspond to the same month names in different years.
`day`	`number`	The day number within the month.

Methods

Method	Description
`constructor( (...args: any[] )): void`
`copy(): CalendarDate`	Returns a copy of this date.
`add( (duration: DateDuration )): CalendarDate`	Returns a new `CalendarDate` with the given duration added to it.
`subtract( (duration: DateDuration )): CalendarDate`	Returns a new `CalendarDate` with the given duration subtracted from it.
`set( (fields: DateFields )): CalendarDate`	Returns a new `CalendarDate` with the given fields set to the provided values. Other fields will be constrained accordingly.
`cycle( field: DateField, amount: number, options?: CycleOptions ): CalendarDate`	Returns a new `CalendarDate` with the given field adjusted by a specified amount. When the resulting value reaches the limits of the field, it wraps around.
`toDate( (timeZone: string )): Date`	Converts the date to a native JavaScript Date object, with the time set to midnight in the given time zone.
`toString(): string`	Converts the date to an ISO 8601 formatted string.
`compare( (b: AnyCalendarDate )): number`	Compares this date with another. A negative result indicates that this date is before the given one, and a positive date indicates that it is after.

A ZonedDateTime represents a date and time in a specific time zone and calendar system.

Properties

Name	Type	Description
`calendar`	`Calendar`	The calendar system associated with this date, e.g. Gregorian.
`era`	`string`	The calendar era for this date, e.g. "BC" or "AD".
`year`	`number`	The year of this date within the era.
`month`	`number`	The month number within the year. Note that some calendar systems such as Hebrew may have a variable number of months per year. Therefore, month numbers may not always correspond to the same month names in different years.
`day`	`number`	The day number within the month.
`hour`	`number`	The hour in the day, numbered from 0 to 23.
`minute`	`number`	The minute in the hour.
`second`	`number`	The second in the minute.
`millisecond`	`number`	The millisecond in the second.
`timeZone`	`string`	The IANA time zone identifier that this date and time is represented in.
`offset`	`number`	The UTC offset for this time, in seconds.

Methods

Method	Description
`constructor( (...args: any[] )): void`
`copy(): ZonedDateTime`	Returns a copy of this date.
`add( (duration: DateTimeDuration )): void`	Returns a new `ZonedDateTime` with the given duration added to it.
`subtract( (duration: DateTimeDuration )): void`	Returns a new `ZonedDateTime` with the given duration subtracted from it.
`set( (fields: DateFields & & TimeFields, , disambiguation?: Disambiguation )): void`	Returns a new `ZonedDateTime` with the given fields set to the provided values. Other fields will be constrained accordingly.
`cycle( field: DateField \| \| TimeField, amount: number, options?: CycleTimeOptions ): void`	Returns a new `ZonedDateTime` with the given field adjusted by a specified amount. When the resulting value reaches the limits of the field, it wraps around.
`toDate(): void`	Converts the date to a native JavaScript Date object.
`toString(): void`	Converts the date to an ISO 8601 formatted string, including the UTC offset and time zone identifier.
`toAbsoluteString(): void`	Converts the date to an ISO 8601 formatted string in UTC.
`compare( (b: CalendarDate \| CalendarDateTime \| ZonedDateTime )): void`	Compares this date with another. A negative result indicates that this date is before the given one, and a positive date indicates that it is after.

'valid' | 'invalid'

Properties

Name	Type	Description
`value`	`DateValue`	The current field value.
`dateValue`	`Date`	The current value, converted to a native JavaScript `Date` object.
`calendar`	`Calendar`	The calendar system currently in use.
`segments`	`DateSegment[]`	A list of segments for the current value.
`dateFormatter`	`DateFormatter`	A date formatter configured for the current locale and format.
`validationState`	`ValidationState`	The current validation state of the date field, based on the `validationState`, `minValue`, and `maxValue` props.
`granularity`	`Granularity`	The granularity for the field, based on the `granularity` prop and current value.
`maxGranularity`	`'year' \| 'month' \| Granularity`	The maximum date or time unit that is displayed in the field.
`isDisabled`	`boolean`	Whether the field is disabled.
`isReadOnly`	`boolean`	Whether the field is read only.
`isRequired`	`boolean`	Whether the field is required.

Methods

Method	Description
`setValue( (value: DateValue )): void`	Sets the field's value.
`increment( (type: SegmentType )): void`	Increments the given segment. Upon reaching the minimum or maximum value, the value wraps around to the opposite limit.
`decrement( (type: SegmentType )): void`	Decrements the given segment. Upon reaching the minimum or maximum value, the value wraps around to the opposite limit.
`incrementPage( (type: SegmentType )): void`	Increments the given segment by a larger amount, rounding it to the nearest increment. The amount to increment by depends on the field, for example 15 minutes, 7 days, and 5 years. Upon reaching the minimum or maximum value, the value wraps around to the opposite limit.
`decrementPage( (type: SegmentType )): void`	Decrements the given segment by a larger amount, rounding it to the nearest increment. The amount to decrement by depends on the field, for example 15 minutes, 7 days, and 5 years. Upon reaching the minimum or maximum value, the value wraps around to the opposite limit.
`setSegment( (type: SegmentType, , value: number )): void`	Sets the value of the given segment.
`confirmPlaceholder(): void`	Updates the remaining unfilled segments with the placeholder value.
`clearSegment( (type: SegmentType )): void`	Clears the value of the given segment, reverting it to the placeholder.
`formatValue( (fieldOptions: FieldOptions )): string`	Formats the current date value using the given options.

CalendarDate
  | CalendarDateTime
  | ZonedDateTime

The Calendar interface represents a calendar system, including information about how days, months, years, and eras are organized, and methods to perform arithmetic on dates.

Properties

Name	Type	Description
`identifier`	`string`	A string identifier for the calendar, as defined by Unicode CLDR.

Methods

Method	Description
`fromJulianDay( (jd: number )): CalendarDate`	Creates a CalendarDate in this calendar from the given Julian day number.
`toJulianDay( (date: AnyCalendarDate )): number`	Converts a date in this calendar to a Julian day number.
`getDaysInMonth( (date: AnyCalendarDate )): number`	Returns the number of days in the month of the given date.
`getMonthsInYear( (date: AnyCalendarDate )): number`	Returns the number of months in the year of the given date.
`getYearsInEra( (date: AnyCalendarDate )): number`	Returns the number of years in the era of the given date.
`getEras(): string[]`	Returns a list of era identifiers for the calendar.
`getMinimumMonthInYear( (date: AnyCalendarDate )): number`	Returns the minimum month number of the given date's year. Normally, this is 1, but in some calendars such as the Japanese, eras may begin in the middle of a year.
`getMinimumDayInMonth( (date: AnyCalendarDate )): number`	Returns the minimum day number of the given date's month. Normally, this is 1, but in some calendars such as the Japanese, eras may begin in the middle of a month.

Name	Type	Description
`calendar`	`Calendar`
`era`	`string`
`year`	`number`
`month`	`number`
`day`	`number`

Method	Description
`copy():`

Name	Type	Description
`type`	`SegmentType`	The type of segment.
`text`	`string`	The formatted text for the segment.
`isPlaceholder`	`boolean`	Whether the value is a placeholder.
`placeholder`	`string`	A placeholder string for the segment.
`isEditable`	`boolean`	Whether the segment is editable.
`value`	`number`	The numeric value for the segment, if applicable.
`minValue`	`number`	The minimum numeric value for the segment, if applicable.
`maxValue`	`number`	The maximum numeric value for the segment, if applicable.

'era'
  | 'year'
  | 'month'
  | 'day'
  | 'hour'
  | 'minute'
  | 'second'
  | 'dayPeriod'
  | 'literal'
  | 'timeZoneName'

A wrapper around Intl.DateTimeFormat that fixes various browser bugs, and polyfills new features.

Method	Description
`constructor( (locale: string, , options: Intl.DateTimeFormatOptions )): void`
`format( (value: Date )): string`	Formats a date as a string according to the locale and format options passed to the constructor.
`formatToParts( (value: Date )): Intl.DateTimeFormatPart[]`	Formats a date to an array of parts such as separators, numbers, punctuation, and more.
`formatRange( (start: Date, , end: Date )): string`	Formats a date range as a string.
`formatRangeToParts( (start: Date, , end: Date )): DateRangeFormatPart[]`	Formats a date range as an array of parts.
`resolvedOptions(): ResolvedDateTimeFormatOptions`	Returns the resolved formatting options based on the values passed to the constructor.

Name	Type	Description
`source`	`'startRange' \| 'endRange' \| 'shared'`

Name	Type	Description
`hourCycle`

'day'
  | 'hour'
  | 'minute'
  | 'second'

Pick<Intl.DateTimeFormatOptions, 'year'
  | 'month'
  | 'day'
  | 'hour'
  | 'minute'
  | 'second'>

BaseEvent<ReactKeyboardEvent<any>>

SyntheticEvent & {stopPropagation: () => void,
continuePropagation: () => void
}

TimeValue extends ZonedDateTime ? ZonedDateTime :
TimeValue extends CalendarDateTime ? CalendarDateTime :
TimeValue extends Time ? Time : never

Name	Type	Description
`isPlaceholder`	`boolean`	Whether the value is a placeholder.
`isReadOnly`	`boolean`	Whether the segment is read only.
`isInvalid`	`boolean`	Whether the date field is in an invalid state.
`type`	`SegmentType`	The type of segment. Values include `literal`, `year`, `month`, `day`, etc.
`text`	`string`	The formatted text for the segment.
`placeholder`	`string`	A placeholder string for the segment.
`value`	`number`	The numeric value for the segment, if applicable.
`minValue`	`number`	The minimum numeric value for the segment, if applicable.
`maxValue`	`number`	The maximum numeric value for the segment, if applicable.

Parses an ISO 8601 time string.

parseTime(
  (value: string
)): Time

Parses an ISO 8601 date and time string with a time zone extension and optional UTC offset (e.g. "2021-11-07T00:45[America/Los_Angeles]" or "2021-11-07T00:45-07:00[America/Los_Angeles]"). Ambiguous times due to daylight saving time transitions are resolved according to the disambiguation parameter.

parseZonedDateTime(
  (value: string,
  , disambiguation?: Disambiguation
)): ZonedDateTime

'compatible'
  | 'earlier'
  | 'later'
  | 'reject'

Parses an ISO 8601 date and time string with a UTC offset (e.g. "2021-11-07T07:45:00Z" or "2021-11-07T07:45:00-07:00"). The result is converted to the provided time zone.

parseAbsolute(
  (value: string,
  , timeZone: string
)): ZonedDateTime

Parses an ISO 8601 date and time string with a UTC offset (e.g. "2021-11-07T07:45:00Z" or "2021-11-07T07:45:00-07:00"). The result is converted to the user's local time zone.

parseAbsoluteToLocal(
  (value: string
)): ZonedDateTime