@capacitor-community/contacts

Contacts

@capacitor-community/contacts

Capacitor Plugin for accessing Contacts.

Purpose

This plugin enables you to access the native contacts APIs of iOS and Android. It allows you to retrieve, create and delete contacts.

Versions

Currently there are three actively maintained versions of this plugin. The API of these versions is identical. The only difference between these versions is the supported Capacitor versions.

Plugin	Capacitor	Status	Documentation
v6.x	v6.x	LTS	Link
v5.x	v5.x	LTS	Link
v4.x	v4.x	LTS	Link
v3.x	v3.x	LTS	Link

If you are installing this plugin into a new project, you can ignore the following explanation.

In the past a few other versions of this plugin were released, also targeting different versions of Capacitor:

Plugin	Capacitor	Status	Documentation
v2.x	v4.x	Deprecated	Link
v1.0.9 and up	v3.x	Deprecated	Link
v1.0.0 and up	v2.x	Deprecated	Link
v0.x	v2.x	Deprecated	Link

Admittedly, this wasn't the most consistent versioning strategy, and we'll keep it more coherent in the future.

It's highly recommended to upgrade to either v3, v4, v5 or v6 if you are using an old version!

Documentation

Extensive documentation is available here.

Shortcuts

• Documentation homepage

• Installation

• API reference

Limitations

This plugins only adds support for using the native iOS and Android APIs. If you want to make use of the JavaScript API as well (for a possible webapp) you should implement that separately. Of course it should be possible to integrate this into the plugin in the future. If you want to help out with this, please start a PR.