npm package: @justdodo/contacts
Description: Contacts Plugin for Capacitor
Author: justdodo
Latest version: 5.0.0

<p align="center">
  <img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" />
</p>

<h3 id="home" align="center">Contacts</h3>

<p align="center"><strong><code>@capacitor-community/contacts</code></strong></p>

<p align="center">Capacitor Plugin for accessing Contacts.</p>

<p align="center">
  <img src="https://img.shields.io/badge/supported%20capacitor%20versions-v3%20and%20v4-blue?logo=Capacitor&style=flat-square" />
  <img src="https://img.shields.io/maintenance/yes/2023?style=flat-square" />
  <a href="https://www.npmjs.com/package/@capacitor-community/contacts">
    <img src="https://img.shields.io/npm/l/@capacitor-community/contacts?style=flat-square" />
  </a>
  <br>
  <a href="https://www.npmjs.com/package/@capacitor-community/contacts">
    <img src="https://img.shields.io/npm/dw/@capacitor-community/contacts?style=flat-square" />
  </a>
  <a href="https://www.npmjs.com/package/@capacitor-community/contacts">
    <img src="https://img.shields.io/npm/v/@capacitor-community/contacts?style=flat-square" />
  </a>
</p>

## 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 two actively maintained versions of this plugin. The API of these versions is identical. The only difference between the two versions is the supported Capacitor versions.

| Plugin | Capacitor | Status | Documentation                                           |
| ------ | --------- | ------ | ------------------------------------------------------- |
| v4.x   | v4.x      | LTS    | [Link](https://capacitor-community.github.io/contacts/) |
| v3.x   | v3.x      | LTS    | [Link](https://capacitor-community.github.io/contacts/) |

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](https://github.com/capacitor-community/contacts/blob/v2.0.0/README.md)                                   |
| v1.0.9 and up | v3.x      | Deprecated | [Link](https://github.com/capacitor-community/contacts/blob/1.1.3/README.md)                                    |
| v1.0.0 and up | v2.x      | Deprecated | [Link](https://github.com/capacitor-community/contacts/blob/0cb99be68dc8ee4547c75f932872bd065f5509d2/README.md) |
| v0.x          | v2.x      | Deprecated | [Link](https://github.com/capacitor-community/contacts/blob/0.1.1/README.md)                                    |

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 or v4 if you are using an old version!

<p class="hide-next-element"></p>

## Documentation

<p class="hide-next-element"></p>

Extensive documentation is available [here](https://capacitor-community.github.io/contacts/).

<p class="hide-next-element"></p>

## Shortcuts

<p class="hide-next-element"></p>

- [Documentation homepage](https://capacitor-community.github.io/contacts/)

- [Installation](https://capacitor-community.github.io/contacts/#/getting-started-installation)

- [API reference](https://capacitor-community.github.io/contacts/#/api)

<!-- - [Examples](https://github.com/capacitor-community/contacts-examples) -->

## 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.