DateField

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

install	`yarn add react-aria-components`
version	1.1.0
usage	`import {DateField} from 'react-aria-components'`

View repository

GitHub

View package

NPM

Example#

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

<DateField>
  <Label>Birth date</Label>
  <DateInput>
    {segment => <DateSegment segment={segment} />}
  </DateInput>
</DateField>

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

<DateField>
  <Label>Birth date</Label>
  <DateInput>
    {(segment) => <DateSegment segment={segment} />}
  </DateInput>
</DateField>

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

<DateField>
  <Label>
    Birth date
  </Label>
  <DateInput>
    {(segment) => (
      <DateSegment
        segment={segment}
      />
    )}
  </DateInput>
</DateField>

Show CSS

@import "@react-aria/example-theme";

.react-aria-DateField {
  color: var(--text-color);
}

.react-aria-DateInput {
  display: flex;
  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;
  }
}

@import "@react-aria/example-theme";

.react-aria-DateField {
  color: var(--text-color);
}

.react-aria-DateInput {
  display: flex;
  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;
  }
}

@import "@react-aria/example-theme";

.react-aria-DateField {
  color: var(--text-color);
}

.react-aria-DateInput {
  display: flex;
  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;
  }
}

Features#

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.

Dates and times – Support for dates and times with configurable granularity.
International – Support for 13 calendar systems used around the world, including Gregorian, Buddhist, Islamic, Persian, and more. Locale-specific formatting, number systems, hour cycles, and right-to-left support are available as well.
Time zone aware – Dates and times can optionally include a time zone. All modifications follow time zone rules such as daylight saving time.
Accessible – Each date and time unit is displayed as an individually focusable and editable segment, which allows users an easy way to edit dates using the keyboard, in any date format and locale.
Touch friendly – Date segments are editable using an easy to use numeric keypad, and all interactions are accessible using touch-based screen readers.
Validation – Integrates with HTML forms, supporting required, minimum and maximum values, custom validation functions, realtime validation, and server-side validation errors.
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 DateField.

Anatomy#

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, DateInput, DateSegment, FieldError, Label, Text} from 'react-aria-components';

<DateField>
  <Label />
  <DateInput>
    {(segment) => <DateSegment segment={segment} />}
  </DateInput>
  <Text slot="description" />
  <FieldError />
</DateField>

import {
  DateField,
  DateInput,
  DateSegment,
  FieldError,
  Label,
  Text
} from 'react-aria-components';

<DateField>
  <Label />
  <DateInput>
    {(segment) => <DateSegment segment={segment} />}
  </DateInput>
  <Text slot="description" />
  <FieldError />
</DateField>

import {
  DateField,
  DateInput,
  DateSegment,
  FieldError,
  Label,
  Text
} 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.

Concepts#

DateField makes use of the following concepts:

@internationalized/date

Represent and manipulate dates and times in a locale-aware manner.

Forms

Validating and submitting form data, and integrating with form libraries.

Composed components#

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

Label

A label provides context for an input element.

Starter kits#

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.

Reusable wrappers#

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 {FieldError, Text} 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" />

import type {
  DateFieldProps,
  DateValue,
  ValidationResult
} from 'react-aria-components';
import {FieldError, Text} 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" />

import type {
  DateFieldProps,
  DateValue,
  ValidationResult
} from 'react-aria-components';
import {
  FieldError,
  Text
} 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" />

Value#

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:

CalendarDate – a date without any time components. May be parsed from a string representation using the parseDate function. Use this type to represent dates where the time is not important, such as a birthday or an all day calendar event.
CalendarDateTime – a date with a time, but not in any specific time zone. May be parsed from a string representation using the parseDateTime function. Use this type to represent times that occur at the same local time regardless of the time zone, such as the time of New Years Eve fireworks which always occur at midnight. Most times are better stored as a ZonedDateTime.
ZonedDateTime – a date with a time in a specific time zone. May be parsed from a string representation using the parseZonedDateTime, parseAbsolute, or parseAbsoluteToLocal functions. Use this type to represent an exact moment in time at a particular location on Earth.

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} />
    </>
  );
}

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}
      />
    </>
  );
}

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}
      />
    </>
  );
}

Time zones#

DateField 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';

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

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

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

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')}
/>

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

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

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

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

