A date picker combines a DateField and a Calendar popover to allow users to enter or select a date and time value.
Vanilla CSS theme
--tint CSS variable used by the Vanilla CSS examples.granularity
"day" for dates, and "minute" for times.Value
Use the value or defaultValue prop to set the date value, using objects in the @internationalized/date package. This library supports parsing date strings in multiple formats, manipulation across international calendar systems, time zones, etc.
Selected date: Monday, February 3, 2020
import {parseDate, getLocalTimeZone, type CalendarDate} from '@internationalized/date';
import {useDateFormatter} from 'react-aria';
import {DatePicker} from './DatePicker';
import {useState} from 'react';
function Example() {
let [date, setDate] = useState<CalendarDate | null>(parseDate('2020-02-03'));
let formatter = useDateFormatter({ dateStyle: 'full' });
return (
<>
<DatePicker
value={date}
onChange={setDate} />
<p>Selected date: {date ? formatter.format(date.toDate(getLocalTimeZone())) : '--'}</p>
</>
);
}
Format options
The date format is automatically determined based on the user's locale. DatePicker supports several props to control how values are displayed.
granularity
"day" for dates, and "minute" for times.International calendars
By default, DatePicker displays the value using the calendar system for the user's locale. Use <I18nProvider> to override the calendar system by setting the Unicode calendar locale extension. The onChange event always receives a date in the same calendar as the value or defaultValue (Gregorian if no value is provided), regardless of the displayed locale.
Forms
Use the name prop to submit the selected date to the server as an ISO 8601 string. Set the isRequired, minValue, or maxValue props to validate the value, or implement custom client or server-side validation. The isDateUnavailable callback prevents certain dates from being selected. See the Forms guide to learn more.
import {isWeekend, today, getLocalTimeZone} from '@internationalized/date';
import {useLocale} from 'react-aria-components';
import {DatePicker} from './DatePicker';
import {Button} from './Button';
import {Form} from './Form';;
function Example() {
let {locale} = useLocale();
let now = today(getLocalTimeZone());
let disabledRanges = [
[now, now.add({ days: 5 })],
[now.add({ days: 14 }), now.add({ days: 16 })],
[now.add({ days: 23 }), now.add({ days: 24 })]
];
return (
<Form>
<DatePicker
label="Appointment date"
name="date"
isRequired
minValue={today(getLocalTimeZone())}
isDateUnavailable={date => (
isWeekend(date, locale) ||
disabledRanges.some((interval) =>
date.compare(interval[0]) >= 0 && date.compare(interval[1]) <= 0
)
)}
/>
<Button type="submit">Submit</Button>
</Form>
);
}
API
<DatePicker>
<Label />
<Group>
<DateInput />
<Button />
</Group>
<Text slot="description" />
<FieldError />
<Popover>
<Calendar />
</Popover>
</DatePicker>
DatePicker
| Name | Type | Default |
|---|---|---|
pageBehavior | PageBehavior | Default: visible
|
| Controls the behavior of paging. Pagination either works by advancing the visible page by visibleDuration (default) or one unit of visibleDuration. | ||
firstDayOfWeek | 'sun'
| 'mon'
| 'tue'
| 'wed'
| 'thu'
| 'fri'
| 'sat' | Default: — |
| The day that starts the week. | ||
isDateUnavailable | | Default: — |
| Callback that is called for each date of the calendar. If it returns true, then the date is unavailable. | ||
placeholderValue | DateValue | null | Default: — |
| 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 | Default: — |
| Whether to display the time in 12 or 24 hour format. By default, this is determined by the user's locale. | ||
granularity | Granularity | Default: — |
Determines the smallest unit that is displayed in the date picker. By default, this is "day" for dates, and "minute" for times. | ||
hideTimeZone | boolean | Default: false
|
| Whether to hide the time zone abbreviation. | ||
shouldForceLeadingZeros | boolean | Default: — |
| 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 | Default: — |
| Whether the input is disabled. | ||
isReadOnly | boolean | Default: — |
| Whether the input can be selected but not changed by the user. | ||
children | ChildrenOrFunction | Default: — |
| The children of the component. A function may be provided to alter the children based on component state. | ||
value | DateValue | null | Default: — |
| The current value (controlled). | ||
defaultValue | DateValue | null | Default: — |
| The default value (uncontrolled). | ||
onChange | | Default: — |
| Handler that is called when the value changes. | ||
Default className: react-aria-DatePicker
| Render Prop | CSS Selector |
|---|---|
isFocusWithin | CSS Selector: [data-focus-within]
|
| Whether an element within the date picker is focused, either via a mouse or keyboard. | |
isFocusVisible | CSS Selector: [data-focus-visible]
|
| Whether an element within the date picker is keyboard focused. | |
isDisabled | CSS Selector: [data-disabled]
|
| Whether the date picker is disabled. | |
isReadOnly | CSS Selector: [data-readonly]
|
| Whether the date picker is read only. | |
isInvalid | CSS Selector: [data-invalid]
|
| Whether the date picker is invalid. | |
isOpen | CSS Selector: [data-open]
|
| Whether the date picker's popover is currently open. | |
state | CSS Selector: — |
| State of the date picker. | |