Provides access to the phone's system contacts.
API documentation
Installation in managed Expo projects
For managed Expo projects, please follow the installation instructions in the API documentation for the latest stable release.
Installation in bare React Native projects
For bare React Native projects, you must ensure that you have installed and configured the expo
package before continuing.
Add the package to your npm dependencies
npx expo install expo-contacts
Configure for iOS
Add NSContactsUsageDescription
key to your Info.plist
:
<key>NSContactsUsageDescription</key>
<string>Allow $(PRODUCT_NAME) to access your contacts</string>
Run npx pod-install
after installing the npm package.
Configure for Android
Add android.permission.READ_CONTACTS
and optionally android.permission.WRITE_CONTACTS
permissions to your manifest (android/app/src/main/AndroidManifest.xml
):
<uses-permission android:name="android.permission.READ_CONTACTS" />
<uses-permission android:name="android.permission.WRITE_CONTACTS" />
Contributing
Contributions are very welcome! Please refer to guidelines described in the contributing guide.