Granularity#

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"
        granularity="second"        value={date}
        onChange={setDate}
      />
      <MyDateField
        label="Date"
        granularity="day"        value={date}
        onChange={setDate}
      />
    </>
  );
}

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

  return (
    <>
      <MyDateField
        label="Date and time"
        granularity="second"        value={date}
        onChange={setDate}
      />
      <MyDateField
        label="Date"
        granularity="day"        value={date}
        onChange={setDate}
      />
    </>
  );
}

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

  return (
    <>
      <MyDateField
        label="Date and time"
        granularity="second"        value={date}
        onChange={setDate}
      />
      <MyDateField
        label="Date"
        granularity="day"        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" />

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

<MyDateField
  label="Event date"
  granularity="second" />
<MyDateField
  label="Event date"
  placeholderValue={now('America/New_York')}
  granularity="second" />

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

<MyDateField
  label="Event date"
  granularity="second"
/>
<MyDateField
  label="Event date"
  placeholderValue={now(
    'America/New_York'
  )}
  granularity="second"
/>

International calendars#

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';

function Example() {
  let [date, setDate] = React.useState<DateValue | null>(null);
  return (
    <I18nProvider locale="hi-IN-u-ca-indian">      <MyDateField label="Date" value={date} onChange={setDate} />
      <p>Selected date: {date?.toString()}</p>
    </I18nProvider>
  );
}

import {I18nProvider} from 'react-aria';

function Example() {
  let [date, setDate] = React.useState<DateValue | null>(
    null
  );
  return (
    <I18nProvider locale="hi-IN-u-ca-indian">      <MyDateField
        label="Date"
        value={date}
        onChange={setDate}
      />
      <p>Selected date: {date?.toString()}</p>
    </I18nProvider>
  );
}

import {I18nProvider} from 'react-aria';

function Example() {
  let [date, setDate] =
    React.useState<
      DateValue | null
    >(null);
  return (
    <I18nProvider locale="hi-IN-u-ca-indian">      <MyDateField
        label="Date"
        value={date}
        onChange={setDate}
      />
      <p>
        Selected date:
        {' '}
        {date
          ?.toString()}
      </p>
    </I18nProvider>
  );
}

HTML forms#

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" />

<MyDateField label="Birth date" name="birthday" />

<MyDateField
  label="Birth date"
  name="birthday"
/>

Events#

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 {useDateFormatter} from 'react-aria';
import {getLocalTimeZone} from '@internationalized/date';

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>
    </>
  );
}

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

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>
    </>
  );
}

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

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>
    </>
  );
}

Validation#

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>

import {
  Button,
  FieldError,
  Form
} 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>

import {
  Button,
  FieldError,
  Form
} 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>

Show CSS

.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);
  }
}

.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);
  }
}

.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.

Minimum and maximum values#

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"
    minValue={today(getLocalTimeZone())}    defaultValue={parseDate('2022-02-03')} />
  <Button type="submit">Submit</Button>
</Form>

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

<Form>
  <MyDateField
    label="Appointment date"
    minValue={today(getLocalTimeZone())}    defaultValue={parseDate('2022-02-03')} />
  <Button type="submit">Submit</Button>
</Form>

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

<Form>
  <MyDateField
    label="Appointment date"
    minValue={today(
      getLocalTimeZone()
    )}    defaultValue={parseDate(
      '2022-02-03'
    )}
  />
  <Button type="submit">
    Submit
  </Button>
</Form>

Custom validation#

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"
        validate={(date) =>
          date && isWeekend(date, locale) ? 'We are closed on weekends.' : null}        defaultValue={parseDate('2023-10-28')}
      />
      <Button type="submit">Submit</Button>
    </Form>
  );
}

import {isWeekend} from '@internationalized/date';
import {useLocale} from 'react-aria';

function Example() {
  let { locale } = useLocale();

  return (
    <Form>
      <MyDateField
        label="Appointment date"
        validate={(date) =>
          date && isWeekend(date, locale)
            ? 'We are closed on weekends.'
            : null}        defaultValue={parseDate('2023-10-28')}
      />
      <Button type="submit">Submit</Button>
    </Form>
  );
}

import {isWeekend} from '@internationalized/date';
import {useLocale} from 'react-aria';

