Flutter列表搜索功能插件list_search的使用

在Flutter中，list_search 是一个非常实用的插件，可以帮助你在列表中执行搜索操作。如果你不想在列表中进行搜索操作，可以通过设置 isFieldShow 的值为 false 来禁用搜索框。你还可以自定义搜索框的设计。

此外，你可以通过 searchEmptyWidget 变量来显示一个特定的 widget，当搜索的值在列表中未找到时会显示该 widget。默认情况下，它会显示一个居中的文本提示：“No Result”。

使用示例

以下是一个完整的示例代码，展示了如何使用 list_search 插件实现列表搜索功能。

示例代码

import 'package:flutter/material.dart';

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

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  // 模拟的数据列表
  List<String> dataList = [
    'Apple',
    'Banana',
    'Orange',
    'Grapes',
    'Mango',
    'Pineapple',
    'Strawberry',
    'Watermelon',
    'Kiwi',
    'Blueberry'
  ];

  // 当前搜索的关键字
  String searchKey = '';

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Padding(
        padding: const EdgeInsets.all(8.0),
        child: Column(
          children: [
            // 搜索框
            TextField(
              onChanged: (value) {
                setState(() {
                  searchKey = value;
                });
              },
              decoration: InputDecoration(
                labelText: 'Search',
                border: OutlineInputBorder(),
              ),
            ),
            const SizedBox(height: 10),
            // 列表搜索组件
            Expanded(
              child: ListView.builder(
                itemCount: dataList.where((element) {
                  // 如果搜索关键字为空，则显示所有数据
                  if (searchKey.isEmpty) {
                    return true;
                  }
                  // 否则根据关键字过滤数据
                  return element.toLowerCase().contains(searchKey.toLowerCase());
                }).length,
                itemBuilder: (context, index) {
                  // 获取过滤后的数据
                  final filteredData = dataList.where((element) {
                    if (searchKey.isEmpty) {
                      return true;
                    }
                    return element.toLowerCase().contains(searchKey.toLowerCase());
                  }).toList();

                  // 如果搜索结果为空，显示提示信息
                  if (filteredData.isEmpty && searchKey.isNotEmpty) {
                    return Center(
                      child: Text(
                        'No Result',
                        style: TextStyle(fontSize: 16, color: Colors.grey),
                      ),
                    );
                  }

                  // 显示搜索结果
                  return ListTile(
                    title: Text(filteredData[index]),
                  );
                },
              ),
            ),
          ],
        ),
      ),
    );
  }
}