React native module to save events to iOS and Android Calendar

React native module to save events to iOS and Android Calendar

React Native Calendar Events

npm npm npm

A React Native module to help access and save events to iOS and Android calendars.

Getting started

This package assumes that you already have a React Native project or are familiar with React Native. If not, checkout the official documentation for more details about getting started with React Native.

Support

versionreact-native version
2.0.0+0.60.0+
pre 2.0.0+0.40.0+

For 0.59-, you should use jetify -r

Installation

$ npm install --save react-native-calendar-events
# --- or ---
$ yarn add react-native-calendar-events

Don't forget going into the ios directory to execute a pod install.

πŸ†˜ Manual linking

Because this package targets React Native 0.60.0+, you will probably don't need to link it manually. Otherwise if it's not the case, follow this additional instructions:

πŸ‘€ See manual linking instructions

iOS

Add this line to your ios/Podfile file, then run pod install.

target 'YourAwesomeProject' do
  # …
  pod 'RNCalendarEvents', :path => '../node_modules/react-native-calendar-events'
end

Android

1 - Add the following lines to android/settings.gradle:

include ':react-native-calendar-events'
project(':react-native-calendar-events').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-calendar-events/android')

2 - Add the implementation line to the dependencies in android/app/build.gradle:

dependencies {
  // ...
  implementation project(':react-native-calendar-events')
}

3 - Add the import and link the package in MainApplication.java:

import com.calendarevents.RNCalendarEventsPackage; // <- add the RNCalendarEventsPackage import

public class MainApplication extends Application implements ReactApplication {

  // …

  @Override
  protected List<ReactPackage> getPackages() {
    @SuppressWarnings("UnnecessaryLocalVariable")
    List<ReactPackage> packages = new PackageList(this).getPackages();
    // …
    packages.add(new RNCalendarEventsPackage());
    return packages;
  }

  // …
}

iOS specific instructions

Add RNCalendarEvents, as well as EventKit.framework to project libraries if not already done.

Setting up privacy usage descriptions may also be required depending on which iOS version is supported. This involves updating the Property List, Info.plist, with the corresponding key for the EKEventStore api. Info.plist reference.

For updating the Info.plist key/value via XCode, add a Privacy - Calendars Usage Description key with a usage description as the value. Resulting change to Info.plist should look something like:

<key>NSCalendarsUsageDescription</key>
<string>This app requires access to the calendar</string>

API

The following API allows for interacting with both iOS and Android device calendars. See the full list of available event fields.

import RNCalendarEvents from "react-native-calendar-events";

checkPermissions

Get calendar authorization status. You may check for the default read/write access with no argument, or read-only access on Android by passing boolean true. iOS is always read/write.

RNCalendarEvents.checkPermissions((readOnly = false));

Returns: Promise

  • fulfilled: String - denied, restricted, authorized or undetermined
  • rejected: Error

requestPermissions

Request calendar authorization. Authorization must be granted before accessing calendar events.

RNCalendarEvents.requestPermissions((readOnly = false));

(readOnly is for Android only, see below)

Android note: this is necessary for targeted SDK of >=23. iOS note: This method will crash, if you didn't update Info.plist. Follow carefully installation instruction.

Returns: Promise

  • fulfilled: String - denied, restricted, authorized or undetermined
  • rejected: Error

Read-Only requestPermissions (Android only)

⚠️ Note that to restrict to read-only usage on Android (iOS is always read/write) you will need to alter the included Android permissions as the AndroidManifest.xml is merged during the Android build.

You do that by altering your AndroidManifest.xml to "remove" the WRITE_CALENDAR permission with an entry like so:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
  xmlns:tools="http://schemas.android.com/tools"
  >
  <!-- ... -->
  <uses-permission tools:node="remove" android:name="android.permission.WRITE_CALENDAR" />

findCalendars

Finds all the calendars on the device.

RNCalendarEvents.findCalendars();

Returns: Promise

  • fulfilled: Array - A list of known calendars on the device
  • rejected: Error

saveCalendar

Create a calendar.

RNCalendarEvents.saveCalendar(calendar);

⚠️ When you want to save a calendar, you need to use a valid source (find using findCalendars).

Arguments:

Returns: Promise

  • fulfilled: The id of the created calendar
  • rejected: Error

removeCalendar

Removes a calendar.

RNCalendarEvents.removeCalendar(id);

Arguments:

  • id: String - The id of the calendar to remove.

Returns: Promise

  • fulfilled: Bool - Successful
  • rejected: Error

findEventById

Find calendar event by id. Returns a promise with fulfilled found events.

RNCalendarEvents.findEventById(id);

Arguments:

  • id: String - The events unique id.

Returns: Promise

  • fulfilled: Object | null - Found event with unique id.
  • rejected: Error

fetchAllEvents

Fetch all calendar events. Returns a promise with fulfilled found events.

RNCalendarEvents.fetchAllEvents(startDate, endDate, calendars);

Arguments:

  • startDate: String - The start date of the range of events fetched.
  • endDate: String - The end date of the range of events fetched.
  • calendars: Array - List of calendar id strings to specify calendar events. Defaults to all calendars if empty.

Returns: Promise

  • fulfilled: Array - Matched events within the specified date range.
  • rejected: Error

saveEvent

Creates or updates a calendar event. - wiki guide

RNCalendarEvents.saveEvent(title, details, options);

Arguments:

  • title: String - The title of the event.
  • details: Object - The event's details.
  • options: Object - Options specific to the saved event.

Returns: Promise

  • fulfilled: String - Created event's ID.
  • rejected: Error

To update an event, the event id must be defined. - wiki guide

