![PyPI Now Supports iOS and Android Wheels for Mobile Python Development](https://cdn.sanity.io/images/cgdhsj6q/production/96416c872705517a6a65ad9646ce3e7caef623a0-1024x1024.webp?w=400&fit=max&auto=format)
Security News
PyPI Now Supports iOS and Android Wheels for Mobile Python Development
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.
@edenhealth/react-native-calendar-events
Advanced tools
React Native module for iOS Calendar Events
A React Native module to help access and save events to iOS and Android calendars.
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.
The following is required for the package to work properly.
Install the react-native-calendar-events
library with native code.
npm install --save react-native-calendar-events
Since this package contains native code, you will need to include the code as a library. The React Native documentation on "Linking Libraries" also provides some details for this process.
react-native link
iOS specific instructions
iOS specific requirements, such as mandatory privacy usage descriptions and including the EventKit.framework
.
Android specific instructions
Android specific requirements, such as mandatory application permissions.
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';
Get calendar authorization status.
RNCalendarEvents.authorizationStatus()
Returns: Promise
denied
, restricted
, authorized
or undetermined
Request calendar authorization. Authorization must be granted before accessing calendar events.
Android note: This is only necessary for targeted SDK of 23 and higher.
RNCalendarEvents.authorizeEventStore()
Returns: Promise
denied
, restricted
, authorized
or undetermined
Finds all the calendars on the device.
RNCalendarEvents.findCalendars()
Returns: Promise
Find calendar event by id. Returns a promise with fulfilled found events.
RNCalendarEvents.findEventById(id)
Arguments:
Returns: Promise
Fetch all calendar events. Returns a promise with fulfilled found events.
RNCalendarEvents.fetchAllEvents(startDate, endDate, calendars)
Arguments:
Returns: Promise
Creates or updates a calendar event. - wiki guide
RNCalendarEvents.saveEvent(title, details, options);
Arguments:
Returns: Promise
To update an event, the event id
must be defined. - wiki guide
RNCalendarEvents.saveEvent(title, {id: 'FE6B128F-C0D8-4FB8-8FC6-D1D6BA015CDE'})
Removes calendar event.
RNCalendarEvents.removeEvent(id, options)
Arguments:
Returns: Promise
Property | Type | Description | iOS | Android |
---|---|---|---|---|
id* | String | Unique id for the calendar event. | ✓ | ✓ |
calendarId** | String | Unique id for the calendar where the event will be saved. Defaults to the device's default calendar. | ✓ | ✓ |
title | String | The title for the calendar event. | ✓ | ✓ |
startDate | Date | The start date of the calendar event in ISO format. | ✓ | ✓ |
endDate | Date | The end date of the calendar event in ISO format. | ✓ | ✓ |
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. | ✓ | ✓ |
recurrenceRule ** | Object | The events recurrence settings. | ✓ | ✓ |
occurrenceDate* | Date | 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. | ✓ | |
url | String | The url associated with the calendar event. | ✓ | |
location | String | The location associated with the calendar event. | ✓ | ✓ |
notes | String | The notes associated with the calendar event. | ✓ | |
description | String | The description associated with the calendar event. | ✓ | |
alarms | Array | The alarms associated with the calendar event, as an array of alarm objects. | ✓ | ✓ |
attendees* | Array | The attendees of the event, including the organizer. | ✓ | ✓ |
calendar* | Object | The calendar containing the event. | ✓ | ✓ |
Property | Type | Description | iOS | Android |
---|---|---|---|---|
id | String | Unique calendar ID. | ✓ | ✓ |
title | String | The calendar’s title. | ✓ | ✓ |
type | String | The calendar’s type. | ✓ | ✓ |
source | String | The source object representing the account to which this calendar belongs. | ✓ | ✓ |
isPrimary* | Bool | Indicates if the calendar is assigned as primary. | ✓ | ✓ |
allowsModifications* | Bool | Indicates if the calendar allows events to be written, edited or removed. | ✓ | ✓ |
color* | String | The color assigned to the calendar represented as a hex value. | ✓ | ✓ |
allowedAvailabilities* | Array | The event availability settings supported by the calendar. | ✓ | ✓ |
Property | Type | Description | iOS | Android |
---|---|---|---|---|
name | String | The name of the attendee. | ✓ | ✓ |
email* | String | The email address of the attendee. | ✓ | ✓ |
phone* | String | The phone number of the attendee. | ✓ |
Property | Type | Description | iOS | Android |
---|---|---|---|---|
frequency | String | Event recurring frequency. Allowed values are daily , weekly , monthly , yearly . | ✓ | ✓ |
endDate | Date | Event recurring end date. This overrides occurrence. | ✓ | ✓ |
occurrence | Number | Number of event occurrences. | ✓ | ✓ |
interval | Number | The interval between events of this recurrence. | ✓ | ✓ |
Property | Type | Description | iOS | Android |
---|---|---|---|---|
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. | ✓ |
Property | Type | Description | iOS | Android |
---|---|---|---|---|
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 | ✓ |
Property | Type | Description | iOS | Android |
---|---|---|---|---|
exceptionDate | Date | The start date of a recurring event's exception instance. Used for updating single event in a recurring series | ✓ | ✓ |
futureEvents | Bool | If true the update will span all future events. If false it only update the single instance. | ✓ |
* Read only, ** Write only
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details
FAQs
React Native module for iOS Calendar Events
The npm package @edenhealth/react-native-calendar-events receives a total of 3 weekly downloads. As such, @edenhealth/react-native-calendar-events popularity was classified as not popular.
We found that @edenhealth/react-native-calendar-events demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.
Security News
Create React App is officially deprecated due to React 19 issues and lack of maintenance—developers should switch to Vite or other modern alternatives.
Security News
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.