bedginton/capacitor-calendar

The Capacitor Calendar Plugin enables full calendar functionality on iOS and Android, with added reminder support for iOS devices.

The Capacitor Calendar Plugin enables full calendar functionality on iOS and Android, with added reminder support for iOS devices.

https://capacitor-calendar.pages.dev

Documentation · Capacitor Compatibility · Deployment Targets

Table of Contents

• Install
• Demo
• Permissions
• API
• Documentation
• Contributions

Install

Capacitor 6

npm install @ebarooni/capacitor-calendar@latest
npx cap sync

Capacitor 5

npm install @ebarooni/capacitor-calendar@^5
npx cap sync

Demo (click for details)

iOS 17	Android 14

On iOS, readCalendar permission is not needed when you a

re creating an event using the native prompt. The video is just for showing the functionality, otherwise the createEventWithPrompt method works without the readCalendar authorization.

Permissions

To be able to use the plugin, you will need to add the required permissions to your app. The required platform-specific permissions can be found below:

• iOS
• Android

📋 API

• checkPermission(...)
• checkAllPermissions()
• requestPermission(...)
• requestAllPermissions()
• createEventWithPrompt(...)
• selectCalendarsWithPrompt(...)
• listCalendars()
• getDefaultCalendar()
• createEvent(...)
• getDefaultRemindersList()
• getRemindersLists()
• createReminder(...)
• openCalendar(...)
• openReminders()
• listEventsInRange(...)
• deleteEventsById(...)
• createCalendar(...)
• deleteCalendar(...)
• getRemindersFromLists(...)
• deleteRemindersById(...)
• requestWriteOnlyCalendarAccess()
• requestReadOnlyCalendarAccess()
• requestFullCalendarAccess()
• requestFullRemindersAccess()
• Interfaces
• Type Aliases
• Enums

📚 Documentation

For detailed explanations, usage examples, and additional information:

• documentation.md: Autogenerated docs are available in the documentation file.
• definitions.ts: Complete documentation with usage examples is available in the src/definitions.ts file.

💙 Contributions

Warning

Thank you for your interest in contributing to the project! At the moment, the focus is on reaching the first major release. Until then, the contributions will not be accepted. This approach allows to set a solid foundation and maintain consistency throughout the development process.

Community input is highly valued, and you are encouraged to engage with the project by providing feedback and suggestions. Feel free to open issues for bugs you've discovered or enhancements you'd like to see.

Stay tuned for updates. Looking forward to collaborating with you in the future once contributions are opened up!