function Example() {
  let { locale } =
    useLocale();

  return (
    <Form>
      <MyDateField
        label="Appointment date"
        validate={(date) =>
          date &&
            isWeekend(
              date,
              locale
            )
            ? 'We are closed on weekends.'
            : null}        defaultValue={parseDate(
          '2023-10-28'
        )}
      />
      <Button type="submit">
        Submit
      </Button>
    </Form>
  );
}

Description#

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>

<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>

<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>

Show CSS

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

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

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

Format options#

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 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)} />

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

<MyDateField
  label="Birth date"
  placeholderValue={new CalendarDate(1980, 1, 1)} />

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

<MyDateField
  label="Birth date"
  placeholderValue={new CalendarDate(
    1980,
    1,
    1
  )}
/>

Hide time zone#

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 />

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

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

Hour cycle#

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} />

<MyDateField
  label="Appointment time"
  granularity="minute"
  hourCycle={24} />

<MyDateField
  label="Appointment time"
  granularity="minute"
  hourCycle={24}
/>

Props#

DateField#

Name	Type	Default	Description
`minValue`	`DateValue`	—	The minimum allowed date that a user may select.
`maxValue`	`DateValue`	—	The maximum allowed date that a user may select.
`isDateUnavailable`	`( (date: DateValue )) => boolean`	—	Callback that is called for each date of the calendar. If it returns true, then the date is unavailable.
`placeholderValue`	`DateValue`	—	A placeholder date that influences the format of the placeholder shown when no value is selected. Defaults to today's date at midnight.
`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`	`Granularity`	—	Determines the smallest unit that is displayed in the date picker. By default, this is `"day"` for dates, and `"minute"` for times.
`hideTimeZone`	`boolean`	`false`	Whether to hide the time zone abbreviation.
`shouldForceLeadingZeros`	`boolean`	—	Whether to always show leading zeros in the month, day, and hour fields. By default, this is determined by the user's locale.
`isDisabled`	`boolean`	—	Whether the input is disabled.
`isReadOnly`	`boolean`	—	Whether the input can be selected but not changed by the user.
`isRequired`	`boolean`	—	Whether user input is required on the input before form submission.
`isInvalid`	`boolean`	—	Whether the input value is invalid.
`validate`	`( (value: MappedDateValue<DateValue> )) => ValidationError \| true \| null \| undefined`	—	A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if `validationBehavior="native"`. For realtime validation, use the `isInvalid` prop instead.
`autoFocus`	`boolean`	—	Whether the element should receive focus on render.
`isOpen`	`boolean`	—	Whether the overlay is open by default (controlled).
`defaultOpen`	`boolean`	—	Whether the overlay is open by default (uncontrolled).
`value`	`DateValue \| null`	—	The current value (controlled).
`defaultValue`	`DateValue \| null`	—	The default value (uncontrolled).
`name`	`string`	—	The name of the input element, used when submitting an HTML form. See MDN.
`validationBehavior`	`'native' \| 'aria'`	`'native'`	Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.
`children`	`ReactNode \| ( (values: DateFieldRenderProps )) => ReactNode`	—	The children of the component. A function may be provided to alter the children based on component state.
`className`	`string \| ( (values: DateFieldRenderProps )) => string`	—	The CSS className for the element. A function may be provided to compute the class based on component state.
`style`	`CSSProperties \| ( (values: DateFieldRenderProps )) => CSSProperties`	—	The inline style for the element. A function may be provided to compute the style based on component state.

Events

