ContactsManager
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Secure context: This feature is available only insecure contexts (HTTPS), in some or allsupporting browsers.
Experimental:This is anexperimental technology
Check theBrowser compatibility table carefully before using this in production.
TheContactsManager interface of theContact Picker API allows users to select entries from their contact list and share limited details of the selected entries with a website or application.
TheContactsManager is available through the globalnavigator.contacts property.
Instance methods
select()ExperimentalReturns a
Promisewhich, when resolved, presents the user with a contact picker which allows them to select contact(s) they wish to share.getProperties()ExperimentalReturns a
Promisewhich resolves with anArrayofstringsindicating which contact properties are available.
Examples
Feature Detection
The following code checks whether the Contact Picker API is supported.
const supported = "contacts" in navigator && "ContactsManager" in window;Checking for Supported Properties
The following asynchronous function uses thegetProperties method to check for supported properties.
async function checkProperties() { const supportedProperties = await navigator.contacts.getProperties(); if (supportedProperties.includes("name")) { // run code for name support } if (supportedProperties.includes("email")) { // run code for email support } if (supportedProperties.includes("tel")) { // run code for telephone number support } if (supportedProperties.includes("address")) { // run code for address support } if (supportedProperties.includes("icon")) { // run code for avatar support }}Selecting Contacts
The following example sets an array of properties to be retrieved for each contact, as well as setting an options object to allow for multiple contacts to be selected.
An asynchronous function is then defined which uses theselect() method to present the user with a contact picker interface and handle the chosen results.
const props = ["name", "email", "tel", "address", "icon"];const opts = { multiple: true };async function getContacts() { try { const contacts = await navigator.contacts.select(props, opts); handleResults(contacts); } catch (ex) { // Handle any errors here. }}handleResults() is a developer defined function.
Specifications
| Specification |
|---|
| Contact Picker API # contacts-manager |