Flutter搜索覆盖层插件overlay_search的使用

Flutter搜索覆盖层插件overlay_search的使用

在这个包中,你可以轻松地在网页上执行搜索操作,即使该页面上没有预先存在的列表。你还可以使用这个包将一个列表显示在现有组件之上。

示例

移动端视图

显示移动设备上的覆盖层

网页视图

显示网页上的覆盖层

使用方法

SearchWithList(
  overlaySearchController: widget.overlayController,
  list: list
      .map(
        (e) => OverlayItemModel(
          title: e.symbol ?? "name",
          content: e.name,
          id: e.id,
        ),
      )
      .toList(),
  isLoading: isLoading,
  hintStyle: Theme.of(context).textTheme.bodyMedium,
  overlayBackgroundColor: Colors.black,
  hint: "Search Stock",
  suffixAction: () {
    widget.overlayController.hideOverlay();
    widget.overlayController.clearSearchQuery();
  },
  notFoundText: "Stock Not Found",
  onItemSelected: (item) {
    print(item.title);
  },
  enableDebounce: true,
  debounceDuration: const Duration(milliseconds: 2200),
  onChanged: (p0) {
    print(p0);
    _fetchSearchWithKey(p0);
  },
  onTap: () {
    _fetchSearch();
  },
)

完整示例代码

import 'package:example/data_repository.dart';
import 'package:example/model/item.dart';
import 'package:flutter/material.dart';
import 'package:overlay_search/overlay_search.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.dark(
        // colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: HomeView(),
    );
  }
}

class HomeView extends StatelessWidget {
  HomeView({super.key});
  final OverlaySearchController overlayController = OverlaySearchController();

  [@override](/user/override)
  Widget build(BuildContext context) {
    return GestureDetector(
      onTap: () {
        overlayController.hideOverlay();
      },
      child: Scaffold(
        backgroundColor: const Color(0xff1F1F26),
        body: SafeArea(
          child: Padding(
            padding: const EdgeInsets.all(16),
            child: Column(
              children: [
                const Center(
                  child: Text('Home View'),
                ),
                const SizedBox(height: 16),
                HomeSearch(overlayController: overlayController),
                Expanded(
                    child: FlutterLogo(size: MediaQuery.of(context).size.width))
              ],
            ),
          ),
        ),
      ),
    );
  }
}

class HomeSearch extends StatefulWidget {
  const HomeSearch({super.key, required this.overlayController});
  final OverlaySearchController overlayController;
  [@override](/user/override)
  State<HomeSearch> createState() => _HomeSearchState();
}

class _HomeSearchState extends State<HomeSearch> {
  bool? isLoading = false;

  List<Item> list = [];

  [@override](/user/override)
  Widget build(BuildContext context) {
    return SearchWithList(
      overlaySearchController: widget.overlayController,
      list: list
          .map(
            (e) => OverlayItemModel(
              title: e.symbol ?? "name",
              content: e.name,
              id: e.id,
            ),
          )
          .toList(),
      isLoading: isLoading,
      hintStyle: Theme.of(context).textTheme.bodyMedium,
      overlayBackgroundColor: Colors.black,
      hint: "Search Stock",
      focusedHint: "focusedHint",
      suffixAction: () {
        widget.overlayController.hideOverlay();
        widget.overlayController.clearSearchQuery();
      },
      notFoundText: "Stock Not Found",
      onItemSelected: (item) {
        print(item.title);
      },
      enableDebounce: true,
      debounceDuration: const Duration(milliseconds: 2200),
      onChanged: (p0) {
        print(p0);
        _fetchSearchWithKey(p0);
      },
      onTap: () {
        _fetchSearch();
      },
    );
  }

  setLoading(bool value) {
    setState(() {
      isLoading = value;
    });
  }

  _fetchSearch() async {
    if (list.isNotEmpty) return;
    try {
      setLoading(true);

      list = await DataRepository.fetchList();
      setLoading(false);
    } catch (e) {
      setLoading(false);
    }
  }

  _fetchSearchWithKey(String value) {}
}

更多关于Flutter搜索覆盖层插件overlay_search的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter搜索覆盖层插件overlay_search的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然,以下是一个关于如何在Flutter中使用overlay_search插件来创建搜索覆盖层的示例代码。overlay_search插件允许你在应用中实现一个覆盖在当前页面上的搜索功能,非常适合需要在应用内快速搜索内容的场景。

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

dependencies:
  flutter:
    sdk: flutter
  overlay_search: ^latest_version  # 替换为实际的最新版本号

然后运行flutter pub get来安装依赖。

接下来是一个简单的示例,展示如何使用overlay_search插件:

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

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

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

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

class _MyHomePageState extends State<MyHomePage> {
  // 示例数据
  final List<String> items = List.generate(100, (index) => "Item ${index + 1}");

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Overlay Search Example'),
      ),
      body: OverlaySearch(
        overlaySearchKey: GlobalKey<OverlaySearchState>(),
        overlayColumn: OverlayColumn.appBar,
        resultsList: items,
        searchController: TextEditingController(),
        searchField: 'Search...',
        onQueryChange: (query) {
          // 过滤数据
          return items.where((item) => item.toLowerCase().contains(query.toLowerCase())).toList();
        },
        onSearchOpened: () {
          print('Search opened');
        },
        onSearchClosed: () {
          print('Search closed');
        },
        overlayBuilder: (context, controller) {
          return OverlaySearchWidget(
            controller: controller,
            results: controller.results,
            onResultClick: (index) {
              // 处理点击结果
              print('Clicked on ${controller.results[index]}');
              controller.closeOverlaySearch();
            },
          );
        },
        child: ListView.builder(
          itemCount: items.length,
          itemBuilder: (context, index) {
            return ListTile(
              title: Text(items[index]),
            );
          },
        ),
      ),
    );
  }
}

代码说明:

  1. 依赖导入:确保在pubspec.yaml中添加了overlay_search依赖。

  2. MyApp:基本的Flutter应用结构,设置了主题和主页。

  3. MyHomePage:包含了一个ListView来显示示例数据。

  4. OverlaySearch

    • overlaySearchKey:用于控制OverlaySearch的状态。
    • overlayColumn:指定覆盖层的位置,这里使用OverlayColumn.appBar,表示覆盖层将覆盖在AppBar下方。
    • resultsList:要搜索的数据列表。
    • searchControllerTextEditingController用于控制搜索框的文本。
    • searchField:搜索框的提示文本。
    • onQueryChange:当查询变化时的回调函数,用于过滤数据。
    • onSearchOpenedonSearchClosed:分别在搜索打开和关闭时调用。
    • overlayBuilder:用于构建覆盖层的UI。
  5. OverlaySearchWidget:用于显示搜索结果和点击事件处理。

  6. ListView.builder:用于显示原始数据列表。

这个示例展示了如何使用overlay_search插件来实现一个简单的搜索覆盖层。你可以根据需求进一步自定义和扩展这个示例。

回到顶部