Web/API/ContactsManager/select

Draft This page is not complete.

Secure contextThis feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The select() method of the ContactsManager interface returns a Promise which, when resolved, presents the user with a contact picker which allows them to select contact(s) they wish to share. This method requires a user gesture for the Promise to resolve.

Syntax

var ContactInfo = ContactsManager.select(properties, options);

Parameters

properties

An array of strings defining what information to retrieve from a contact. Allowed values are as follows:

'name'

• The contact's name.
• 'tel': The telephone number(s) of the contact.
• 'email': The email address of the contact.
• 'address': The contact's postal address.
• 'icon': The avatar of the contact.

options Optional

Options are as follows:

multiple

• A Boolean that allows multiple contacts to be selected. The default is false.

Return value

Returns a Promise which resolves on successful contact selection.

Exceptions

InvalidStateError

The browsing context is not top-level or the contact picker is showing a flag. A flag denotes an already existing contact picker, only one picker can exist at any time.

SecurityError

If the method is not triggered by user interaction.

TypeError

If properties is empty, or if any of the specified properties are not supported.

Examples

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 the select() 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	Status	Comment
UnknownThe definition of 'select' in that specification.	Unknown	Initial definition.

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
select Experimental'Non-standard'	Chrome Full support 80	Edge Full support 80	Firefox No support No	IE No support No	Opera Full support Yes	Safari No support No	WebView Android Full support 80	Chrome Android Full support 80	Firefox Android No support No	Opera Android No support No	Safari iOS No support No	Samsung Internet Android Full support 13.0

Legend

Full support  

Full support

No support  

No support

Experimental. Expect behavior to change in the future.'

Experimental. Expect behavior to change in the future.

Non-standard. Expect poor cross-browser support.'

Non-standard. Expect poor cross-browser support.

ContactsManager.select() by Mozilla Contributors is licensed under CC-BY-SA 2.5.