To contribute read CONTRIBUTING.md.
Ask questions on stackoverflow not the issue tracker.
getAll
is a database intensive process, and can take a long time to complete depending on the size of the contacts list. Because of this, it is recommended you access the getAll
method before it is needed, and cache the results for future use.
import Contacts from 'react-native-contacts';
Contacts.getAll((err, contacts) => {
if (err) {
throw err;
}
// contacts returned
})
See the full API for more methods.
On android you must request permissions beforehand
import { PermissionsAndroid } from 'react-native';
import Contacts from 'react-native-contacts';
PermissionsAndroid.request(
PermissionsAndroid.PERMISSIONS.READ_CONTACTS,
{
'title': 'Contacts',
'message': 'This app would like to view your contacts.'
}
).then(() => {
Contacts.getAll((err, contacts) => {
if (err === 'denied'){
// error
} else {
// contacts returned in Array
}
})
})
To use this module you have to install it and configure the permissions. Please read this entire section.
Install with npm or yarn.
With npm
npm install react-native-contacts --save
With yarn
yarn add react-native-contacts
and then configure your project.
Using the same instructions as https://facebook.github.io/react-native/docs/linking-libraries-ios.html
- open in xcode
open ios/yourProject.xcodeproj/
- drag
./node_modules/react-native-contacts/ios/RCTContacts.xcodeproj
toLibraries
in you project view. - In the XCode project navigator, select your project,
select the
Build Phases
tab dragLibraries > RCTContacts.xcodeproj > Products > libRCTContacts.a
into theLink Binary With Libraries
section. Video to clarify Adding Camera Roll to an ios project in React Native. - Add kit specific "permission" keys to your Xcode
Info.plist
file, in order to makerequestPermission
work. Otherwise your app crashes when requesting the specific permission. OpenInfo.plist
. Add keyPrivacy - Contacts Usage Description
with your kit specific permission. The value for the key is optional in development. If you submit to the App Store the value must explain why you need this permission.
You should be able to run the app via the Run button in xcode or react-native run-ios
in the terminal.
Starting with 0.60, the above instructions stop working on iOS. Instead, you have to do the following:
- Add the following line inside
ios/Podfile
target 'app' do
...
pod 'react-native-contacts', :path => '../node_modules/react-native-contacts' <-- add me
...
end
- Run
pod install
in folderios
For react native versions 0.60 and above you have to use Android X. Android X support was added to react-native-contacts in version 5.x+. If you are using rn 0.59 and below install rnc versions 4.x instead.
- In
android/settings.gradle
...
include ':react-native-contacts'
project(':react-native-contacts').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-contacts/android')
- In
android/app/build.gradle
...
dependencies {
...
implementation project(':react-native-contacts')
}
- register module (in MainApplication.java)
import com.rt2zz.reactnativecontacts.ReactNativeContacts; // <--- import
public class MainActivity extends ReactActivity {
......
@Override
protected List<ReactPackage> getPackages() {
return Arrays.<ReactPackage>asList(
new MainReactPackage(),
new ReactNativeContacts()); // <------ add this
}
......
}
Android requires allowing permissions with https://facebook.github.io/react-native/docs/permissionsandroid.html
The READ_CONTACTS
permission is automatically added to AndroidManifest.xml
, so you just need request it. If your app creates contacts add WRITE_CONTACTS
permission to AndroidManifest.xml
and request the permission at runtime.
...
<uses-permission android:name="android.permission.WRITE_CONTACTS" />
...
Add READ_PROFILE
and/or WRITE_PROFILE
permissions to AndroidManifest.xml
...
<uses-permission android:name="android.permission.READ_PROFILE" />
...
If you use Proguard, the snippet below on proguard-rules.pro Without it, your apk release version could failed
-keep class com.rt2zz.reactnativecontacts.** {*;}
-keepclassmembers class com.rt2zz.reactnativecontacts.** {*;}
getAll
(callback) - returns all contacts as an array of objectsgetAllWithoutPhotos
- same asgetAll
on Android, but on iOS it will not return uris for contact photos (because there's a significant overhead in creating the images)getContactById(contactId, callback)
- returns contact with defined contactId (or null if it doesn't exist)getPhotoForId(contactId, callback)
- returns a URI (or null) for a contacts photoaddContact
(contact, callback) - adds a contact to the AddressBook.openContactForm
(contact, callback) - create a new contact and display in contactsUI.openExistingContact
(contact, callback) - where contact is an object with a valid recordIDupdateContact
(contact, callback) - where contact is an object with a valid recordIDdeleteContact
(contact, callback) - where contact is an object with a valid recordIDgetContactsMatchingString
(string, callback) - where string is any string to match a name (first, middle, family) togetContactsByPhoneNumber
(string, callback) - where string is a phone number to match to.checkPermission
(callback) - checks permission to access Contacts ios onlyrequestPermission
(callback) - request permission to access Contacts ios onlywritePhotoToPath
(callback) - writes the contact photo to a given path android only
Callbacks follow node-style:
callback <Function>
err <Error>
response <Object>
{
recordID: '6b2237ee0df85980',
company: "",
emailAddresses: [{
label: "work",
email: "carl-jung@example.com",
}],
familyName: "Jung",
givenName: "Carl",
jobTitle: "",
note: 'some text',
urlAddresses: [{
label: "home",
url: "www.jung.com",
}],
middleName: "",
phoneNumbers: [{
label: "mobile",
number: "(555) 555-5555",
}],
hasThumbnail: true,
thumbnailPath: 'content://com.android.contacts/display_photo/3',
postalAddresses: [
{
street: '123 Fake Street',
city: 'Sample City',
state: 'CA',
region: 'CA',
postCode: '90210',
country: 'USA',
label: 'home'
}
],
birthday: {"year": 1988, "month": 0, "day": 1 }
}
NOTE
- on Android versions below 8 the entire display name is passed in the
givenName
field.middleName
andfamilyName
will be""
. - on iOS the note field is not available.
Currently all fields from the contact record except for thumbnailPath are supported for writing
var newPerson = {
emailAddresses: [{
label: "work",
email: "mrniet@example.com",
}],
familyName: "Nietzsche",
givenName: "Friedrich",
}
Contacts.addContact(newPerson, (err) => {
if (err) throw err;
// save successful
})
Currently all fields from the contact record except for thumbnailPath are supported for writing
var newPerson = {
emailAddresses: [{
label: "work",
email: "mrniet@example.com",
}],
displayName: "Friedrich Nietzsche"
}
Contacts.openContactForm(newPerson, (err, contact) => {
if (err) throw err;
// contact has been saved
})
You may want to edit the contact before saving it into your phone book. So using openContactForm
allow you to prompt default phone create contacts UI and the new to-be-added contact will be display on the contacts UI view. Click save or cancel button will exit the contacts UI view.
Example
Contacts.getAll((err, contacts) => {
if (err) {
throw err;
}
// update the first record
let someRecord = contacts[0]
someRecord.emailAddresses.push({
label: "junk",
email: "mrniet+junkmail@test.com",
})
Contacts.updateContact(someRecord, (err) => {
if (err) throw err;
// record updated
})
})
Update reference contacts by their recordID (as returned by the OS in getContacts). Apple does not guarantee the recordID will not change, e.g. it may be reassigned during a phone migration. Consequently you should always grab a fresh contact list with getContacts
before performing update operations.
There are issues with updating contacts on Android:
- custom labels get overwritten to "Other",
- postal address update code doesn't exist. (it exists for addContact) See morenoh149#332 (comment) for current discussions.
You can delete a record using only it's recordID
Contacts.deleteContact({recordID: 1}, (err, recordId) => {
if (err) {
throw err;
}
// contact deleted
})
Or by passing the full contact object with a recordID
field.
Contacts.deleteContact(contact, (err, recordId) => {
if (err) {
throw err;
}
// contact deleted
})
The thumbnailPath is the direct URI for the temp location of the contact's cropped thumbnail image.
<Image source={{uri: contact.thumbnailPath}} />
checkPermission
(callback) - checks permission to access Contacts.
requestPermission
(callback) - request permission to access Contacts.
Usage as follows:
Contacts.checkPermission((err, permission) => {
if (err) throw err;
// Contacts.PERMISSION_AUTHORIZED || Contacts.PERMISSION_UNDEFINED || Contacts.PERMISSION_DENIED
if (permission === 'undefined') {
Contacts.requestPermission((err, permission) => {
// ...
})
}
if (permission === 'authorized') {
// yay!
}
if (permission === 'denied') {
// x.x
}
})
These methods are only useful on iOS. For Android you'll have to use https://facebook.github.io/react-native/docs/permissionsandroid.html
These methods do not re-request permission if permission has already been granted or denied. This is a limitation in iOS, the best you can do is prompt the user with instructions for how to enable contacts from the phone settings page Settings > [app name] > contacts
.
You can find an example app/showcase here
![]() Harry Moreno |