@ichong/react-native-contacts

react-native-contact-form

调用系统自带的通讯录UI 并选择联系人

Example

Installation

Using npm:

npm install react-native-contact-form --save

or using yarn:

yarn add react-native-contact-form

# RN >= 0.61.5
cd ios && pod install

Permissions

API 23+

Android requires allowing permissions with https://facebook.github.io/react-native/docs/permissionsandroid.html The READ_CONTACTS permission must be added to your main application's AndroidManifest.xml.

...
<uses-permission android:name="android.permission.READ_CONTACTS" />
...

API 22 and below

Add READ_PROFILE and/or WRITE_PROFILE permissions to AndroidManifest.xml

...
<uses-permission android:name="android.permission.READ_PROFILE" />
...

All RN versions

ios

Add kit specific "permission" keys to your Xcode Info.plist file, in order to make requestPermission work. Otherwise your app crashes when requesting the specific permission. Open Info.plist. Add key Privacy - 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.

Accessing note filed on iOS 13 (optional)

If you'd like to read/write the contact's notes, call the iosEnableNotesUsage(true) method before accessing the contact infos. Also, a com.apple.developer.contacts.notes entitlement must be added to the project. Before submitting your app to the AppStore, the permission for using the entitlement has to be granted as well. You can find a more detailed explanation here.

Usage

import Contacts from 'react-native-contact-form'

Contacts.openContacts().then((data) => {
    console.log(JSON.stringify(data)) // contact: {name: '小张', phone: '12345678901'}
}, (error) => {
    console.log(error.message)
})