packages/react-aria-components/docs/TimeField.mdx
{/* Copyright 2020 Adobe. All rights reserved. This file is licensed to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */}
import {Layout} from '@react-spectrum/docs'; export default Layout;
import docs from 'docs:react-aria-components'; import i18nDocs from 'docs:@internationalized/date'; import statelyDocs from 'docs:@react-stately/datepicker'; import {PropTable, HeaderInfo, TypeLink, PageDescription, StateTable, ContextTable} from '@react-spectrum/docs'; import styles from '@react-spectrum/docs/src/docs.css'; import packageData from 'react-aria-components/package.json'; import Anatomy from '/packages/react-aria/docs/datepicker/timefield-anatomy.svg'; import ChevronRight from '@spectrum-icons/workflow/ChevronRight'; import {Divider} from '@react-spectrum/divider'; import {ExampleCard} from '@react-spectrum/docs/src/ExampleCard'; import Label from '@react-spectrum/docs/pages/assets/component-illustrations/Label.svg'; import InternationalizedDate from '@react-spectrum/docs/pages/assets/component-illustrations/InternationalizedDate.svg'; import Form from '@react-spectrum/docs/pages/assets/component-illustrations/Form.svg'; import {StarterKits} from '@react-spectrum/docs/src/StarterKits';
<PageDescription>{docs.exports.TimeField.description}</PageDescription>
<HeaderInfo packageData={packageData} componentNames={['TimeField']} />
import {TimeField, Label, DateInput, DateSegment} from 'react-aria-components';
<TimeField>
<Label>Event time</Label>
<DateInput>
{segment => <DateSegment segment={segment} />}
</DateInput>
</TimeField>
@import './Form.mdx' layer(form);
@import './Button.mdx' layer(button);
@import "@react-aria/example-theme";
.react-aria-TimeField {
color: var(--text-color);
display: flex;
flex-direction: column;
}
.react-aria-DateInput {
display: inline;
padding: 4px;
border: 1px solid var(--border-color);
border-radius: 6px;
background: var(--field-background);
width: fit-content;
min-width: 150px;
white-space: nowrap;
forced-color-adjust: none;
&[data-focus-within] {
outline: 2px solid var(--focus-ring-color);
outline-offset: -1px;
}
}
.react-aria-DateSegment {
padding: 0 2px;
font-variant-numeric: tabular-nums;
text-align: end;
color: var(--text-color);
&[data-type=literal] {
padding: 0;
}
&[data-placeholder] {
color: var(--text-color-placeholder);
font-style: italic;
}
&:focus {
color: var(--highlight-foreground);
background: var(--highlight-background);
outline: none;
border-radius: 4px;
caret-color: transparent;
}
}
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.
Read our blog post for more details about the internationalization, accessibility, and user experience features implemented by TimeField.
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.
import {TimeField, Label, DateInput, DateSegment, Text, FieldError} from 'react-aria-components';
<TimeField>
<Label />
<DateInput>
{segment => <DateSegment segment={segment} />}
</DateInput>
<Text slot="description" />
<FieldError />
</TimeField>
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.
TimeField makes use of the following concepts:
<ExampleCard url="../internationalized/date/index.html" title="@internationalized/date" description="Represent and manipulate dates and times in a locale-aware manner."> <InternationalizedDate /> </ExampleCard>
<ExampleCard url="forms.html" title="Forms" description="Validating and submitting form data, and integrating with form libraries.">
<Form /> </ExampleCard> </section>A TimeField uses the following components, which may also be used standalone or reused in other components.
<ExampleCard url="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/label" title="Label" description="A label provides context for an input element."> <Label /> </ExampleCard>
</section>To help kick-start your project, we offer starter kits that include example implementations of all React Aria components with various styling solutions. All components are fully styled, including support for dark mode, high contrast mode, and all UI states. Each starter comes with a pre-configured Storybook that you can experiment with, or use as a starting point for your own component library.
<StarterKits component="timefield" />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 slot to render help text, and FieldError component to render validation errors.
import type {TimeFieldProps, TimeValue, ValidationResult} from 'react-aria-components';
import {Text, FieldError} from 'react-aria-components';
interface MyTimeFieldProps<T extends TimeValue> extends TimeFieldProps<T> {
label?: string,
description?: string,
errorMessage?: string | ((validation: ValidationResult) => string)
}
function MyTimeField<T extends TimeValue>({label, description, errorMessage, ...props}: MyTimeFieldProps<T>) {
return (
<TimeField {...props}>
<Label>{label}</Label>
<DateInput>
{segment => <DateSegment segment={segment} />}
</DateInput>
{description && <Text slot="description">{description}</Text>}
<FieldError>{errorMessage}</FieldError>
</TimeField>
);
}
<MyTimeField label="Event time" />
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 <TypeLink links={i18nDocs.links} type={i18nDocs.exports.Time} /> objects in the onChange event, but if a <TypeLink links={i18nDocs.links} type={i18nDocs.exports.CalendarDateTime} /> or <TypeLink links={i18nDocs.links} type={i18nDocs.exports.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} />
</>
);
}
Time values may also be parsed from strings using the <TypeLink links={i18nDocs.links} type={i18nDocs.exports.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.
TimeField is time zone aware when a <TypeLink links={i18nDocs.links} type={i18nDocs.exports.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 <TypeLink links={i18nDocs.links} type={i18nDocs.exports.ZonedDateTime} /> objects. Which format you use will depend on what information you need to store.
"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."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.parseAbsolute, and accepts the same formats.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')}
/>
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"
/*- begin highlight -*/
granularity="second"
/*- end highlight -*/
defaultValue={parseAbsoluteToLocal('2021-04-07T18:45:22Z')} />
TimeField supports the name prop for integration with HTML forms. The value will be submitted to the server as an ISO 8601 formatted string, e.g. "08:45:00".
<MyTimeField label="Meeting time" name="meetingTime" />
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/i18n';
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: {(date?.toDate && formatter.format(date.toDate())) || (date && date.toString()) || '--'}</p>
</>
);
}
TimeField supports the isRequired prop to ensure the user enters a value, as well as minimum and maximum values, and custom client and server-side validation. It can also be integrated with other form libraries. See the Forms guide to learn more.
To display validation errors, add a <FieldError> element as a child of the TimeField. This allows you to render error messages from all of the above sources with consistent custom styles.
import {Form, FieldError, Button} from 'react-aria-components';
<Form>
<TimeField name="time" isRequired>
<Label>Meeting time</Label>
<DateInput>
{segment => <DateSegment segment={segment} />}
</DateInput>
<FieldError />
</TimeField>
<Button type="submit">Submit</Button>
</Form>
.react-aria-DateSegment {
&[data-invalid] {
color: var(--invalid-color);
&:focus {
background: var(--highlight-background-invalid);
color: var(--highlight-foreground);
}
}
}
.react-aria-TimeField {
.react-aria-FieldError {
font-size: 12px;
color: var(--invalid-color);
}
}
By default, FieldError displays default validation messages provided by the browser. See Customizing error messages in the Forms guide to learn how to provide your own custom errors.
The minValue and maxValue props can also be used to ensure the value is within a specific range. This example only accepts times between 9 AM and 5 PM.
<Form>
<MyTimeField
label="Meeting time"
/*- begin highlight -*/
minValue={new Time(9)}
maxValue={new Time(17)}
/*- end highlight -*/
defaultValue={new Time(8)} />
<Button type="submit">Submit</Button>
</Form>
The validate function can be used to perform custom validation logic. It receives the current field value, and should return a string or array of strings representing one or more error messages if the value is invalid.
This example validates that the selected time is on a 15 minute increment.
<Form>
<MyTimeField
label="Meeting time"
/*- begin highlight -*/
validate={time => time?.minute % 15 !== 0 ? 'Meetings start every 15 minutes.' : null}
/*- end highlight -*/
defaultValue={new Time(9, 25)} />
<Button type="submit">Submit</Button>
</Form>
The description slot can be used to associate additional help text with a date field.
<TimeField>
<Label>Appointment time</Label>
<DateInput>
{segment => <DateSegment segment={segment} />}
</DateInput>
<Text slot="description">Please select a time between 9 AM and 5 PM.</Text>
</TimeField>
.react-aria-TimeField {
[slot=description] {
font-size: 12px;
}
}
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)} />
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 />
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} />
A <Label> accepts all HTML attributes.
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.
The <DateSegment> component renders an individual segment.
A <FieldError> displays validation errors.
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 {
/* ... */
}
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>
In addition, some components support multiple UI states (e.g. focused, placeholder, readonly, etc.). React Aria components expose states using data attributes, which you can target in CSS selectors. For example:
.react-aria-DateSegment[data-placeholder] {
/* ... */
}
.react-aria-DateSegment[data-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'} />
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>
The states, selectors, and render props for each component used in a TimeField are documented below.
A TimeField can be targeted with the .react-aria-TimeField CSS selector, or by overriding with a custom className. It supports the following states and render props:
A Label can be targeted with the .react-aria-Label CSS selector, or by overriding with a custom className.
A DateInput can be targeted with the .react-aria-DateInput CSS selector, or by overriding with a custom className. It supports the following states:
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:
A FieldError can be targeted with the .react-aria-FieldError CSS selector, or by overriding with a custom className. It supports the following render props:
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" />
}
All React Aria Components export a corresponding context that can be used to send props to them from a parent element. This enables you to build your own compositional APIs similar to those found in React Aria Components itself. You can send any prop or ref via context that you could pass to the corresponding component. The local props and ref on the component are merged with the ones passed via context, with the local props taking precedence (following the rules documented in mergeProps).
<ContextTable components={['TimeField']} docs={docs} />
This example shows a FieldGroup component that renders a group of time fields with a title and optional error message. It uses the useId hook to generate a unique id for the error message. All of the child TimeFields are marked invalid and associated with the error message via the aria-describedby attribute passed to the TimeFieldContext provider.
import {TimeFieldContext} from 'react-aria-components';
import {useId} from 'react-aria';
interface FieldGroupProps {
title?: string,
children?: React.ReactNode,
errorMessage?: string
}
function FieldGroup({title, children, errorMessage}: FieldGroupProps) {
let errorId = useId();
return (
<fieldset>
<legend>{title}</legend>
<TimeFieldContext.Provider value={{
isInvalid: !!errorMessage,
'aria-describedby': errorMessage ? errorId : undefined
}}>
{children}
</TimeFieldContext.Provider>
{errorMessage && <small id={errorId} className="invalid">{errorMessage}</small>}
</fieldset>
);
}
<FieldGroup title="Schedule meeting time" errorMessage="End time must be after start time.">
<MyTimeField label="Start" defaultValue={new Time(13)} />
<MyTimeField label="End" defaultValue={new Time(9)} />
</FieldGroup>
fieldset {
padding: 1.5em;
width: fit-content;
}
.invalid {
color: var(--invalid-color);
margin-top: 1em;
display: block;
}
TimeField passes props to its child components, such as the label, via their associated contexts. These contexts are exported so you can also consume them in your own custom components. This enables you to reuse existing components from your app or component library together with React Aria Components.
<ContextTable components={['Label', 'Text']} docs={docs} />
This example consumes from LabelContext in an existing styled label component to make it compatible with React Aria Components. The <TypeLink links={docs.links} type={docs.exports.useContextProps} /> hook merges the local props and ref with the ones provided via context by TimeField.
import type {LabelProps} from 'react-aria-components';
import {LabelContext, useContextProps} from 'react-aria-components';
const MyCustomLabel = React.forwardRef((props: LabelProps, ref: React.ForwardedRef<HTMLLabelElement>) => {
// Merge the local props and ref with the ones provided via context.
///- begin highlight -///
[props, ref] = useContextProps(props, ref, LabelContext);
///- end highlight -///
// ... your existing Label component
return <label {...props} ref={ref} />;
});
Now you can use MyCustomLabel within a TimeField, in place of the builtin React Aria Components Label.
<TimeField>
<MyCustomLabel>Name</MyCustomLabel>
<DateInput>
{segment => <DateSegment segment={segment} />}
</DateInput>
</TimeField>
TimeField provides a <TypeLink links={statelyDocs.links} type={statelyDocs.exports.TimeFieldState} /> object to its children via TimeFieldStateContext. This can be used to access and manipulate the time field's state.
This example shows a TimeZoneName component that can be placed within a TimeField to display the full time zone name.
import {TimeFieldStateContext} from 'react-aria-components';
import {useDateFormatter} from 'react-aria';
function TimeZoneName() {
/*- begin highlight -*/
let state = React.useContext(TimeFieldStateContext)!;
/*- end highlight -*/
if ('timeZone' in state.value) {
let formatter = useDateFormatter({timeZoneName: 'long', timeZone: state.value.timeZone});
let timeZone = formatter
.formatToParts(state.value.toDate())
.find(p => p.type === 'timeZoneName').value;
return <small>{timeZone}</small>;
}
return null;
}
<TimeField value={parseAbsoluteToLocal('2021-04-07T18:45:22Z')}>
<Label>Time</Label>
<DateInput>
{segment => <DateSegment segment={segment} />}
</DateInput>
<TimeZoneName />
</TimeField>
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.