Name	Type	Description
`onFocus`	`( (e: FocusEvent<Target> )) => void`	Handler that is called when the element receives focus.
`onBlur`	`( (e: FocusEvent<Target> )) => 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.
`onOpenChange`	`( (isOpen: boolean )) => void`	Handler that is called when the overlay's open state changes.
`onChange`	`( (value: MappedDateValue<DateValue> )) => void`	Handler that is called when the value changes.

Layout

Name	Type	Description
`slot`	`string \| null`	A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent.

Accessibility

Name	Type	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	Description
`children`	`( (segment: DateSegment )) => ReactElement`
`className`	`string \| ( (values: DateInputRenderProps )) => string`	The CSS className for the element. A function may be provided to compute the class based on component state.
`style`	`CSSProperties \| ( (values: DateInputRenderProps )) => CSSProperties`	The inline style for the element. A function may be provided to compute the style based on component state.

Layout

Name	Type	Description
`slot`	`string \| null`	A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent.

DateSegment#

The <DateSegment> component renders an individual segment.

Show props

Name	Type	Description
`segment`	`DateSegment`
`children`	`ReactNode \| ( (values: DateSegmentRenderProps )) => ReactNode`	The children of the component. A function may be provided to alter the children based on component state.
`className`	`string \| ( (values: DateSegmentRenderProps )) => string`	The CSS className for the element. A function may be provided to compute the class based on component state.
`style`	`CSSProperties \| ( (values: DateSegmentRenderProps )) => CSSProperties`	The inline style for the element. A function may be provided to compute the style based on component state.

Events

Name	Type	Description
`onHoverStart`	`( (e: HoverEvent )) => void`	Handler that is called when a hover interaction starts.
`onHoverEnd`	`( (e: HoverEvent )) => void`	Handler that is called when a hover interaction ends.
`onHoverChange`	`( (isHovering: boolean )) => void`	Handler that is called when the hover state changes.

FieldError#

A <FieldError> displays validation errors.

Show props

Name	Type	Description
`children`	`ReactNode \| ( (values: FieldErrorRenderProps )) => ReactNode`	The children of the component. A function may be provided to alter the children based on component state.
`className`	`string \| ( (values: FieldErrorRenderProps )) => string`	The CSS className for the element. A function may be provided to compute the class based on component state.
`style`	`CSSProperties \| ( (values: FieldErrorRenderProps )) => CSSProperties`	The inline style for the element. A function may be provided to compute the style based on component state.

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-DateField {
  /* ... */
}

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

.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>

<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 data attributes, which you can target in CSS selectors. For example:

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

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

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

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

.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'}
/>

<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 DateField are documented below.

DateField#

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:

Name	CSS Selector	Description
`state`	`—`	State of the date field.
`isInvalid`	`[data-invalid]`	Whether the date field is invalid.
`isDisabled`	`[data-disabled]`	Whether the date field is disabled.

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. It supports the following states:

Name	CSS Selector	Description
`isHovered`	`[data-hovered]`	Whether the date input is currently hovered with a mouse.
`isFocusWithin`	`[data-focus-within]`	Whether an element within the date input is focused, either via a mouse or keyboard.
`isFocusVisible`	`[data-focus-visible]`	Whether an element within the date input is keyboard focused.
`isDisabled`	`[data-disabled]`	Whether the date input is disabled.
`isInvalid`	`[data-invalid]`	Whether the date input is invalid.

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
`isHovered`	`[data-hovered]`	Whether the segment is currently hovered with a mouse.
`isFocused`	`[data-focused]`	Whether the segment is focused, either via a mouse or keyboard.
`isFocusVisible`	`[data-focus-visible]`	Whether the segment is keyboard focused.
`isPlaceholder`	`[data-placeholder]`	Whether the value is a placeholder.
`isReadOnly`	`[data-readonly]`	Whether the segment is read only.
`isDisabled`	`[data-disabled]`	Whether the date field is disabled.
`isInvalid`	`[data-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.
`placeholder`	`—`	A placeholder string for the segment.

Text#

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.

FieldError#

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:

Name	Description
`isInvalid`	Whether the input value is invalid.
`validationErrors`	The current error messages for the input if it is invalid, otherwise an empty array.
`validationDetails`	The native validation details for the input.

Advanced customization#

Composition#

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" />
}

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

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

Contexts#

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:

Component	Context	Props	Ref
`DateField`	`DateFieldContext`	`DateFieldProps`	`HTMLDivElement`

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>

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>

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>

Show CSS

fieldset {
  padding: 1.5em;
  width: fit-content;
}

.invalid {
  color: var(--invalid-color);
  margin-top: 1em;
  display: block;
}

fieldset {
  padding: 1.5em;
  width: fit-content;
}

.invalid {
  color: var(--invalid-color);
  margin-top: 1em;
  display: block;
}

fieldset {
  padding: 1.5em;
  width: fit-content;
}

.invalid {
  color: var(--invalid-color);
  margin-top: 1em;
  display: block;
}

Custom children#

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.

Component	Context	Props	Ref
`Label`	`LabelContext`	`LabelProps`	`HTMLLabelElement`
`Text`	`TextContext`	`TextProps`	`HTMLElement`

