packages/react-aria-components/docs/DateField.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/datefield-anatomy.svg'; import ChevronRight from '@spectrum-icons/workflow/ChevronRight'; import {Divider} from '@react-spectrum/divider'; import {ExampleCard} from '@react-spectrum/docs/src/ExampleCard'; import Button from '@react-spectrum/docs/pages/assets/component-illustrations/ActionButton.svg'; import Label from '@react-spectrum/docs/pages/assets/component-illustrations/Label.svg'; import Popover from '@react-spectrum/docs/pages/assets/component-illustrations/Popover.svg'; import ListBox from '@react-spectrum/docs/pages/assets/component-illustrations/ListBox.svg'; import Form from '@react-spectrum/docs/pages/assets/component-illustrations/Form.svg'; import InternationalizedDate from '@react-spectrum/docs/pages/assets/component-illustrations/InternationalizedDate.svg'; import {StarterKits} from '@react-spectrum/docs/src/StarterKits';
<PageDescription>{docs.exports.DateField.description}</PageDescription>
<HeaderInfo packageData={packageData} componentNames={['DateField']} />
import {DateField, Label, DateInput, DateSegment} from 'react-aria-components';
<DateField>
<Label>Birth date</Label>
<DateInput>
{segment => <DateSegment segment={segment} />}
</DateInput>
</DateField>
@import './Form.mdx' layer(form);
@import './Button.mdx' layer(button);
@import "@react-aria/example-theme";
.react-aria-DateField {
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 date field can be built using <input type="date">, but this is very limited in functionality, lacking in internationalization capabilities, inconsistent between browsers, and difficult to style. DateField helps achieve accessible and international date and 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 DateField.
A date field consists of a label, and a group of segments representing each unit of a date and time (e.g. years, months, days, etc.). 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 date format, and offers an easy and error-free way to edit dates using the keyboard.
DateField 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 {DateField, Label, DateInput, DateSegment, Text, FieldError} from 'react-aria-components';
<DateField>
<Label />
<DateInput>
{segment => <DateSegment segment={segment} />}
</DateInput>
<Text slot="description" />
<FieldError />
</DateField>
If the date 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 TimeField, so you can reuse many components between them if you have both.
To ensure the proper date and time format in RTL locales, DateInput must have display set to either inline, inline-block, or block.
DateField 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 DateField 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="datefield" />If you will use a DateField 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 DateField 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 {DateFieldProps, DateValue, ValidationResult} from 'react-aria-components';
import {Text, FieldError} from 'react-aria-components';
interface MyDateFieldProps<T extends DateValue> extends DateFieldProps<T> {
label?: string,
description?: string,
errorMessage?: string | ((validation: ValidationResult) => string)
}
function MyDateField<T extends DateValue>({label, description, errorMessage, ...props}: MyDateFieldProps<T>) {
return (
<DateField {...props}>
<Label>{label}</Label>
<DateInput>
{segment => <DateSegment segment={segment} />}
</DateInput>
{description && <Text slot="description">{description}</Text>}
<FieldError>{errorMessage}</FieldError>
</DateField>
);
}
<MyDateField label="Event date" />
A DateField displays a placeholder by default. An initial, uncontrolled value can be provided to the DateField using the defaultValue prop. Alternatively, a controlled value can be provided using the value prop.
Date values are provided using objects in the @internationalized/date package. This library handles correct international date manipulation across calendars, time zones, and other localization concerns. DateField supports values of the following types:
ZonedDateTime.import {parseDate} from '@internationalized/date';
function Example() {
let [value, setValue] = React.useState(parseDate('2020-02-03'));
return (
<>
<MyDateField
label="Date (uncontrolled)"
defaultValue={parseDate('2020-02-03')} />
<MyDateField
label="Date (controlled)"
value={value}
onChange={setValue} />
</>
);
}
DateField 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';
<MyDateField
label="Event date"
defaultValue={parseZonedDateTime('2022-11-07T00:45[America/Los_Angeles]')} />
DateField 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';
<MyDateField
label="Event date"
defaultValue={parseAbsoluteToLocal('2021-11-07T07:45:00Z')}
/>
The granularity prop allows you to control the smallest unit that is displayed by DateField. By default, CalendarDate values are displayed with "day" granularity (year, month, and day), and CalendarDateTime and ZonedDateTime values are displayed with "minute" granularity. More granular time values can be displayed by setting the granularity prop to "second".
In addition, when a value with a time is provided but you wish to only display the date, you can set the granularity to "day". This has no effect on the actual value (it still has a time component), only on what fields are displayed. In the following example, two DateFields are synchronized with the same value, but display different granularities.
function Example() {
let [date, setDate] = React.useState(parseAbsoluteToLocal('2021-04-07T18:45:22Z'));
return (
<>
<MyDateField
label="Date and time"
/*- begin highlight -*/
granularity="second"
/*- end highlight -*/
value={date}
onChange={setDate} />
<MyDateField
label="Date"
/*- begin highlight -*/
granularity="day"
/*- end highlight -*/
value={date}
onChange={setDate} />
</>
);
}
If no value or defaultValue prop is passed, then the granularity prop also affects which type of value is emitted from the onChange event. Note that by default, time values will not have a time zone because none was supplied. You can override this by setting the placeholderValue prop explicitly. Values emitted from onChange will use the time zone of the placeholder value.
import {now} from '@internationalized/date';
<MyDateField
label="Event date"
granularity="second" />
<MyDateField
label="Event date"
placeholderValue={now('America/New_York')}
granularity="second" />
DateField supports selecting dates in many calendar systems used around the world, including Gregorian, Hebrew, Indian, Islamic, Buddhist, and more. Dates are automatically displayed in the appropriate calendar system for the user's locale. The calendar system can be overridden using the Unicode calendar locale extension, passed to the I18nProvider component.
Selected dates passed to onChange always use the same calendar system as the value or defaultValue prop. If no value or defaultValue is provided, then dates passed to onChange are always in the Gregorian calendar since this is the most commonly used. This means that even though the user selects dates in their local calendar system, applications are able to deal with dates from all users consistently.
The below example displays a DateField in the Hindi language, using the Indian calendar. Dates emitted from onChange are in the Gregorian calendar.
import {I18nProvider} from '@react-aria/i18n';
function Example() {
let [date, setDate] = React.useState<DateValue | null>(null);
return (
/*- begin highlight -*/
<I18nProvider locale="hi-IN-u-ca-indian">
<MyDateField label="Date" value={date} onChange={setDate} />
<p>Selected date: {date?.toString()}</p>
</I18nProvider>
);
}
DateField supports the name prop for integration with HTML forms. The value will be submitted to the server as an ISO 8601 formatted string according to the granularity of the value. For example, if the date field allows selecting only a date then a string such as "2023-02-03" will be submitted, and if it allows selecting a time then a string such as "2023-02-03T08:45:00" will be submitted. See the Value section above for more details about the supported value types.
<MyDateField label="Birth date" name="birthday" />
DateField accepts an onChange prop which is triggered whenever the date 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.
import {getLocalTimeZone} from '@internationalized/date';
import {useDateFormatter} from '@react-aria/i18n';
function Example() {
let [date, setDate] = React.useState(parseDate('1985-07-03'));
let formatter = useDateFormatter({dateStyle: 'full'});
return (
<>
<MyDateField label="Birth date" value={date} onChange={setDate} />
<p>Selected date: {date ? formatter.format(date.toDate(getLocalTimeZone())) : '--'}</p>
</>
);
}
DateField 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 DateField. 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>
<DateField name="date" isRequired>
<Label>Appointment date</Label>
<DateInput>
{segment => <DateSegment segment={segment} />}
</DateInput>
<FieldError />
</DateField>
<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-DateField {
.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 dates after today.
import {today} from '@internationalized/date';
<Form>
<MyDateField
label="Appointment date"
/*- begin highlight -*/
minValue={today(getLocalTimeZone())}
/*- end highlight -*/
defaultValue={parseDate('2022-02-03')} />
<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 date is a weekday and not a weekend according to the current locale.
import {isWeekend} from '@internationalized/date';
import {useLocale} from 'react-aria';
function Example() {
let {locale} = useLocale();
return (
<Form>
<MyDateField
label="Appointment date"
/*- begin highlight -*/
validate={date => date && isWeekend(date, locale) ? 'We are closed on weekends.' : null}
/*- end highlight -*/
defaultValue={parseDate('2023-10-28')} />
<Button type="submit">Submit</Button>
</Form>
);
}
The description slot can be used to associate additional help text with a date field.
<DateField granularity="hour">
<Label>Appointment time</Label>
<DateInput>
{segment => <DateSegment segment={segment} />}
</DateInput>
<Text slot="description">Please select a weekday between 9 AM and 5 PM.</Text>
</DateField>
.react-aria-DateField {
[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 the current date at midnight, but you can set it to a more appropriate value if needed.
import {CalendarDate} from '@internationalized/date';
<MyDateField
label="Birth date"
placeholderValue={new CalendarDate(1980, 1, 1)} />
When a ZonedDateTime object is provided as the value to DateField, 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.
<MyDateField
label="Appointment time"
defaultValue={parseZonedDateTime('2022-11-07T10:45[America/Los_Angeles]')}
hideTimeZone />
By default, DateField 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 DateField to use 24-hour time, regardless of the locale.
<MyDateField
label="Appointment time"
granularity="minute"
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-DateField {
/* ... */
}
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 DateField are documented below.
A DateField can be targeted with the .react-aria-DateField 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:
The help text elements within a DateField can be targeted with the [slot=description] and [slot=errorMessage] CSS selectors, or by adding a custom className.
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 DateField, 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).
The components in a DateField support the following contexts:
<ContextTable components={['DateField']} docs={docs} />
This example shows a FieldGroup component that renders a group of date 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 DateFields are marked invalid and associated with the error message via the aria-describedby attribute passed to the DateFieldContext provider.
import {DateFieldContext} 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>
<DateFieldContext.Provider value={{
isInvalid: !!errorMessage,
'aria-describedby': errorMessage ? errorId : undefined
}}>
{children}
</DateFieldContext.Provider>
{errorMessage && <small id={errorId} className="invalid">{errorMessage}</small>}
</fieldset>
);
}
<FieldGroup title="Dates" errorMessage="Tickets must go on sale before event.">
<MyDateField label="Event date" defaultValue={parseDate('2023-07-12')} />
<MyDateField label="Ticket sale date" defaultValue={parseDate('2023-08-03')} />
</FieldGroup>
fieldset {
padding: 1.5em;
width: fit-content;
}
.invalid {
color: var(--invalid-color);
margin-top: 1em;
display: block;
}
DateField 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 DateField.
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 DateField, in place of the builtin React Aria Components Label.
<DateField>
<MyCustomLabel>Name</MyCustomLabel>
<DateInput>
{segment => <DateSegment segment={segment} />}
</DateInput>
</DateField>
DateField provides a <TypeLink links={statelyDocs.links} type={statelyDocs.exports.DateFieldState} /> object to its children via DateFieldStateContext. This can be used to access and manipulate the date field's state.
This example shows a DateFormat component that can be placed within a DateField to display the expected date format.
import {DateFieldStateContext} from 'react-aria-components';
import {useLocale} from 'react-aria';
function DateFormat() {
/*- begin highlight -*/
let state = React.useContext(DateFieldStateContext)!;
/*- end highlight -*/
let {locale} = useLocale();
let displayNames = new Intl.DisplayNames(locale, {type: 'dateTimeField'});
let format = state.segments.map(segment => segment.type === 'literal' ? segment.text : displayNames.of(segment.type)).join(' ');
return <small>{format}</small>;
}
<DateField defaultValue={today(getLocalTimeZone())}>
<Label>Date</Label>
<DateInput>
{segment => <DateSegment segment={segment} />}
</DateInput>
<DateFormat />
</DateField>
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 useDateField for more details.