@capacitor-community/contacts
Advanced tools
Comparing version 1.1.3 to 2.0.0-0
@@ -191,7 +191,7 @@ { | ||
{ | ||
"text": "https://developer.apple.com/documentation/contacts/cnmutablecontact", | ||
"text": "https ://developer.apple.com/documentation/contacts/cnmutablecontact", | ||
"name": "see" | ||
}, | ||
{ | ||
"text": "android-link...", | ||
"text": "android-link ...", | ||
"name": "see" | ||
@@ -198,0 +198,0 @@ } |
{ | ||
"name": "@capacitor-community/contacts", | ||
"version": "1.1.3", | ||
"version": "2.0.0-0", | ||
"description": "Contacts Plugin for Capacitor", | ||
@@ -32,3 +32,3 @@ "main": "dist/plugin.cjs.js", | ||
"verify": "npm run verify:ios && npm run verify:android && npm run verify:web", | ||
"verify:ios": "cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin && cd ..", | ||
"verify:ios": "cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..", | ||
"verify:android": "cd android && ./gradlew clean build test && cd ..", | ||
@@ -49,6 +49,6 @@ "verify:web": "npm run build", | ||
"devDependencies": { | ||
"@capacitor/android": "^3.0.0", | ||
"@capacitor/core": "^3.0.0", | ||
"@capacitor/android": "^4.0.0", | ||
"@capacitor/core": "^4.0.0", | ||
"@capacitor/docgen": "^0.0.10", | ||
"@capacitor/ios": "next", | ||
"@capacitor/ios": "^4.0.0", | ||
"@ionic/eslint-config": "^0.3.0", | ||
@@ -59,11 +59,11 @@ "@ionic/prettier-config": "^1.0.1", | ||
"eslint": "^7.11.0", | ||
"prettier": "~2.2.0", | ||
"prettier-plugin-java": "~1.0.0", | ||
"prettier": "~2.3.0", | ||
"prettier-plugin-java": "~1.0.2", | ||
"rimraf": "^3.0.2", | ||
"rollup": "^2.32.0", | ||
"swiftlint": "^1.0.1", | ||
"typescript": "~4.0.3" | ||
"typescript": "~4.1.5" | ||
}, | ||
"peerDependencies": { | ||
"@capacitor/core": "^3.0.0" | ||
"@capacitor/core": "^4.0.0" | ||
}, | ||
@@ -70,0 +70,0 @@ "prettier": "@ionic/prettier-config", |
@@ -29,3 +29,3 @@ <p align="center"><br><img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /></p> | ||
You can find a working Ionic App using the Byrds' Capacitor Contacts plugin here: | ||
https://github.com/byrdsandbytes/capContactsDemo/tree/capacitor-community | ||
https://github.com/byrdsandbytes/capContactsDemo | ||
@@ -36,3 +36,3 @@ ## Prerequisites | ||
``` | ||
```sh | ||
cd my-app | ||
@@ -44,3 +44,3 @@ npm install --save @capacitor/core @capacitor/cli | ||
``` | ||
```sh | ||
npx cap init | ||
@@ -51,3 +51,3 @@ ``` | ||
``` | ||
```sh | ||
npx cap add android | ||
@@ -62,4 +62,10 @@ npx cap add ios | ||
``` | ||
```sh | ||
npm i --save @capacitor-community/contacts | ||
# or yarn | ||
yarn add @capacitor-community/contacts | ||
# or pnpm | ||
pnpm add @capacitor-community/contacts | ||
``` | ||
@@ -69,3 +75,3 @@ | ||
``` | ||
```sh | ||
npx cap sync | ||
@@ -93,3 +99,3 @@ ``` | ||
``` | ||
```xml | ||
<uses-permission android:name="android.permission.READ_CONTACTS" /> | ||
@@ -101,9 +107,9 @@ <uses-permission android:name="android.permission.WRITE_CONTACTS"/> | ||
``` | ||
```java | ||
// Initializes the Bridge | ||
this.init(savedInstanceState, new ArrayList<Class<? extends Plugin>>() {{ | ||
// Additional plugins you've installed go here | ||
// Ex: add(TotallyAwesomePlugin.class); | ||
add(Contacts.class); | ||
}}); | ||
this.init(savedInstanceState, new ArrayList<Class<? extends Plugin>>() {{ | ||
// Additional plugins you've installed go here | ||
// Ex: add(TotallyAwesomePlugin.class); | ||
add(Contacts.class); | ||
}}); | ||
``` | ||
@@ -113,3 +119,3 @@ | ||
``` | ||
```java | ||
import ch.byrds.capacitor.contacts.Contacts; | ||
@@ -124,6 +130,7 @@ ``` | ||
``` | ||
```ts | ||
export interface ContactsPlugin { | ||
getPermissions(): Promise<PermissionStatus>; | ||
getContacts(): Promise<{contacts: Contact[]}>; | ||
saveContact(contact: NewContact): Promise<void>; | ||
} | ||
@@ -136,3 +143,3 @@ ``` | ||
``` | ||
```ts | ||
import { Contacts } from '@capacitor-community/contacts' | ||
@@ -143,3 +150,3 @@ ``` | ||
``` | ||
```ts | ||
Contacts.getContacts().then(result => { | ||
@@ -156,3 +163,3 @@ console.log(result); | ||
If you're trying to build something like "contacts matching" based on phone numbers i recommend using google libphonenumber: https://www.npmjs.com/package/google-libphonenumber | ||
If you're trying to build something like "contacts matching" based on phone numbers, recommends using google [libphonenumber](https://www.npmjs.com/package/google-libphonenumber) based library [awesome-phonenumber](https://www.npmjs.com/package/awesome-phonenumber). | ||
@@ -163,3 +170,3 @@ In order to match them properly you need to format them before you can match or store them properly. | ||
``` | ||
```ts | ||
export interface PermissionStatus { | ||
@@ -166,0 +173,0 @@ granted: boolean; |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
74768
374
2
1