Interact with native OS contact pickers using Flutter
Note: This plugin requires at least Kotlin 1.5.0 to compile. See (#38 (comment) for more information)
Web demo: https://fcp.mik.wtf/
Grab contact.
final PhoneContact contact =
await FlutterContactPicker.pickPhoneContact();
For more info read the docs or take a look at the example
If you target Android 11+ (API 30+) you need to obtain the android.permission.READ_CONTACTS
permission, which is declared as a library permission here this permission will be requested automatically if the askForPermission
parameter is true.
Alternatively you can request the permission manually with FlutterContactPicker.requestPermission() or check with FlutterContactPicker.hasPermission()
Note: Unlike Android iOS does not offer a way to directly get a full contact from the ContactPicker therefore this library does not support it. Apple might add it in 2030 so stay tuned
final FullContact contact =
await FlutterContactPicker.pickFullContact();
The FullContact class has a photo
property if the picked contact has an avatar. You can use the asWidget()
method to get a renderable Image
widget.
Full documentation: https://pub.dev/documentation/fluttercontactpicker/latest/fluttercontactpicker/fluttercontactpicker-library.html
This plugin also supports the Web Contact Picker API.