React Native course · Module 13: Native APIs
expo-contacts - User contacts
In this lesson5
Welcome to the Contacts Vault! You'll learn to integrate the app with the phone's contacts.
Installation
npx expo install expo-contactsPermissions and fetching contacts
import * as Contacts from 'expo-contacts';
async function getContacts() {
const { status } = await Contacts.requestPermissionsAsync();
if (status !== 'granted') {
Alert.alert('No permissions', 'Enable access to contacts');
return [];
}
const { data } = await Contacts.getContactsAsync({
fields: [
Contacts.Fields.Name,
Contacts.Fields.PhoneNumbers,
Contacts.Fields.Emails,
Contacts.Fields.Image,
],
});
return data;
}Searching contacts
async function searchContacts(query: string) {
const { data } = await Contacts.getContactsAsync({
name: query, // Filter by name
fields: [Contacts.Fields.Name, Contacts.Fields.PhoneNumbers],
});
return data;
}Adding a contact
async function addContact(name: string, phone: string, email: string) {
const contact = {
[Contacts.Fields.FirstName]: name.split(' ')[0],
[Contacts.Fields.LastName]: name.split(' ')[1] || '',
[Contacts.Fields.PhoneNumbers]: [
{ label: 'mobile', number: phone },
],
[Contacts.Fields.Emails]: [
{ label: 'work', email: email },
],
};
const contactId = await Contacts.addContactAsync(contact);
return contactId;
}useContacts Hook
function useContacts() {
const [contacts, setContacts] = useState<Contacts.Contact[]>([]);
const [loading, setLoading] = useState(true);
const [permission, setPermission] = useState(false);
useEffect(() => {
(async () => {
const { status } = await Contacts.requestPermissionsAsync();
setPermission(status === 'granted');
if (status === 'granted') {
const { data } = await Contacts.getContactsAsync({
fields: [Contacts.Fields.Name, Contacts.Fields.PhoneNumbers],
});
setContacts(data);
}
setLoading(false);
})();
}, []);
return { contacts, loading, permission };
}Code for this lesson: App.tsx
import React, { useState, useEffect } from 'react';
import { View, Text, FlatList, StyleSheet } from 'react-native';
import * as Contacts from 'expo-contacts';
// Hook returning the contacts from the user's phone
function useContacts() {
const [contacts, setContacts] = useState<Contacts.Contact[]>([]);
const [loading, setLoading] = useState(true);
const [permission, setPermission] = useState(false);
useEffect(() => {
(async () => {
// TODO: request permissions: const { status } = await Contacts.requestPermissionsAsync();
// TODO: call setPermission(status === 'granted');
// TODO: if status === 'granted', fetch contacts:
// const { data } = await Contacts.getContactsAsync({
// fields: [Contacts.Fields.Name, Contacts.Fields.PhoneNumbers],
// });
// then call setContacts(data);
setLoading(false);
})();
}, []);
return { contacts, loading, permission };
}
export default function App() {
const { contacts, loading } = useContacts();
if (loading) {
return (
<View style={styles.screen}>
<Text style={styles.title}>Loading contacts...</Text>
</View>
);
}
return (
<View style={styles.screen}>
<Text style={styles.title}>Atlantis Contacts</Text>
<FlatList
data={contacts}
keyExtractor={(item) => item.id ?? Math.random().toString()}
renderItem={({ item }) => <Text style={styles.item}>{item.name}</Text>}
/>
</View>
);
}
const styles = StyleSheet.create({
screen: {
flex: 1,
padding: 24,
backgroundColor: '#1a5276',
},
title: {
fontSize: 22,
color: '#fff',
fontWeight: '600',
marginBottom: 16,
},
item: {
fontSize: 16,
color: '#d6eaf8',
paddingVertical: 6,
},
});Docs entries used in this lesson
Spotted a mistake in this lesson?
Check yourself
Answer the questions from this lesson. Pick an answer to see right away whether it is correct.
1. How do you install expo-contacts?
2. How do you request permissions for contacts?
These are 2 of 4 questions for this lesson. Solve the rest in the game.
Hands-on tasks in the game
- Horizontal ordering
Arrange the contacts fetching:
- Code editor
Complete the useContacts code.