Flutter文本高亮搜索插件search_highlight_text的使用

Flutter文本高亮搜索插件search_highlight_text的使用

这是一个简单的继承小部件，用于在搜索结果中高亮文本，支持自定义高亮颜色和高亮样式。

功能

• 在搜索结果中高亮文本，并支持自定义高亮颜色和高亮样式。
• 不直接解析搜索文本即可高亮文本。
• 支持将搜索文本作为正则表达式解析。

使用方法

// 使用 SearchTextInheritedWidget 包装需要高亮的文本
SearchTextInheritedWidget(
  searchText: '搜索文本',
  child: SearchHighlightText('需要高亮的文本'),
),

// 或者使用正则表达式
SearchTextInheritedWidget(
  // 可以使用任何正则表达式，例如 RegExp('[1-9]'), RegExp('搜索文本带正则', caseSensitive: false) 等
  searchRegExp: RegExp('搜索文本带正则'),
  child: SearchHighlightText('需要高亮的文本'),
),

也可以直接使用 SearchHighlightText，但需要提供 searchText 或 searchRegExp 参数。

SearchHighlightText(
  '需要高亮的文本',
  searchText: '搜索文本',
),

示例

完整的示例可以在 仓库 中查看。

搜索视图

// search_view.dart

class SearchView extends ConsumerWidget {
  const SearchView({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context, WidgetRef ref) {
    var controller = ref.watch(searchController);

    return GestureDetector(
      onTap: () {
        FocusManager.instance.primaryFocus?.unfocus(); // 移除焦点
      },
      child: Scaffold(
        backgroundColor: Colors.grey[100],
        appBar: AppBar(
          title: const Text('搜索电影示例'),
        ),
        body: Column(
          children: [
            const SizedBox(
              height: 10,
            ),
            SearchField(
              controller: controller,
            ),
            Expanded(
              child: controller.isLoading
                  ? const Center(
                      child: CircularProgressIndicator(), // 加载指示器
                    )
                  : SearchTextInheritedWidget(
                      searchText: controller.searchText, // 传递搜索文本到 widget 树，供 SearchHighlightText 使用
                      child: ListMoviesWidget(
                        listMovies: controller.movies,
                      ),
                    ),
            ),
          ],
        ),
      ),
    );
  }
}

电影卡片

// movie_card.dart

class MovieCard extends StatelessWidget {
  const MovieCard({Key? key, required this.movie}) : super(key: key);

  final MovieModel movie;

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Card(
      child: ListTile(
        title: SearchHighlightText( // 使用 SearchHighlightText 小部件高亮搜索文本（如果有）
          movie.title,
        ),
        subtitle: Text(movie.year),
        leading: SizedBox(
          width: 100,
          child: Image.network(
            movie.posterUrl,
            fit: BoxFit.cover,
            errorBuilder: (context, error, stackTrace) {
              return const Icon(Icons.error); // 错误占位符
            },
          ),
        ),
      ),
    );
  }
}

完整示例代码

// main.dart

import 'package:example/search/views/search_view.dart';
import 'package:flutter/material.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';

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

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return ProviderScope(
      child: MaterialApp(
        debugShowCheckedModeBanner: false,
        title: '搜索高亮文本示例',
        theme: ThemeData(
          primarySwatch: Colors.blue,
        ),
        home: const SearchView(),
      ),
    );
  }
}