react-calendar、react-datepicker、react-datetime 和 react-day-picker 都是 React 生态中流行的日期处理库,但它们的定位和实现方式截然不同。react-calendar 专注于提供可嵌入的日历视图组件,适合需要自定义日期选择逻辑的场景。react-datepicker 是经典的输入框弹窗选择器,支持时间选择,上手简单。react-datetime 提供日期和时间组合选择,但维护活跃度较低。react-day-picker 强调无障碍访问(Accessibility)和高度定制,适合对用户体验要求严格的项目。
这四个库都解决了同一个问题:如何在 React 中让用户选择日期。但它们的实现思路不同,导致在定制能力、交互体验和維護成本上有很大差异。我们从架构师的角度,深入对比它们在真实工程中的表现。
交互模式决定了组件如何融入你的页面布局。有的库默认是独立的日历视图,有的则是绑定在输入框上的弹窗。
react-calendar 默认是独立的日历视图,不绑定输入框。
// react-calendar: 独立视图
import Calendar from 'react-calendar';
function MyCalendar() {
const [value, onChange] = useState(new Date());
return <Calendar onChange={onChange} value={value} />;
}
react-datepicker 默认是输入框绑定弹窗模式。
// react-datepicker: 输入框弹窗
import DatePicker from 'react-datepicker';
function MyDatePicker() {
const [date, setDate] = useState(new Date());
return <DatePicker selected={date} onChange={(d) => setDate(d)} />;
}
react-datetime 也是输入框绑定弹窗模式。
react-datepicker,但渲染结构不同。// react-datetime: 输入框弹窗
import DateTime from 'react-datetime';
function MyDateTime() {
const [date, setDate] = useState(new Date());
return <DateTime value={date} onChange={setDate} />;
}
react-day-picker 默认是独立视图,但可配合输入框使用。
// react-day-picker: 独立视图(需自行组合弹窗)
import { DayPicker } from 'react-day-picker';
function MyDayPicker() {
const [selected, setSelected] = useState(new Date());
return <DayPicker mode="single" selected={selected} onSelect={setSelected} />;
}
在真实项目中,UI 设计稿往往与默认样式不符。定制能力决定了你需要写多少覆盖代码。
react-calendar 依赖特定的 CSS 类名。
/* react-calendar: 覆盖类名 */
.react-calendar__tile--active {
background: #006ed3;
}
// react-calendar: 使用 className prop
<Calendar className="my-custom-calendar" />;
react-datepicker 同样依赖 CSS 类名覆盖。
/* react-datepicker: 覆盖类名 */
.react-datepicker__day--selected {
background-color: #216ba5;
}
// react-datepicker: 自定义类名
<DatePicker className="my-input" calendarClassName="my-calendar" />;
react-datetime 使用内联样式和类名混合。
/* react-datetime: 覆盖类名 */
.rdtActive {
background-color: #0094ff;
}
// react-datetime: 自定义输入框
<DateTime inputProps={{ className: 'my-input' }} />;
react-day-picker 提供 CSS 变量和类名,v8 支持更灵活的样式钩子。
components 属性替换内部 DOM 结构。/* react-day-picker: 使用 CSS 变量 */
.rdp-day_selected {
background-color: var(--rdp-selected-bg);
}
// react-day-picker: 替换内部组件
<DayPicker components={{ Day: CustomDayComponent }} />;
业务场景往往不止选择单个日期,还需要范围选择(开始 - 结束)或具体时间。
react-calendar 原生支持范围选择。
selectRange 属性开启。[start, end]。// react-calendar: 范围选择
<Calendar
selectRange={true}
onChange={(range) => console.log(range)}
/>;
react-datepicker 支持范围选择和时间选择。
selectsRange 和 showTimeSelect 开启。// react-datepicker: 范围与时间
<DatePicker
selectsRange
showTimeSelect
startDate={startDate}
endDate={endDate}
onChange={(update) => setDates(update)}
/>;
react-datetime 支持时间选择,范围选择需自定义。
// react-datetime: 时间选择
<DateTime
dateFormat="YYYY-MM-DD"
timeFormat="HH:mm"
value={date}
onChange={setDate}
/>;
react-day-picker 原生支持范围选择,时间需配合其他库。
react-timepicker 或原生 input。// react-day-picker: 范围选择
<DayPicker
mode="range"
selected={range}
onSelect={setRange}
/>;
对于企业级应用,无障碍访问(A11y)和 TypeScript 支持是硬性指标。
react-calendar 无障碍支持一般。
// react-calendar: 类型定义
import { CalendarProps } from 'react-calendar';
// 类型可能不够精确
react-datepicker 无障碍支持较好。
// react-datepicker: 类型定义
import { DatePickerProps } from 'react-datepicker';
// 类型覆盖较全
react-datetime 无障碍支持较弱。
// react-datetime: 类型定义
import DateTime from 'react-datetime';
// 可能需要 @types/react-datetime
react-day-picker 无障碍支持最佳。
// react-day-picker: 类型定义
import { DayPickerProps } from 'react-day-picker';
// 类型非常精确
尽管实现不同,它们都解决了一些核心问题。
date-fns 或 moment)或内置简单格式化。react-datepicker 和 react-datetime 内置较多格式化选项。// 通用:处理日期对象
const date = new Date();
// 所有库都接受 Date 对象作为 value
react-day-picker 和 react-calendar 依赖 date-fns 本地化。// 通用:设置语言
// react-day-picker
<DayPicker locale="zh-CN" />
// react-datepicker
<DatePicker locale="zh-CN" />
// 通用:禁用逻辑
// react-calendar
<Calendar minDate={new Date()} />
// react-datepicker
<DatePicker minDate={new Date()} />
// react-day-picker
<DayPicker disabled={{ before: new Date() }} />
| 特性 | react-calendar | react-datepicker | react-datetime | react-day-picker |
|---|---|---|---|---|
| 默认交互 | 嵌入视图 | 输入框弹窗 | 输入框弹窗 | 嵌入视图 |
| 范围选择 | ✅ 原生支持 | ✅ 原生支持 | ❌ 需自定义 | ✅ 原生支持 |
| 时间选择 | ❌ 不支持 | ✅ 原生支持 | ✅ 原生支持 | ❌ 需配合其他库 |
| 样式定制 | CSS 覆盖 | CSS 覆盖 | CSS 覆盖 | CSS 变量 + 组件替换 |
| 无障碍 | ⭐️⭐️ | ⭐️⭐️⭐️ | ⭐️ | ⭐️⭐️⭐️⭐️⭐️ |
| TS 支持 | 社区定义 | 内置 | 社区定义 | 原生内置 |
| 维护状态 | 活跃 | 活跃 | 较少更新 | 非常活跃 |
react-calendar 适合需要灵活嵌入日历视图的场景 — 比如 dashboard 上的小日历。如果你需要范围选择但不需要时间,它是轻量级的好选择。
react-datepicker 是传统表单的最佳拍档 — 尤其是需要时间选择的后台系统。它的文档最多,遇到问题容易找到解决方案。
react-datetime 建议仅在维护旧项目时使用 — 新项目面临维护风险和无障碍挑战。如果必须用,请做好自行修复 Bug 的准备。
react-day-picker 是现代 React 应用的首选 — 尤其是对无障碍和类型安全有要求的项目。虽然配置弹窗需要多一点代码,但长期维护成本最低。
核心原则:不要为了省几行代码而牺牲用户体验。如果项目周期长,react-day-picker 的架构优势会更明显;如果追求快速交付且需要时间选择,react-datepicker 更稳妥。
选择 react-calendar 如果你需要嵌入式的日历视图,而不是传统的输入框弹窗。它非常适合构建自定义的日期范围选择器,或者需要将日历作为页面布局一部分的场景。它的 API 简单,但样式定制需要覆盖较多 CSS 类名。
选择 react-datepicker 如果你需要传统的输入框点击弹出日历的交互,且必须支持时间选择。它是迁移自 jQuery datepicker 用户的常见选择,生态成熟,文档丰富,适合快速落地的后台管理系统。
选择 react-datetime 仅适用于维护旧项目。对于新项目,由于其维护活跃度不如其他库且无障碍支持较弱,建议评估 react-datepicker 或 react-day-picker 作为替代。它在处理 React 新版本特性时可能需要额外配置。
选择 react-day-picker 如果你对无障碍访问(A11y)有严格要求,或者需要高度定制日历的渲染逻辑。它支持 TypeScript 类型定义最好,且 v8 版本后更加灵活,适合设计系统或复杂的企业级应用。
Ultimate calendar for your React app.
npm install react-calendar or yarn add react-calendar.import Calendar from 'react-calendar'.<Calendar />. Use onChange prop for getting new values.A minimal demo page can be found in sample directory.
Online demo is also available!
react-calendar is under constant development. This documentation is written for react-calendar 4.x branch. If you want to see documentation for other versions of react-calendar, use dropdown on top of GitHub page to switch to an appropriate tag. Here are quick links to the newest docs from each branch:
Your project needs to use React 16.8 or later.
react-calendar uses modern web technologies. That's why it's so fast, lightweight and easy to style. This, however, comes at a cost of supporting only modern browsers.
If your locale isn't supported, you can use Intl.js or another Intl polyfill along with react-calendar.
Add react-calendar to your project by executing npm install react-calendar or yarn add react-calendar.
Here's an example of basic usage:
import { useState } from 'react';
import Calendar from 'react-calendar';
type ValuePiece = Date | null;
type Value = ValuePiece | [ValuePiece, ValuePiece];
function MyApp() {
const [value, onChange] = useState<Value>(new Date());
return (
<div>
<Calendar onChange={onChange} value={value} />
</div>
);
}
Check the sample directory in this repository for a full working example. For more examples and more advanced use cases, check Recipes in react-calendar Wiki.
If you want to use default react-calendar styling to build upon it, you can import react-calendar's styles by using:
import 'react-calendar/dist/Calendar.css';
Displays a complete, interactive calendar.
| Prop name | Description | Default value | Example values |
|---|---|---|---|
| activeStartDate | The beginning of a period that shall be displayed. If you wish to use react-calendar in an uncontrolled way, use defaultActiveStartDate instead. | (today) | new Date(2017, 0, 1) |
| allowPartialRange | Whether to call onChange with only partial result given selectRange prop. | false | true |
| calendarType | Type of calendar that should be used. Can be 'gregory, 'hebrew', 'islamic', 'iso8601'. Setting to "gregory" or "hebrew" will change the first day of the week to Sunday. Setting to "islamic" will change the first day of the week to Saturday. Setting to "islamic" or "hebrew" will make weekends appear on Friday to Saturday. | Type of calendar most commonly used in a given locale | 'iso8601' |
| className | Class name(s) that will be added along with "react-calendar" to the main react-calendar <div> element. | n/a |
|
| data-testid | The test ID used for testing purposes. | n/a | 'calendar' |
| defaultActiveStartDate | The beginning of a period that shall be displayed by default. If you wish to use react-calendar in a controlled way, use activeStartDate instead. | (today) | new Date(2017, 0, 1) |
| defaultValue | Calendar value that shall be selected initially. Can be either one value or an array of two values. If you wish to use react-calendar in a controlled way, use value instead. | n/a |
|
| defaultView | Determines which calendar view shall be opened initially. Does not disable navigation. Can be "month", "year", "decade" or "century". If you wish to use react-calendar in a controlled way, use view instead. | The most detailed view allowed | "year" |
| formatDay | Function called to override default formatting of day tile labels. Can be used to use your own formatting function. | (default formatter) | (locale, date) => formatDate(date, 'd') |
| formatLongDate | Function called to override default formatting of day tile abbr labels. Can be used to use your own formatting function. | (default formatter) | (locale, date) => formatDate(date, 'dd MMM YYYY') |
| formatMonth | Function called to override default formatting of month names. Can be used to use your own formatting function. | (default formatter) | (locale, date) => formatDate(date, 'MMM') |
| formatMonthYear | Function called to override default formatting of months and years. Can be used to use your own formatting function. | (default formatter) | (locale, date) => formatDate(date, 'MMMM YYYY') |
| formatShortWeekday | Function called to override default formatting of weekday names (shortened). Can be used to use your own formatting function. | (default formatter) | (locale, date) => formatDate(date, 'dd') |
| formatWeekday | Function called to override default formatting of weekday names. Can be used to use your own formatting function. | (default formatter) | (locale, date) => formatDate(date, 'dd') |
| formatYear | Function called to override default formatting of year in the top navigation section. Can be used to use your own formatting function. | (default formatter) | (locale, date) => formatDate(date, 'YYYY') |
| goToRangeStartOnSelect | Whether to go to the beginning of the range when selecting the end of the range. | true | false |
| inputRef | A prop that behaves like ref, but it's passed to main <div> rendered by <Calendar> component. | n/a |
|
| locale | Locale that should be used by the calendar. Can be any IETF language tag. Note: When using SSR, setting this prop may help resolving hydration errors caused by locale mismatch between server and client. | Server locale/User's browser settings | "hu-HU" |
| maxDate | Maximum date that the user can select. Periods partially overlapped by maxDate will also be selectable, although react-calendar will ensure that no later date is selected. | n/a | Date: new Date() |
| maxDetail | The most detailed view that the user shall see. View defined here also becomes the one on which clicking an item will select a date and pass it to onChange. Can be "month", "year", "decade" or "century". | "month" | "year" |
| minDate | Minimum date that the user can select. Periods partially overlapped by minDate will also be selectable, although react-calendar will ensure that no earlier date is selected. | n/a | Date: new Date() |
| minDetail | The least detailed view that the user shall see. Can be "month", "year", "decade" or "century". | "century" | "decade" |
| navigationAriaLabel | aria-label attribute of a label rendered on calendar navigation bar. | n/a | "Go up" |
| navigationAriaLive | aria-live attribute of a label rendered on calendar navigation bar. | undefined | "polite" |
| navigationLabel | Content of a label rendered on calendar navigation bar. | (default label) | ({ date, label, locale, view }) => alert(`Current view: ${view}, date: ${date.toLocaleDateString(locale)}`) |
| next2AriaLabel | aria-label attribute of the "next on higher level" button on the navigation pane. | n/a | "Jump forwards" |
| next2Label | Content of the "next on higher level" button on the navigation pane. Setting the value explicitly to null will hide the icon. | "»" |
|
| nextAriaLabel | aria-label attribute of the "next" button on the navigation pane. | n/a | "Next" |
| nextLabel | Content of the "next" button on the navigation pane. Setting the value explicitly to null will hide the icon. | "›" |
|
| onActiveStartDateChange | Function called when the user navigates from one view to another using previous/next button. Note that this function will not be called when e.g. drilling up from January 2021 to 2021 or drilling down the other way around.action signifies the reason for active start date change and can be one of the following values: "prev", "prev2", "next", "next2", "drillUp", "drillDown", "onChange". | n/a | ({ action, activeStartDate, value, view }) => alert('Changed view to: ', activeStartDate, view) |
| onChange | Function called when the user clicks an item (day on month view, month on year view and so on) on the most detailed view available. | n/a | (value, event) => alert('New date is: ', value) |
| onClickDay | Function called when the user clicks a day. | n/a | (value, event) => alert('Clicked day: ', value) |
| onClickDecade | Function called when the user clicks a decade. | n/a | (value, event) => alert('Clicked decade: ', value) |
| onClickMonth | Function called when the user clicks a month. | n/a | (value, event) => alert('Clicked month: ', value) |
| onClickWeekNumber | Function called when the user clicks a week number. | n/a | (weekNumber, date, event) => alert('Clicked week: ', weekNumber, 'that starts on: ', date) |
| onClickYear | Function called when the user clicks a year. | n/a | (value, event) => alert('Clicked year: ', value) |
| onDrillDown | Function called when the user drills down by clicking a tile. | n/a | ({ activeStartDate, view }) => alert('Drilled down to: ', activeStartDate, view) |
| onDrillUp | Function called when the user drills up by clicking drill up button. | n/a | ({ activeStartDate, view }) => alert('Drilled up to: ', activeStartDate, view) |
| onViewChange | Function called when the user navigates from one view to another using drill up button or by clicking a tile.action signifies the reason for view change and can be one of the following values: "prev", "prev2", "next", "next2", "drillUp", "drillDown", "onChange". | n/a | ({ action, activeStartDate, value, view }) => alert('New view is: ', view) |
| prev2AriaLabel | aria-label attribute of the "previous on higher level" button on the navigation pane. | n/a | "Jump backwards" |
| prev2Label | Content of the "previous on higher level" button on the navigation pane. Setting the value explicitly to null will hide the icon. | "«" |
|
| prevAriaLabel | aria-label attribute of the "previous" button on the navigation pane. | n/a | "Previous" |
| prevLabel | Content of the "previous" button on the navigation pane. Setting the value explicitly to null will hide the icon. | "‹" |
|
| returnValue | Which dates shall be passed by the calendar to the onChange function and onClick{Period} functions. Can be "start", "end" or "range". The latter will cause an array with start and end values to be passed. | "start" | "range" |
| selectRange | Whether the user shall select two dates forming a range instead of just one. Note: This feature will make react-calendar return array with two dates regardless of returnValue setting. | false | true |
| showDoubleView | Whether to show two months/years/… at a time instead of one. Defaults showFixedNumberOfWeeks prop to be true. | false | true |
| showFixedNumberOfWeeks | Whether to always show fixed number of weeks (6). Forces showNeighboringMonth prop to be true. | false | true |
| showNavigation | Whether a navigation bar with arrows and title shall be rendered. | true | false |
| showNeighboringCentury | Whether decades from next century shall be rendered to fill the entire last row in. | false | true |
| showNeighboringDecade | Whether years from next decade shall be rendered to fill the entire last row in. | false | true |
| showNeighboringMonth | Whether days from previous or next month shall be rendered if the month doesn't start on the first day of the week or doesn't end on the last day of the week, respectively. | true | false |
| showWeekNumbers | Whether week numbers shall be shown at the left of MonthView or not. | false | true |
| tileClassName | Class name(s) that will be applied to a given calendar item (day on month view, month on year view and so on). | n/a |
|
| tileContent | Allows to render custom content within a given calendar item (day on month view, month on year view and so on). | n/a |
|
| tileDisabled | Pass a function to determine if a certain day should be displayed as disabled. | n/a | ({ activeStartDate, date, view }) => date.getDay() === 0 |
| value | Calendar value. Can be either one value or an array of two values. If you wish to use react-calendar in an uncontrolled way, use defaultValue instead. | n/a |
|
| view | Determines which calendar view shall be opened. Does not disable navigation. Can be "month", "year", "decade" or "century". If you wish to use react-calendar in an uncontrolled way, use defaultView instead. | The most detailed view allowed | "year" |
Displays a given month, year, decade and a century, respectively.
| Prop name | Description | Default value | Example values |
|---|---|---|---|
| activeStartDate | The beginning of a period that shall be displayed. | n/a | new Date(2017, 0, 1) |
| hover | The date over which the user is hovering. Used only when selectRange is enabled, to render a “WIP” range when the user is selecting range. | n/a | new Date(2017, 0, 1) |
| maxDate | Maximum date that the user can select. Periods partially overlapped by maxDate will also be selectable, although react-calendar will ensure that no later date is selected. | n/a | Date: new Date() |
| minDate | Minimum date that the user can select. Periods partially overlapped by minDate will also be selectable, although react-calendar will ensure that no earlier date is selected. | n/a | Date: new Date() |
| onClick | Function called when the user clicks an item (day on month view, month on year view and so on). | n/a | (value) => alert('New date is: ', value) |
| tileClassName | Class name(s) that will be applied to a given calendar item (day on month view, month on year view and so on). | n/a |
|
| tileContent | Allows to render custom content within a given item (day on month view, month on year view and so on). Note: For tiles with custom content you might want to set fixed height of react-calendar__tile to ensure consistent layout. | n/a | ({ date, view }) => view === 'month' && date.getDay() === 0 ? <p>It's Sunday!</p> : null |
| value | Calendar value. Can be either one value or an array of two values. | n/a |
|
The MIT License.
|
| Wojciech Maj |
Thank you to all our sponsors! Become a sponsor and get your image on our README on GitHub.
Thank you to all our backers! Become a backer and get your image on our README on GitHub.
Thank you to all our contributors that helped on this project!