Flutter搜索功能插件ruki_search的使用

特性

• ISearchable：确保实现ISearchable类。搜索页面允许对已实现此接口的任何模型进行搜索。
• 搜索按钮：可以使用SearchPage.SearchBarButton作为触发搜索页面的按钮，或者直接实现搜索页面。
• 懒加载和分页：支持懒加载和分页功能。
• 直接异步数据获取：在搜索时直接获取异步数据。

开始使用

1. 添加依赖：

   dart pub add ruki_search
   

2. 在你的模型上实现ISearchable接口。

使用示例

搜索页面示例

class Test implements ISearchable {
  String name;

  Test({required this.name});

  [@override](/user/override)
  Map<String, dynamic> data() {
    return {
      'name': name,
    };
  }

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

主页面示例

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> {

  Future<List<ISearchable>> _httpPunkApi({dynamic offset, limit = 5}) async {
    print("Fetching data: https://api.punkapi.com/v2/beers?page=${offset ?? 1}&per_page=${limit}");
    final response = await http.get(Uri.parse(
        'https://api.punkapi.com/v2/beers?page=${offset ?? 1}&per_page=${limit}'));
    print(response.statusCode);
    if (response.statusCode == 200) {
      final decoded = jsonDecode(response.body);
      final List<Beer> beers = (decoded as List).map((e) {
        return Beer.fromJson(e);
      }).toList();
      return beers;
    } else {
      throw Exception('Failed to load beers');
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: DefaultTabController(
        length: 3,
        child: Column(
          mainAxisAlignment: MainAxisAlignment.start,
          children: [
            const TabBar(
              tabs: [
                Tab(icon: Text("Search Page")),
                Tab(icon: Text("Search Page Lazy")),
              ],
            ),
            Expanded(
              child: TabBarView(
                children: [
                  Align(
                    alignment: Alignment.topCenter,
                    child: Padding(
                      child: _buildSearchByPage(),
                      padding: const EdgeInsets.all(12.0),
                    ),
                  ),
                  Align(
                    alignment: Alignment.topCenter,
                    child: Padding(
                      child: _buildSearchpageWithPagination(),
                      padding: const EdgeInsets.all(12.0),
                    ),
                  )
                ],
              ),
            ),
          ],
        ),
      ),
    );
  }

  _buildSearchpageWithPagination() {
    return SearchPage.searchBarButton(context,
        placeholder: "Search by name",
        enableLazyLoading: true,
        paginateByPageNumber: true,
        enableLoadMoreScroll: false,
        liveSearch: true,
        showExit: false, 
        lazyRequest: (query, page) {
      return _httpPunkApi(offset: page, limit: 5);
    }, 
    resultBuilder: (result) {
      final modelData = result as Beer;
      return Container(
        child: ListTile(
          leading: const Icon(Icons.wine_bar_rounded),
          title: Text(modelData.name ?? ""),
        ),
      );
    });
  }

  _buildSearchByPage() {
    return SearchPage.searchBarButton(context,
        placeholder: "Search by name",
        enableLazyLoading: false,
        showExit: false, 
        request: (query) {
      return Future.value([
        Test(name: "Ruki"),
        Test(name: "Ruki2"),
        Test(name: "Ruki3"),
        Test(name: "Ruki4"),
        Test(name: "Ruki5"),
        Test(name: "Ruki6")
      ]
          .where((element) =>
              element.name.toLowerCase().contains(query.toLowerCase()))
          .toList());
    }, 
    resultBuilder: (result) {
      final modelData = result as Test;
      return Container(
        color: Colors.red,
        child: ListTile(
          title: Text(modelData.name),
        ),
      );
    });
  }
}