This example consumes from LabelContext in an existing styled label component to make it compatible with React Aria Components. The 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.
    [props, ref] = useContextProps(props, ref, LabelContext);
    // ... your existing Label component
    return <label {...props} ref={ref} />;
  }
);

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.
    [props, ref] = useContextProps(
      props,
      ref,
      LabelContext
    );
    // ... your existing Label component
    return <label {...props} ref={ref} />;
  }
);

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.
      [props, ref] =
        useContextProps(
          props,
          ref,
          LabelContext
        );
      // ... 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>
  <MyCustomLabel>Name</MyCustomLabel>  <DateInput>
    {segment => <DateSegment segment={segment} />}
  </DateInput>
</DateField>

<DateField>
  <MyCustomLabel>
    Name
  </MyCustomLabel>  <DateInput>
    {(segment) => (
      <DateSegment
        segment={segment}
      />
    )}
  </DateInput>
</DateField>

State#

DateField provides a 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() {
  let state = React.useContext(DateFieldStateContext)!;  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>

import {DateFieldStateContext} from 'react-aria-components';
import {useLocale} from 'react-aria';

function DateFormat() {
  let state = React.useContext(DateFieldStateContext)!;  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>

import {DateFieldStateContext} from 'react-aria-components';
import {useLocale} from 'react-aria';

function DateFormat() {
  let state = React
    .useContext(
      DateFieldStateContext
    )!;  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>

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 useDateField for more details.

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.

Parses an ISO 8601 date string, with no time components.

parseDate(
  (value: string
)): CalendarDate

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 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 milliseconds.

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.

Parses an ISO 8601 date and time string, with no time zone.

parseDateTime(
  (value: string
)): CalendarDateTime

Parses an ISO 8601 date and time string with a time zone extension and optional UTC offset (e.g. "2021-11-07T00:45[America/LosAngeles]" or "2021-11-07T00:45-07:00[America/LosAngeles]"). 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

CalendarDate
  | CalendarDateTime
  | ZonedDateTime

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

DateValue extends ZonedDateTime ? ZonedDateTime :
DateValue extends CalendarDateTime ? CalendarDateTime :
DateValue extends CalendarDate ? CalendarDate : never

string | string[]

Name	Type	Description
`state`	`DateFieldState`	State of the date field.
`isInvalid`	`boolean`	Whether the date field is invalid.
`isDisabled`	`boolean`	Whether the date field is disabled.

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.
`isInvalid`	`boolean`	Whether the date field is invalid, based on the `isInvalid`, `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.
`realtimeValidation`	`ValidationResult`	Realtime validation results, updated as the user edits the value.
`displayValidation`	`ValidationResult`	Currently displayed validation results, updated when the user commits their changes.

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.
`updateValidation( (result: ValidationResult )): void`	Updates the current validation result. Not displayed to the user until `commitValidation` is called.
`resetValidation(): void`	Resets the displayed validation state to valid when the user resets the form.
`commitValidation(): void`	Commits the realtime validation so it is displayed to the user.

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(): this`

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`	`Intl.DateTimeFormatOptions['hourCycle']`

'valid' | 'invalid'

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

Name	Type	Description
`isInvalid`	`boolean`	Whether the input value is invalid.
`validationErrors`	`string[]`	The current error messages for the input if it is invalid, otherwise an empty array.
`validationDetails`	`ValidityState`	The native validation details for the input.

BaseEvent<ReactKeyboardEvent<any>>

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

Name	Type	Description
`isHovered`	`boolean`	Whether the date input is currently hovered with a mouse.
`isFocusWithin`	`boolean`	Whether an element within the date input is focused, either via a mouse or keyboard.
`isFocusVisible`	`boolean`	Whether an element within the date input is keyboard focused.
`isDisabled`	`boolean`	Whether the date input is disabled.
`isInvalid`	`boolean`	Whether the date input is invalid.

Name	Type	Description
`isHovered`	`boolean`	Whether the segment is currently hovered with a mouse.
`isFocused`	`boolean`	Whether the segment is focused, either via a mouse or keyboard.
`isFocusVisible`	`boolean`	Whether the segment is keyboard focused.
`isPlaceholder`	`boolean`	Whether the value is a placeholder.
`isReadOnly`	`boolean`	Whether the segment is read only.
`isDisabled`	`boolean`	Whether the date field is disabled.
`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.

Name	Type	Description
`type`	`'hoverstart' \| 'hoverend'`	The type of hover event being fired.
`pointerType`	`'mouse' \| 'pen'`	The pointer type that triggered the hover event.
`target`	`HTMLElement`	The target element of the hover event.

Name	Type	Description
`isInvalid`	`boolean`	Whether the input value is invalid.
`validationErrors`	`string[]`	The current error messages for the input if it is invalid, otherwise an empty array.
`validationDetails`	`ValidityState`	The native validation details for the input.

Name	Type	Default	Description
`minValue`	`DateValue`	—	The minimum allowed date that a user may select.
`maxValue`	`DateValue`	—	The maximum allowed date that a user may select.
`isDateUnavailable`	`( (date: DateValue )) => boolean`	—	Callback that is called for each date of the calendar. If it returns true, then the date is unavailable.
`placeholderValue`	`DateValue`	—	A placeholder date that influences the format of the placeholder shown when no value is selected. Defaults to today's date at midnight.
`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`	`Granularity`	—	Determines the smallest unit that is displayed in the date picker. By default, this is `"day"` for dates, and `"minute"` for times.
`hideTimeZone`	`boolean`	`false`	Whether to hide the time zone abbreviation.
`shouldForceLeadingZeros`	`boolean`	—	Whether to always show leading zeros in the month, day, and hour fields. By default, this is determined by the user's locale.
`isDisabled`	`boolean`	—	Whether the input is disabled.
`isReadOnly`	`boolean`	—	Whether the input can be selected but not changed by the user.
`isRequired`	`boolean`	—	Whether user input is required on the input before form submission.
`isInvalid`	`boolean`	—	Whether the input value is invalid.
`validate`	`( (value: MappedDateValue<DateValue> )) => ValidationError \| true \| null \| undefined`	—	A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if `validationBehavior="native"`. For realtime validation, use the `isInvalid` prop instead.
`autoFocus`	`boolean`	—	Whether the element should receive focus on render.
`onFocus`	`( (e: FocusEvent<Target> )) => void`	—	Handler that is called when the element receives focus.
`onBlur`	`( (e: FocusEvent<Target> )) => 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.
`isOpen`	`boolean`	—	Whether the overlay is open by default (controlled).
`defaultOpen`	`boolean`	—	Whether the overlay is open by default (uncontrolled).
`onOpenChange`	`( (isOpen: boolean )) => void`	—	Handler that is called when the overlay's open state changes.
`value`	`DateValue \| null`	—	The current value (controlled).
`defaultValue`	`DateValue \| null`	—	The default value (uncontrolled).
`onChange`	`( (value: MappedDateValue<DateValue> )) => void`	—	Handler that is called when the value changes.
`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.
`id`	`string`	—	The element's unique identifier. See MDN.
`name`	`string`	—	The name of the input element, used when submitting an HTML form. See MDN.
`validationBehavior`	`'native' \| 'aria'`	`'native'`	Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.
`children`	`ReactNode \| ( (values: DateFieldRenderProps )) => ReactNode`	—	The children of the component. A function may be provided to alter the children based on component state.
`className`	`string \| ( (values: DateFieldRenderProps )) => string`	—	The CSS className for the element. A function may be provided to compute the class based on component state.
`style`	`CSSProperties \| ( (values: DateFieldRenderProps )) => CSSProperties`	—	The inline style for the element. A function may be provided to compute the style based on component state.
`slot`	`string \| null`	—	A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent.

Name	Type	Description
`elementType`	`string`

Name	Type	Description
`elementType`	`string`

useContextProps<T, U extends SlotProps, E extends Element>(
  props: T
    &  & SlotProps,
  ref: ForwardedRef<E>,
  context: Context<ContextValue<U, E>>
): [
  T,
  RefObject<E>
]

Name	Type	Description
`slot`	`string \| null`	A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent.

SlottedContextValue<WithRef<T, Element>>

SlottedValue<T>
  | T
  | null
  | undefined

Name	Type	Description
`slots`	`Record<string \| symbol, T>`
`slotCallbackSymbol`	`( (value: T )) => void`

T & {ref?: ForwardedRef<Element>
}