Skip to content

@capgo/capacitor-calendar

Native calendar event management for Capacitor apps, including event prompts, direct event CRUD, calendar listing, and iOS Reminders.

@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.

iOSAndroid
iOS demo of native calendar event creationAndroid demo of native calendar event creation
  • 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.
FeatureiOSAndroidWeb
Permission checks and requestsYesYesNo
Calendar event CRUDYesYesNo
Native event promptsYesYesNo
Calendar listing and default calendarYesYesNo
Calendar sources and pickerYesNoNo
Calendar CRUDYesYesNo
Reminder lists and reminder CRUDYesNoNo

The web implementation is a Capacitor stub for native-only APIs.

AreaMethods
PermissionscheckPermission, checkAllPermissions, requestWriteOnlyCalendarAccess, requestReadOnlyCalendarAccess, requestFullCalendarAccess, requestFullRemindersAccess
EventscreateEvent, createEventWithPrompt, modifyEvent, modifyEventWithPrompt, deleteEvent, deleteEventWithPrompt, listEventsInRange, commit
CalendarslistCalendars, getDefaultCalendar, openCalendar, selectCalendarsWithPrompt, fetchAllCalendarSources, createCalendar, modifyCalendar, deleteCalendar
RemindersopenReminders, fetchAllRemindersSources, getDefaultRemindersList, getRemindersLists, createReminder, modifyReminder, deleteReminder, deleteReminderWithPrompt, getReminderById, getRemindersFromLists

This reference is synced from src/definitions.ts in capacitor-calendar.