Flutter联系人选择插件contact_selector的使用

Flutter联系人选择插件contact_selector的使用

Getting Started（开始使用）

本项目是一个新的Flutter插件项目。 通过此插件，一个Flutter应用可以请求用户从其通讯录中选择一个联系人。与该联系人相关的详细信息将返回给应用。

该插件使用操作系统原生UI来选择联系人，并且不需要用户授予任何特殊权限。

目前，该插件仅支持选择电话号码。但是，扩展插件以请求其他属性（如地址）或获取整个联系人的记录应该是比较简单的（欢迎提交PR）。

有关如何开始使用Flutter的信息，请参阅我们的在线文档，其中提供了教程、示例、移动开发指南以及完整的API引用。

Using the plugin（使用插件）

请按照在安装标签页上的说明进行操作。

然后，在你的Flutter应用中实例化ContactSelector，并调用selectContact方法以弹出用于选择联系人的界面。当用户做出选择后，该函数会返回选中的Contact对象（如果用户没有选择任何内容，则返回null）。

请查看example/lib/main.dart文件以获取实际使用的示例。

示例代码

import 'package:flutter/material.dart';
import 'dart:async';

import 'package:flutter/services.dart';
import 'package:contact_selector/contact_selector.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';
  final ContactSelector contactSelector = ContactSelector();
  late Contact? contact;

  [@override](/user/override)
  void initState() {
    super.initState();
    initPlatformState();
  }

  // 平台消息是异步的，因此我们在异步方法中初始化。
  Future<void> initPlatformState() async {
    String platformVersion;
    // 平台消息可能会失败，所以我们使用try/catch来处理PlatformException。
    // 我们还处理了消息可能返回null的情况。
    try {
      platformVersion =
          await ContactSelector.platformVersion ?? 'Unknown platform version';
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }

    // 如果在异步平台消息还在传输时，小部件被从树中移除，我们希望丢弃回复而不是调用setState来更新我们的非存在的外观。
    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('插件示例应用'),
        ),
        body: Center(
          child: Column(
            mainAxisSize: MainAxisSize.min,
            children: <Widget>[
              MaterialButton(
                color: Colors.blue,
                child: const Text("点击我"),
                onPressed: () async {
                  Contact? selectedContact = await contactSelector.selectContact();
                  setState(() {
                    contact = selectedContact;
                  });
                },
              ),
              Text(
                contact == null ? '未选择联系人。' : contact.toString(),
              ),
              Text("运行于: $_platformVersion"),
            ],
          ),
        ),
      ),
    );
  }
}

更多关于Flutter联系人选择插件contact_selector的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter联系人选择插件contact_selector的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然，以下是如何在Flutter应用中使用contact_selector插件来选择联系人的代码示例。这个插件允许用户从设备的联系人列表中选择一个或多个联系人。

首先，确保你的Flutter项目已经添加了contact_selector依赖。在pubspec.yaml文件中添加以下依赖：

dependencies:
  flutter:
    sdk: flutter
  contact_selector: ^latest_version  # 请替换为最新的版本号

然后运行flutter pub get来获取依赖。

接下来，在Flutter应用中实现联系人选择功能。以下是一个完整的示例代码：

import 'package:flutter/material.dart';
import 'package:contact_selector/contact_selector.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Contact Selector Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  List<Contact> _selectedContacts = [];

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Contact Selector Demo'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            ElevatedButton(
              onPressed: () async {
                final result = await ContactSelector.selectContacts(
                  context,
                  selectedContacts: _selectedContacts,
                  showPicker: true,
                  multiSelect: true,
                );

                if (result != null) {
                  setState(() {
                    _selectedContacts = result;
                  });
                }
              },
              child: Text('Select Contacts'),
            ),
            SizedBox(height: 20),
            Expanded(
              child: _selectedContacts.isEmpty
                  ? Center(child: Text('No contacts selected'))
                  : ListView.builder(
                      itemCount: _selectedContacts.length,
                      itemBuilder: (context, index) {
                        final contact = _selectedContacts[index];
                        return ListTile(
                          title: Text('${contact.displayName}'),
                          subtitle: Text('${contact.phones.isNotEmpty ? contact.phones.first.value : 'No phone number'}'),
                        );
                      },
                    ),
            ),
          ],
        ),
      ),
    );
  }
}

解释

  1. 依赖添加：在pubspec.yaml中添加contact_selector依赖。
  2. UI布局：创建一个简单的Flutter应用，包含一个按钮和一个显示选中联系人的列表。
  3. 按钮点击事件：当用户点击按钮时，调用ContactSelector.selectContacts方法，显示联系人选择器。
  4. 处理结果：用户选择联系人后，更新状态并显示选中的联系人信息。

注意事项

  • 确保在Android和iOS上分别配置好必要的权限（例如读取联系人权限）。
  • 根据需要调整ContactSelector.selectContacts方法的参数，例如是否多选、是否显示选择器界面等。

这个示例展示了如何在Flutter应用中使用contact_selector插件来选择联系人，并显示选中的联系人信息。你可以根据需要进一步扩展和定制功能。

回到顶部