React-Native-Calendar-Events

React Native Module for IOS Calendar Events

Install

npm install react-native-calendar-events

Then add RNCalendarEvents, as well as EventKit.framework to project libraries.

For iOS 8 compatibility, you may need to link your project with CoreFoundation.framework (status = Optional) under Link Binary With Libraries on the Build Phases page of your project settings.

Usage

Require the react-native-calendar-events module.

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

NOTE: Starting from 1.0.0, this package will use Promises instead of Events.

Properties

Property	Value	Description
id	String (read-only)	Unique id for the calendar event.
title	String	The title for the calendar event.
startDate	Date	The start date of the calendar event.
endDate	Date	The end date of the calendar event.
allDay	Bool	Indicates whether the event is an all-day event.
recurrence	String	The simple recurrence frequency of the calendar event daily, weekly, monthly, yearly or none.
occurrenceDate	Date (read-only)	The original occurrence date of an event if it is part of a recurring series.
isDetached	Bool	Indicates whether an event is a detached instance of a repeating event.
location	String	The location associated with the calendar event.
notes	String	The notes associated with the calendar event.
alarms	Array	The alarms associated with the calendar event, as an array of alarm objects.

Get authorization status for IOS EventStore

Returns a promise with fulfilled authorization status of "denied", "restricted", "authorized" or "undetermined".

RNCalendarEvents.authorizationStatus();

Request authorization to IOS EventStore

Authorization must be granted before accessing calendar events. Returns a promise with fulfilled authorization status of "denied", "restricted", "authorized" or "undetermined".

RNCalendarEvents.authorizeEventStore();

Fetch all calendar events from EventStore

Returns a promise with fulfilled with found events.

RNCalendarEvents.fetchAllEvents(startDate, endDate);

Create calendar event

Returns a promise with fulfilled with the created event's id.

RNCalendarEvents.saveEvent(title, settings);

Example:

RNCalendarEvents.saveEvent('title', {
  location: 'location',
  notes: 'notes',
  startDate: '2016-10-01T09:45:00.000UTC',
  endDate: '2016-10-02T09:45:00.000UTC'
})
.then(eventId => {...});

Create calendar event with alarms

Alarm options:

Property	Value	Description
date	Date or Number	If a Date 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.
structuredLocation	Object	The location to trigger an alarm.

Alarm structuredLocation properties:

Property	Value	Description
title	String	The title of the location.
proximity	String	A value indicating how a location-based alarm is triggered. Possible values: enter, leave, none.
radius	Number	A minimum distance from the core location that would trigger the calendar event's alarm.
coords	Object	The geolocation coordinates, as an object with latitude and longitude properties

Example with date:

RNCalendarEvents.saveEvent('title', {
  location: 'location',
  notes: 'notes',
  startDate: '2016-10-01T09:45:00.000UTC',
  endDate: '2016-10-02T09:45:00.000UTC',
  alarms: [{
    date: -1 // or absolute date
  }]
});

Example with structuredLocation:

RNCalendarEvents.saveEvent('title', {
  location: 'location',
  notes: 'notes',
  startDate: '2016-10-01T09:45:00.000UTC',
  endDate: '2016-10-02T09:45:00.000UTC',
  alarms: [{
    structuredLocation: {
      title: 'title',
      proximity: 'enter',
      radius: 500,
      coords: {
        latitude: 30.0000,
        longitude: 97.0000
      }
    }
  }]
});

Example with recurrence:

RNCalendarEvents.saveEvent('title', {
  location: 'location',
  notes: 'notes',
  startDate: '2016-10-01T09:45:00.000UTC',
  endDate: '2016-10-02T09:45:00.000UTC',
  alarms: [{
    date: -1 // or absolute date
  }],
  recurrence: 'daily'
});

Update calendar event

Give the unique calendar event id to update an existing calendar event. Returns a promise with fulfilled with updated event's id.

RNCalendarEvents.saveEvent('title', {
  id: 'id',
  location: 'location',
  notes: 'notes',
  startDate: '2016-10-02T09:45:00.000UTC',
  endDate: '2016-10-02T09:45:00.000UTC'
});

Remove calendar event

Give the unique calendar event instance id to remove the calendar event. Returns a promise with fulfilled with updated event's id.

RNCalendarEvents.removeEvent('id');

Remove future (recurring) calendar events

Give the unique calendar event instance id to remove future calendar events. Returns a promise with fulfilled with updated event's id.

RNCalendarEvents.removeFutureEvents('id');