Flutter电话号码输入增强插件extended_phone_number_input的使用

extended_phone_number_input 是一个高度可定制的Flutter小部件，用于电话号码输入。它支持国际验证、国家代码选择、联系人选择等功能。

Features

• 支持国际电话号码验证
• 可以仅包含特定国家/地区
• 可以排除特定国家/地区
• 使用控制器设置电话号码（所选国家将自动更新）
• 从联系人列表中选择电话号码

Getting Started

要开始使用 extended_phone_number_input 插件，请确保你已经安装了该插件：

flutter pub add extended_phone_number_input

如果你的目标是Android 11+ (API 30+) 并且想要使用内置的联系人选择器，你需要在 AndroidManifest.xml 中添加 android.permission.READ_CONTACTS 权限，因为此权限会自动请求。

Usage

下面是一些使用示例和配置方法。

Simple Usage

最简单的用法如下：

PhoneNumberInput(initialCountry: 'SA', locale: 'ar')

Show Countries as Dialog

默认情况下，国家列表是以底部弹出窗口显示的。如果你想改为对话框模式，可以这样做：

const PhoneNumberInput(
    initialCountry: 'US',
    locale: 'en',
    countryListMode: CountryListMode.dialog,
    contactsPickerPosition: ContactsPickerPosition.suffix,
)

Custom Borders

你可以自定义输入框的边框样式：

PhoneNumberInput(
    initialCountry: 'TN',
    locale: 'fr',
    countryListMode: CountryListMode.dialog,
    contactsPickerPosition: ContactsPickerPosition.suffix,
    enabledBorder: OutlineInputBorder(
        borderRadius: BorderRadius.circular(10),
        borderSide: const BorderSide(color: Colors.purple)),
    focusedBorder: OutlineInputBorder(
        borderRadius: BorderRadius.circular(10),
        borderSide: const BorderSide(color: Colors.purple))
)

Select Phone Number Programmatically

为了能够编程方式选择电话号码，首先需要定义一个 PhoneInputController：

PhoneInputController _controller = PhoneInputController(context);

PhoneNumberInput(
    controller: _controller,
    // ...其他配置项
)

// 设置电话号码
_controller.phoneNumber = '+1-....'

注意：如果你想要从联系人中设置电话号码，该插件已经内置了这个功能，无需使用控制器。

完整示例 Demo

以下是一个完整的演示代码，展示了如何在Flutter应用中集成并使用 extended_phone_number_input：

import 'package:extended_phone_number_input/consts/enums.dart';
import 'package:extended_phone_number_input/phone_number_controller.dart';
import 'package:extended_phone_number_input/phone_number_input.dart';
import 'package:flutter/material.dart';

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

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Phone Number Input'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);
  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: SingleChildScrollView(
        child: Padding(
          padding: const EdgeInsets.symmetric(horizontal: 10),
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              const SizedBox(height: 20),
              const Text('Bottom Sheet Mode'),
              const PhoneNumberInput(
                initialCountry: 'SA',
                locale: 'it',
                countryListMode: CountryListMode.bottomSheet,
                contactsPickerPosition: ContactsPickerPosition.suffix,
              ),
              const SizedBox(height: 50),
              const Text('Dialog Mode'),
              const PhoneNumberInput(
                initialCountry: 'SA',
                locale: 'it',
                countryListMode: CountryListMode.dialog,
                contactsPickerPosition: ContactsPickerPosition.suffix,
              ),
              const SizedBox(height: 50),
              const Text('Custom Border & Controller'),
              PhoneNumberInput(
                initialCountry: 'TN',
                locale: 'ar',
                controller: PhoneNumberInputController(context),
                countryListMode: CountryListMode.dialog,
                contactsPickerPosition: ContactsPickerPosition.suffix,
                enabledBorder: OutlineInputBorder(
                    borderRadius: BorderRadius.circular(10),
                    borderSide: const BorderSide(color: Colors.purple)),
                focusedBorder: OutlineInputBorder(
                    borderRadius: BorderRadius.circular(10),
                    borderSide: const BorderSide(color: Colors.purple)),
                errorText: 'error',
              ),
              const SizedBox(height: 50),
              const Text('Bottom Picker Widget with Custom Widget'),
              const PhoneNumberInput(
                initialCountry: 'YE',
                locale: 'it',
                countryListMode: CountryListMode.dialog,
                contactsPickerPosition: ContactsPickerPosition.bottom,
                pickContactIcon: Card(
                  color: Colors.blueGrey,
                  child: Padding(
                    padding: EdgeInsets.all(10.0),
                    child: Text(
                      'Select from contacts',
                      style: TextStyle(color: Colors.white),
                    ),
                  ),
                ),
              ),
              const SizedBox(height: 50),
              const Text('Custom Picker Icon, No Flag, Hint'),
              const PhoneNumberInput(
                locale: 'it',
                countryListMode: CountryListMode.bottomSheet,
                contactsPickerPosition: ContactsPickerPosition.suffix,
                pickContactIcon: Icon(Icons.add),
                showSelectedFlag: false,
                hint: 'XXXXXXXXXXX',
              ),
            ],
          ),
        ),
      ),
    );
  }
}

通过上述代码，您可以体验到 extended_phone_number_input 的各种特性，并根据需求进行调整。希望这些信息对您有所帮助！如果有任何问题或需要进一步的帮助，请随时提问。