@super-calendar/native

中文文档
2.15.0发布于 2026/11/02MITTypeScriptESM + CJS构建来源已验证

Gesture-driven, virtualized month / week / day calendar and date picker for React Native (and web via react-native-web).

原始使用文档
文档目录6 节
  1. Install
  2. Usage
  3. Moving events
  4. Styling with Tailwind
  5. Documentation
  6. License

@super-calendar/native

npm JSR npmx

The React Native renderer for super-calendar: a gesture-driven, virtualized month / week / day calendar and date picker. Runs on iOS, Android, and web (web via react-native-web).

  • 📆 Month grid plus day / 3-day / week / custom-N time grids and an agenda
  • 🤏 Pinch-to-zoom week/day grid (UI thread, no re-renders)
  • ✋ Drag to select, create, and move: by time on the week/day grid, by whole days on the month and year grids
  • ♾️ Virtualized, snap-paging views via @legendapp/list
  • 🧩 Bring-your-own event type (CalendarEvent<T>) and a renderEvent escape hatch
  • 🪝 Headless useMonthGrid and useDateRange for fully custom UIs
  • 🎨 Themeable, with a darkTheme preset

Install

npm install @super-calendar/native

Also on JSR: deno add jsr:@super-calendar/native.

Peer dependencies: @legendapp/list (>=3), date-fns (>=3), react (>=19), react-native (>=0.74 <2), react-native-gesture-handler (>=2), react-native-reanimated (>=4), and react-native-worklets (>=0.8).

For a picker-only bundle that does not require Reanimated, import from the @super-calendar/native/picker subpath.

Usage

import { useState } from "react";
import { Calendar, type CalendarEvent } from "@super-calendar/native";

type MyEvent = { id: string; color: string };

const events: CalendarEvent<MyEvent>[] = [
  {
    id: "1",
    color: "#1F6FEB",
    title: "Lecture",
    start: new Date(2026, 5, 19, 10, 0),
    end: new Date(2026, 5, 19, 11, 30),
  },
];

export function MyCalendar() {
  const [mode, setMode] = useState<"month" | "week" | "day">("week");
  const [date, setDate] = useState(new Date());

  return (
    <Calendar
      mode={mode}
      date={date}
      events={events}
      weekStartsOn={1}
      onChangeDate={setDate}
      onPressEvent={(event) => console.log(event.id)}
      onPressDay={(day) => {
        setDate(day);
        setMode("day");
      }}
    />
  );
}

Moving events

Pass onDragEvent and update your event state with the returned start and end. On the time grid, dragging any segment of a multi-day event previews the whole range moving together and preserves its duration. Drag a resize grip to change only the start or end. See the dragging guide.

After edge paging, the floating event's horizontal centre selects the destination day, and its top edge selects the time.

Set an event's dragHandleColor to colour its resize grips in TimeGrid and ResourceTimeline (both orientations). It defaults to theme.colors.eventText. showDragHandle={false} still hides the time-grid grips. You can toggle it after mounting without replacing the events array.

Styling with Tailwind

Every styleable part is a named slot that accepts a class (resolved by a Tailwind runtime such as uniwind or NativeWind) and/or a style override. A classed slot drops its built-in themed styles, so your classes own the look:

<Calendar
  mode="month"
  date={date}
  events={events}
  classNames={{
    title: "text-center text-xl font-bold text-indigo-900",
    weekday: "uppercase tracking-wider text-indigo-400",
  }}
  styles={{ more: { color: "#6366F1" } }}
  onChangeDate={setDate}
  onPressEvent={(event) => console.log(event.id)}
/>

See the styling guide for the slot list and the uniwind setup.

chipHeight and chipGap configure month lanes and overflow rows on Calendar, MonthView, and MonthList. Native MonthPager forwards them too. DOM defaults remain 18 px height and 2 px gaps; native height keeps its theme default. Changing either dimension updates already mounted list and pager months. See the month guide.

Documentation

See the full documentation and the quickstart, including theming, recurring events, time zones, and the headless picker.

License

MIT

版本与发布记录

@super-calendar/native 共发布 28 个版本,首次发布于 2026/06/29;过去 12 个月发布了 28 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.15.0latest2026/11/02今天
2.14.22026/10/2410 天前
2.14.12026/10/2113 天前
2.14.02026/10/1420 天前
2.13.02026/10/1024 天前
2.12.12026/10/0826 天前

关于 @super-calendar/native 的常见问题

@super-calendar/native 是什么?

手势驱动,虚拟的月/周/日日历和日期选择器,用于React Native(以及通过React - Native -web)。

如何安装 @super-calendar/native?

在项目目录运行 npm install @super-calendar/native,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=18)、date-fns(>=3)、react-native(>=0.74 <2)、@legendapp/list(>=3)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@super-calendar/native 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@super-calendar/native 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@super-calendar/native 可以商用吗?

@super-calendar/native 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@super-calendar/native 还在维护吗?

最新版本 2.15.0 发布于 2026/11/02(今天);至今共发布 28 个版本,其中过去 12 个月发布了 28 个;首次发布于 2026/06/29。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。