跳转到正文

@capgo/capacitor-calendar

通过 Capacitor 创建、编辑和列出原生日历事件以及 iOS Reminders。

在 iOS 上申请合适的日历或提醒事项访问权限,然后直接创建事件,或通过系统编辑器界面创建。支持列出日历、按时间范围查询事件,并调起 Android 和 iOS 用户熟悉且信赖的原生选择器流程。

典型适用场景:预约类 App、健身日程、外勤服务规划,以及需要与设备日历同步的个人效率工具。

iOSAndroid
iOS 原生日历事件创建演示Android 原生日历事件创建演示
  • 使用新版 iOS 日历访问级别请求日历和提醒权限。
  • 在 iOS 和 Android 上实现日历事件的创建、修改、删除和列表查询。
  • 在平台支持的情况下,调用原生的事件创建、编辑、删除及日历选择 UI。
  • 列出日历、获取默认日历,以及创建或修改日历。
  • 管理 iOS Reminders 列表和提醒项。
功能iOSAndroidWeb 端
权限检查与请求是是否
日历事件 CRUD是是否
原生事件 prompt是是否
日历列表与默认日历是是否
日历来源与选择器是否否
日历 CRUD是是否
提醒事项列表与提醒 CRUD是否否

Web 端实现是针对仅限原生 API 的 Capacitor 存根。

领域方法
权限checkPermission, checkAllPermissions, requestWriteOnlyCalendarAccess, requestReadOnlyCalendarAccess, requestFullCalendarAccess, requestFullRemindersAccess
事件createEvent, createEventWithPrompt, modifyEvent, modifyEventWithPrompt, deleteEvent, deleteEventWithPrompt, listEventsInRange, commit
日历listCalendars, getDefaultCalendar, openCalendar, selectCalendarsWithPrompt, fetchAllCalendarSources, createCalendar, modifyCalendar, deleteCalendar
提醒事项openReminders, fetchAllRemindersSources, getDefaultRemindersList, getRemindersLists, createReminder, modifyReminder, deleteReminder, deleteReminderWithPrompt, getReminderById, getRemindersFromLists

此参考文档同步自 src/definitions.ts 中的 capacitor-calendar.