Flutter输入选择芯片插件choose_input_chips的使用

Flutter输入选择芯片插件choose_input_chips的使用

简介

choose_input_chips 是一个Flutter库，用于构建具有多个值的表单字段，并以输入芯片的形式展示这些值。它的外观类似于一个文本框，用户可以在其中输入文本以填充覆盖层中的建议项，供用户选择匹配的项目。该插件最初由Danvick Miller创建，名为flutter_chips_input，并在许多贡献者的帮助下进行了增强。

使用方法

安装

在你的pubspec.yaml文件中添加以下依赖项，然后运行flutter pub get：

dependencies:
  choose_input_chips: ^1.1.3

导入

在你的Dart文件中导入choose_input_chips库：

import 'package:choose_input_chips/choose_input_chips.dart';

示例代码

以下是一个完整的示例代码，展示了如何使用choose_input_chips插件来创建一个带有输入芯片的表单字段。

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

void main() => runApp(const MyApp());

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'ChipsInput Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(),
    );
  }
}

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

  [@override](/user/override)
  MyHomePageState createState() => MyHomePageState();
}

class MyHomePageState extends State<MyHomePage> {
  final _chipKey = GlobalKey<ChipsInputState>();

  [@override](/user/override)
  Widget build(BuildContext context) {
    // 模拟数据
    const mockResults = <AppProfile>[
      AppProfile('Charlie', 'charlie@flutter.io', 'man-1.png'),
      AppProfile('Diana', 'diana@flutter.io', 'woman-1.png'),
      AppProfile('Fred', 'fred@flutter.io', 'man-2.png'),
      AppProfile('Gina', 'gina@flutter.io', 'woman-2.png'),
      AppProfile('John', 'john@flutter.io', 'man-3.png'),
      AppProfile('Marie', 'marie@flutter.io', 'woman-3.png'),
      AppProfile('Pauline', 'pauline@flutter.io', 'woman-4.png'),
      AppProfile('Susan', 'susan@flutter.io', 'woman-5.png'),
      AppProfile('Thomas', 'thomas@flutter.io', 'man-4.png'),
    ];

    return Scaffold(
      appBar: AppBar(title: const Text('ChipsInput Example')),
      body: Padding(
        padding: const EdgeInsets.all(20),
        child: SingleChildScrollView(
          child: Column(
            children: <Widget>[
              const Padding(
                padding: EdgeInsets.all(8.0),
                child: Text('Start typing a name below:'),
              ),
              // ChipsInput widget
              ChipsInput(
                key: _chipKey,
                initialValue: const [
                  AppProfile('John', 'john@flutter.io', 'man-3.png')
                ],
                allowChipEditing: true,
                textStyle: const TextStyle(
                  height: 1.5,
                  fontFamily: 'Roboto',
                  fontSize: 16,
                ),
                decoration: const InputDecoration(
                  labelText: 'Select People',
                ),
                findSuggestions: (String query) {
                  if (query.isNotEmpty) {
                    var lowercaseQuery = query.toLowerCase();
                    return mockResults.where((profile) {
                      return profile.name
                              .toLowerCase()
                              .contains(query.toLowerCase()) ||
                          profile.email
                              .toLowerCase()
                              .contains(query.toLowerCase());
                    }).toList(growable: false)
                      ..sort((a, b) => a.name
                          .toLowerCase()
                          .indexOf(lowercaseQuery)
                          .compareTo(
                              b.name.toLowerCase().indexOf(lowercaseQuery)));
                  }
                  return mockResults;
                },
                onChanged: (data) {
                  // this is a good place to update application state
                },
                chipBuilder: (context, state, dynamic profile) {
                  return InputChip(
                    key: ObjectKey(profile),
                    label: Text(profile.name),
                    avatar: CircleAvatar(
                      backgroundImage:
                          AssetImage('assets/avatars/${profile.imageName}'),
                    ),
                    onDeleted: () => state.deleteChip(profile),
                    materialTapTargetSize: MaterialTapTargetSize.shrinkWrap,
                  );
                },
                suggestionBuilder: (context, state, dynamic profile) {
                  return ListTile(
                    key: ObjectKey(profile),
                    leading: CircleAvatar(
                      backgroundImage:
                          AssetImage('assets/avatars/${profile.imageName}'),
                    ),
                    title: Text(profile.name),
                    subtitle: Text(profile.email),
                    onTap: () => state.selectSuggestion(profile),
                  );
                },
              ),
              const Padding(
                padding: EdgeInsets.all(8.0),
                child: Text('Click the button to add a specific chip'),
              ),
              ElevatedButton(
                onPressed: () {
                  _chipKey.currentState!.selectSuggestion(const AppProfile(
                      'Gina', 'gina@flutter.io', 'woman-3.png'));
                },
                child: const Text('Add Chip'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}

// 定义AppProfile类
class AppProfile {
  final String name;
  final String email;
  final String imageName;

  const AppProfile(this.name, this.email, this.imageName);

  [@override](/user/override)
  bool operator ==(Object other) =>
      identical(this, other) ||
      other is AppProfile &&
          runtimeType == other.runtimeType &&
          name == other.name;

  [@override](/user/override)
  int get hashCode => name.hashCode;

  [@override](/user/override)
  String toString() {
    return name;
  }
}