{"id":13820825,"url":"https://github.com/Baseflow/flutter-contacts-plugin","last_synced_at":"2025-05-16T10:33:10.589Z","repository":{"id":56827325,"uuid":"146403950","full_name":"Baseflow/flutter-contacts-plugin","owner":"Baseflow","description":"Contact plugin for Flutter. This plugin provides a cross-platform (iOS, Android) API to read, create and update contacts from the address book.","archived":false,"fork":false,"pushed_at":"2020-05-14T11:31:55.000Z","size":133,"stargazers_count":40,"open_issues_count":12,"forks_count":18,"subscribers_count":8,"default_branch":"develop","last_synced_at":"2024-08-05T08:09:20.299Z","etag":null,"topics":["android","baseflow","contacts","dart","flutter","flutter-plugin","ios"],"latest_commit_sha":null,"homepage":"https://baseflow.com","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Baseflow.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":"FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"Baseflow","custom":"https://baseflow.com/contact"}},"created_at":"2018-08-28T06:45:53.000Z","updated_at":"2022-12-30T13:00:58.000Z","dependencies_parsed_at":"2022-09-20T22:55:50.385Z","dependency_job_id":null,"html_url":"https://github.com/Baseflow/flutter-contacts-plugin","commit_stats":null,"previous_names":["baseflowit/flutter-contacts-plugin"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Baseflow%2Fflutter-contacts-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Baseflow%2Fflutter-contacts-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Baseflow%2Fflutter-contacts-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Baseflow%2Fflutter-contacts-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Baseflow","download_url":"https://codeload.github.com/Baseflow/flutter-contacts-plugin/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225423734,"owners_count":17472178,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","baseflow","contacts","dart","flutter","flutter-plugin","ios"],"created_at":"2024-08-04T08:01:09.732Z","updated_at":"2024-11-19T20:31:28.351Z","avatar_url":"https://github.com/Baseflow.png","language":"Dart","funding_links":["https://github.com/sponsors/Baseflow","https://baseflow.com/contact"],"categories":["Dart"],"sub_categories":[],"readme":"# Flutter Contacts Plugin  \n\n[![pub package](https://img.shields.io/pub/v/contacts.svg)](https://pub.dartlang.org/packages/contacts)\n\nA Flutter contacts plugin which provides easy access to the platform specific address book.\n\nBranch  | Build Status \n------- | ------------\ndevelop | [![Build Status](https://travis-ci.com/BaseflowIT/flutter-contacts-plugin.svg?branch=develop)](https://travis-ci.com/BaseflowIT/flutter-contacts)\nmaster  | [![Build Status](https://travis-ci.com/BaseflowIT/flutter-contacts-plugin.svg?branch=master)](https://travis-ci.com/BaseflowIT/flutter-contacts)\n\n## Features\n\n* Automatically check and request the necessary permissions to access the platform specific address book;\n* Read contacts from the addres book;\n* [WIP] Store new contacts in the address book;\n* [WIP] Update details of existing contacts;\n* [WIP] Delete existing contacts from the address book.\n\n## Usage\n\nTo use this plugin, add `contacts_plugin` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/). For example:\n\n```yaml\ndependencies:\n  contacts_plugin: '^0.0.3'\n```\n\n\u003e **NOTE:** There's a known issue with integrating plugins that use Swift into a Flutter project created with the Objective-C template. See issue [Flutter#16049](https://github.com/flutter/flutter/issues/16049) for help on integration.\n\n## API\n\n### Fetch all contacts\n\nTo fetch all contacts from the address book make a call to the `getContacts` method:\n\n``` dart\nimport 'package:geolocator/contacts_plugin.dart';\n\nList\u003cContact\u003e contacts = await ContactsPlugin().getContacts();\n```\n\n## Permissions\n\n### Android\n\nOn Android you'll need to add either the `READ_CONTACTS` or the `WRITE_CONTACTS` permissions to your Android Manifest (depending if you need read and/ or write access to the address book). Todo so open the AndroidManifest.xml file and one of the following two lines as direct children of the `\u003cmanifest\u003e` tag:\n\n``` xml\n\u003cuses-permission android:name=\"android.permission.READ_CONTACTS\" /\u003e\n\u003cuses-permission android:name=\"android.permission.WRITE_CONTACTS\" /\u003e\n```\n\n### iOS\n\nOn iOS you'll need to add the `NSContactsUsageDescription` to your Info.plist file in order to access the device's address book. Simply open your Info.plist file and add the following:\n\n``` xml\n\u003ckey\u003eNSContactsUsageDescription\u003c/key\u003e\n\u003cstring\u003eThis app needs access to address book.\u003c/string\u003e\n```\n\n## Issues\n\nPlease file any issues, bugs or feature request as an issue on our [GitHub](https://github.com/BaseflowIT/flutter-contacts-plugin/issues) page.\n\n## Want to contribute\n\nIf you would like to contribute to the plugin (e.g. by improving the documentation, solving a bug or adding a cool new feature), please carefully review our [contribution guide](CONTRIBUTING.md) and send us your [pull request](https://github.com/BaseflowIT/flutter-contacts-plugin/pulls).\n\n## Author\n\nThis Contacts plugin for Flutter is developed by [Baseflow](https://baseflow.com). You can contact us at \u003chello@baseflow.com\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBaseflow%2Fflutter-contacts-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FBaseflow%2Fflutter-contacts-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBaseflow%2Fflutter-contacts-plugin/lists"}