packages/dev/s2-docs/pages/react-aria/RangeCalendar.mdx
import {Layout} from '../../src/Layout'; export default Layout;
import docs from 'docs:react-aria-components'; import vanillaDocs from 'docs:vanilla-starter/RangeCalendar'; import {RangeCalendar as VanillaRangeCalendar} from 'vanilla-starter/RangeCalendar'; import {RangeCalendar as TailwindRangeCalendar} from 'tailwind-starter/RangeCalendar'; import '../../tailwind/tailwind.css'; import Anatomy from '/packages/react-aria/docs/calendar/rangecalendar-anatomy.svg';
export const tags = ['calendar']; export const relatedPages = [{'title': 'useRangeCalendar', 'url': 'RangeCalendar/useRangeCalendar.html'}]; export const description = 'Displays one or more date grids and allows users to select a contiguous range of dates.';
<PageDescription>{docs.exports.RangeCalendar.description}</PageDescription>
<ExampleSwitcher> <VisualExample component={VanillaRangeCalendar} docs={vanillaDocs.exports.RangeCalendar} links={vanillaDocs.links} props={['isDisabled']} type="vanilla" files={["starters/docs/src/RangeCalendar.tsx", "starters/docs/src/RangeCalendar.css"]} /> <VisualExample component={TailwindRangeCalendar} docs={vanillaDocs.exports.RangeCalendar} links={vanillaDocs.links} props={['isDisabled']} type="tailwind" files={["starters/tailwind/src/RangeCalendar.tsx"]} /> </ExampleSwitcher>Use the value or defaultValue prop to set the selected date range, using objects in the @internationalized/date package. This library supports parsing date strings in multiple formats, manipulation across international calendar systems, time zones, etc.
"use client";
import {parseDate, getLocalTimeZone} from '@internationalized/date';
import {useDateFormatter} from 'react-aria';
import {RangeCalendar} from 'vanilla-starter/RangeCalendar';
import {useState} from 'react';
function Example() {
let [range, setRange] = useState({
start: parseDate('2025-02-03'),
end: parseDate('2025-02-12')
});
let formatter = useDateFormatter({ dateStyle: 'long' });
return (
<>
<RangeCalendar
///- begin highlight -///
value={range}
onChange={setRange}
///- end highlight -///
/>
<p>Selected range: {formatter.formatRange(
range.start.toDate(getLocalTimeZone()),
range.end.toDate(getLocalTimeZone())
)}</p>
</>
);
}
By default, RangeCalendar 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.
"use client";
import {I18nProvider} from 'react-aria-components';
import {parseDate} from '@internationalized/date';
import {RangeCalendar} from 'vanilla-starter/RangeCalendar';
<I18nProvider/* PROPS */>
<RangeCalendar
defaultValue={{
start: parseDate('2025-02-03'),
end: parseDate('2025-02-12')
}} />
</I18nProvider>
RangeCalendar also supports custom calendar systems that implement custom business rules, for example a fiscal year calendar that follows a 4-5-4 format, where month ranges don't follow the usual Gregorian calendar. See the @internationalized/date docs for an example implementation.
"use client";
import type {AnyCalendarDate, Calendar} from '@internationalized/date';
import {CalendarDate, startOfWeek, GregorianCalendar} from '@internationalized/date';
import {RangeCalendar} from 'vanilla-starter/RangeCalendar';
export default function Example() {
return (
<RangeCalendar
firstDayOfWeek="sun"
///- begin highlight -///
createCalendar={() => new Custom454()} />
///- end highlight -///
);
}
// See @internationalized/date docs linked above.
///- begin collapse -///
class Custom454 extends GregorianCalendar {
// The anchor date, in Gregorian calendar.
// The anchor date is a date that occurs in the first week of the first month of every fiscal year.
anchorDate = new CalendarDate(2001, 2, 4);
private getYear(year: number): [CalendarDate, number[]] {
let anchor = this.anchorDate.set({year});
let startOfYear = startOfWeek(anchor, 'en', 'sun');
let isBigYear = !startOfYear.add({weeks: 53}).compare(anchor.add({years: 1}));
let weekPattern = [4, 5, 4, 4, 5, 4, 4, 5, 4, 4, 5, isBigYear ? 5 : 4];
return [startOfYear, weekPattern];
}
getDaysInMonth(date: AnyCalendarDate): number {
let [, weekPattern] = this.getYear(date.year);
return weekPattern[date.month - 1] * 7;
}
fromJulianDay(jd: number): CalendarDate {
let gregorian = super.fromJulianDay(jd);
let year = gregorian.year;
let [monthStart, weekPattern] = this.getYear(year);
if (gregorian.compare(monthStart) < 0) {
year--;
[monthStart, weekPattern] = this.getYear(year);
}
for (let month = 1; month <= 12; month++) {
let weeks = weekPattern[month - 1];
let nextMonth = monthStart.add({weeks});
if (nextMonth.compare(gregorian) > 0) {
let days = gregorian.compare(monthStart);
return new CalendarDate(this, year, month, days + 1);
}
monthStart = nextMonth;
}
throw new Error('date not found');
}
toJulianDay(date: AnyCalendarDate): number {
let [monthStart, weekPattern] = this.getYear(date.year);
for (let month = 1; month < date.month; month++) {
monthStart = monthStart.add({weeks: weekPattern[month - 1]});
}
let gregorian = monthStart.add({days: date.day - 1});
return super.toJulianDay(gregorian);
}
getFormattableMonth(date: AnyCalendarDate): CalendarDate {
let anchorMonth = this.anchorDate.month - 1;
let dateMonth = date.month - 1;
let month = ((anchorMonth + dateMonth) % 12) + 1;
let year = anchorMonth + dateMonth >= 12 ? date.year + 1 : date.year;
return new CalendarDate(year, month, 1);
}
isEqual(other: Calendar): boolean {
return other instanceof Custom454 && other.anchorDate.compare(this.anchorDate) === 0;
}
}
///- end collapse -///
Use the minValue and maxValue props to set the valid date range. The isDateUnavailable callback prevents certain dates from being selected. Use allowsNonContiguousRanges to allow selecting ranges containing unavailable dates. For custom validation rules, set the isInvalid prop and the errorMessage slot.
"use client";
import {today, getLocalTimeZone} from '@internationalized/date';
import {RangeCalendar} from 'vanilla-starter/RangeCalendar';
import {useState} from 'react';
function Example(props) {
let now = today(getLocalTimeZone());
let [range, setRange] = useState({
start: now.add({days: 6}),
end: now.add({ days: 14 })
});
let disabledRanges = [
[now, now.add({ days: 5 })],
[now.add({ days: 15 }), now.add({ days: 17 })],
[now.add({ days: 23 }), now.add({ days: 24 })]
];
let isInvalid = range.end.compare(range.start) > 7;
return (
<RangeCalendar
{...props}
aria-label="Trip dates"
value={range}
onChange={setRange}
///- begin highlight -///
/* PROPS */
minValue={today(getLocalTimeZone())}
isDateUnavailable={date => (
disabledRanges.some((interval) =>
date.compare(interval[0]) >= 0 && date.compare(interval[1]) <= 0
)
)}
isInvalid={isInvalid}
errorMessage={isInvalid ? 'Maximum stay duration is 1 week' : undefined} />
///- end highlight -///
);
}
Set the visibleDuration prop and render multiple CalendarGrid elements to display more than one month at a time. The pageBehavior prop controls whether pagination advances by a single month or multiple. The firstDayOfWeek prop overrides the locale-specified first day of the week.
"use client";
import {RangeCalendar, Heading} from 'react-aria-components';
import {CalendarGrid, CalendarCell} from 'vanilla-starter/RangeCalendar';
import {Button} from 'vanilla-starter/Button';
import {useDateFormatter} from 'react-aria';
import {ChevronLeft, ChevronRight} from 'lucide-react';
// TODO: move this into the starter example.
function Example(props) {
let monthFormatter = useDateFormatter({
month: 'long',
year: 'numeric',
});
return (
<RangeCalendar
{...props}
aria-label="Trip dates"
///- begin highlight -///
/* PROPS */
///- end highlight -///
style={{display: 'flex', gap: 12, overflow: 'auto'}}
>
{({state}) => (
[...Array(props.visibleDuration.months).keys()].map(i => (
<div key={i} style={{flex: 1}}>
<header style={{minHeight: 32}}>
{i === 0 &&
<Button slot="previous" variant="quiet">
<ChevronLeft />
</Button>
}
<Heading>{monthFormatter.format(state.visibleRange.start.add({months: i}).toDate(state.timeZone))}</Heading>
{i === props.visibleDuration.months - 1 &&
<Button slot="next" variant="quiet">
<ChevronRight />
</Button>
}
</header>
<CalendarGrid offset={{months: i}}>
{date => <CalendarCell date={date} />}
</CalendarGrid>
</div>
))
)}
</RangeCalendar>
);
}
Use the focusedValue or defaultFocusedValue prop to control which date is focused. This controls which month is visible. The onFocusChange event is called when a date is focused by the user.
"use client";
import {RangeCalendar} from 'vanilla-starter/RangeCalendar';
import {Button} from 'vanilla-starter/Button';
import {CalendarDate, today, getLocalTimeZone} from '@internationalized/date';
import {useState} from 'react';
function Example() {
let defaultDate = new CalendarDate(2021, 7, 1);
let [focusedDate, setFocusedDate] = useState(defaultDate);
return (
<div>
<Button
style={{marginBottom: 20}}
onPress={() => setFocusedDate(today(getLocalTimeZone()))}>
Today
</Button>
<RangeCalendar
///- begin highlight -///
focusedValue={focusedDate}
onFocusChange={setFocusedDate}
///- end highlight -///
/>
</div>
);
}
You can also control the focused date via CalendarStateContext. This example shows month and year dropdown components that work inside any <RangeCalendar>.
"use client";
import {RangeCalendar} from 'react-aria-components';
import {CalendarGrid, CalendarCell} from 'vanilla-starter/RangeCalendar';
import {MonthDropdown} from './MonthDropdown';
import {YearDropdown} from './YearDropdown';
import {Button} from 'vanilla-starter/Button';
import {ChevronLeft, ChevronRight} from 'lucide-react';
<RangeCalendar>
<header style={{display: 'flex', gap: 4}}>
<Button slot="previous" variant="quiet">
<ChevronLeft />
</Button>
<MonthDropdown />
<YearDropdown />
<Button slot="next" variant="quiet">
<ChevronRight />
</Button>
</header>
<CalendarGrid>
{(date) => <CalendarCell date={date} />}
</CalendarGrid>
</RangeCalendar>
<Anatomy role="img" aria-label="Anatomy diagram of a range calendar component, which consists of a heading, grid of cells, previous, and next buttons." />
<RangeCalendar>
<Button slot="previous" />
<Heading />
<Button slot="next" />
<CalendarGrid>
<CalendarGridHeader>
{day => <CalendarHeaderCell />}
</CalendarGridHeader>
<CalendarGridBody>
{date => <CalendarCell date={date} />}
</CalendarGridBody>
</CalendarGrid>
<Text slot="errorMessage" />
</RangeCalendar>