RNCalendarEvents.saveEvent(title, {
  id: "FE6B128F-C0D8-4FB8-8FC6-D1D6BA015CDE",
});

removeEvent

Removes calendar event.

RNCalendarEvents.removeEvent(id, options);

Arguments:

  • id: String - The id of the event to remove.
  • options: Object - Options specific to event removal.

Returns: Promise

  • fulfilled: Bool - Successful
  • rejected: Error

Event fields

PropertyTypeDescriptioniOSAndroid
id*StringUnique id for the calendar event.βœ“βœ“
calendarId**StringUnique id for the calendar where the event will be saved. Defaults to the device's default calendar.βœ“βœ“
titleStringThe title for the calendar event.βœ“βœ“
startDateStringThe start date of the calendar event in ISO format.βœ“βœ“
endDateStringThe end date of the calendar event in ISO format.βœ“βœ“
allDayBoolIndicates whether the event is an all-day
event.βœ“βœ“
recurrenceStringThe simple recurrence frequency of the calendar event daily, weekly, monthly, yearly or none.βœ“βœ“
recurrenceRule **ObjectThe events recurrence settings.βœ“βœ“
occurrenceDate*StringThe original occurrence date of an event if it is part of a recurring series.βœ“
isDetachedBoolIndicates whether an event is a detached instance of a repeating event.βœ“
urlStringThe url associated with the calendar event.βœ“
locationStringThe location associated with the calendar event.βœ“βœ“
notesStringThe notes associated with the calendar event.βœ“
descriptionStringThe description associated with the calendar event.βœ“
alarmsArrayThe alarms associated with the calendar event, as an array of alarm objects.βœ“βœ“
attendees*ArrayThe attendees of the event, including the organizer.βœ“βœ“
calendar*ObjectThe calendar containing the event.βœ“βœ“
skipAndroidTimezoneBoolSkip the process of setting automatic timezone on androidβœ“
timeZoneStringThe time zone associated with the eventβœ“

Calendar

PropertyTypeDescriptioniOSAndroid
idStringUnique calendar ID.βœ“βœ“
titleStringThe calendar’s title.βœ“βœ“
typeStringThe calendar’s type.βœ“βœ“
sourceStringThe source object representing the account to which this calendar belongs.βœ“βœ“
isPrimary*BoolIndicates if the calendar is assigned as primary.βœ“βœ“
allowsModifications*BoolIndicates if the calendar allows events to be written, edited or removed.βœ“βœ“
color*StringThe color assigned to the calendar represented as a hex value.βœ“βœ“
allowedAvailabilities*ArrayThe event availability settings supported by the calendar.βœ“βœ“

Attendees

PropertyTypeDescriptioniOSAndroid
nameStringThe name of the attendee.βœ“βœ“
email*StringThe email address of the attendee.βœ“βœ“
phone*StringThe phone number of the attendee.βœ“

Recurrence rule

PropertyTypeDescriptioniOSAndroid
frequencyStringEvent recurring frequency. Allowed values are daily, weekly, monthly, yearly.βœ“βœ“
endDateStringEvent recurring end date. This overrides occurrence.βœ“βœ“
occurrenceNumberNumber of event occurrences.βœ“βœ“
intervalNumberThe interval between events of this recurrence.βœ“βœ“

Alarms

PropertyTypeDescriptioniOSAndroid
dateString or NumberIf a String is given, an alarm will be set with an absolute date. If a Number is given, an alarm will be set with a relative offset (in minutes) from the start date.βœ“βœ“
structuredLocationObjectThe location to trigger an alarm.βœ“

Alarm structuredLocation

PropertyTypeDescriptioniOSAndroid
titleStringThe title of the location.βœ“
proximityStringA value indicating how a location-based alarm is triggered. Possible values: enter, leave, none.βœ“
radiusNumberA minimum distance from the core location that would trigger the calendar event's alarm.βœ“
coordsObjectThe geolocation coordinates, as an object with latitude and longitude propertiesβœ“

Options

PropertyTypeDescriptioniOSAndroid
exceptionDateStringThe start date of a recurring event's exception instance. Used for updating single event in a recurring seriesβœ“βœ“
futureEventsBoolIf true the update will span all future events. If false it only update the single instance.βœ“

Calendar options

PropertyTypeDescriptioniOSAndroid
titleStringThe calendar title (required)βœ“βœ“
colorStringThe calendar color (required)βœ“βœ“
entityTypeString'event' or 'reminder' (required)βœ“
nameStringThe calendar name (required)βœ“
accessLevelStringDefines how the event shows up for others when the calendar is shared doc(required) 'contributor', 'editor', 'freebusy', 'override', 'owner', 'read', 'respond', 'root'βœ“
ownerAccountStringThe owner account for this calendar, based on the calendar feed doc(required)βœ“
sourceObjectThe calendar Account source (required)βœ“
source.nameStringThe Account name (required)βœ“
source.typeStringThe Account typeβœ“
source.isLocalAccountBoolThe source (required if source.type is not used)βœ“

* Read only, ** _Write only

Troubleshooting

These are some common issues you may run into while using react-native-calendar-events library. If you encounter something that is not listed here, try searching in GitHub issues of react-native-calendar-events.

After saving an event, it disappear form the calendar

This might be related to a sync issue. You need to be sure that the event you saved is matching what your device will keep in sync.

For iOS, you might have not all event synced. You might need to update this iOS settings in Settings > Calendar > Sync > All Events. If that's not enough, it might be worth checking iOS iCloud sync documentation.
For Android, you can have a look to Google Calendar sync problems documentation.

Wiki

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

Big thanks to all who have contributed, raised an issue or simply find use in this project. Cheers!

Check it on GitHub