@capgo/capacitor-calendar
Native calendar event management for Capacitor apps, including event prompts, direct event CRUD, calendar listing, and iOS Reminders.
Overview
Section titled “Overview”@capgo/capacitor-calendar gives Capacitor apps direct access to native calendar features. Use it to request calendar permissions, create and modify events, open the system calendar UI, list calendars and events, and manage Reminders on iOS.
| iOS | Android |
|---|---|
![]() | ![]() |
Core Capabilities
Section titled “Core Capabilities”- Request calendar and reminder permissions with modern iOS calendar access levels.
- Create, modify, delete, and list calendar events on iOS and Android.
- Open native event creation, edit, delete, and calendar selection UI where the platform supports it.
- List calendars, get the default calendar, and create or modify calendars.
- Manage iOS Reminders lists and reminder items.
Platform Support
Section titled “Platform Support”| Feature | iOS | Android | Web |
|---|---|---|---|
| Permission checks and requests | Yes | Yes | No |
| Calendar event CRUD | Yes | Yes | No |
| Native event prompts | Yes | Yes | No |
| Calendar listing and default calendar | Yes | Yes | No |
| Calendar sources and picker | Yes | No | No |
| Calendar CRUD | Yes | Yes | No |
| Reminder lists and reminder CRUD | Yes | No | No |
The web implementation is a Capacitor stub for native-only APIs.
Public API
Section titled “Public API”| Area | Methods |
|---|---|
| Permissions | checkPermission, checkAllPermissions, requestWriteOnlyCalendarAccess, requestReadOnlyCalendarAccess, requestFullCalendarAccess, requestFullRemindersAccess |
| Events | createEvent, createEventWithPrompt, modifyEvent, modifyEventWithPrompt, deleteEvent, deleteEventWithPrompt, listEventsInRange, commit |
| Calendars | listCalendars, getDefaultCalendar, openCalendar, selectCalendarsWithPrompt, fetchAllCalendarSources, createCalendar, modifyCalendar, deleteCalendar |
| Reminders | openReminders, fetchAllRemindersSources, getDefaultRemindersList, getRemindersLists, createReminder, modifyReminder, deleteReminder, deleteReminderWithPrompt, getReminderById, getRemindersFromLists |
Source Of Truth
Section titled “Source Of Truth”This reference is synced from src/definitions.ts in capacitor-calendar.

