flutter_html_search_highlight 1.0.3

Search HTML content, wrap matches in <mark>, and page through results using flutter_html—with keyword normalization and scroll-to-match helpers.

Flutter HTML Search Highlight

🔥 Highlight and navigate search results inside HTML content in Flutter — with built-in UI and zero setup.

Search across HTML pages, highlight matches with <mark>, and give users smooth navigation (next/previous) without writing custom parsing logic.

---

🎬 Demo

Instantly search, highlight, and navigate across HTML content:

Single Page Search

Multi Page Search

✨ Features

• 🔍 Search plain text inside HTML content
• 🎯 Highlight matches using <mark> tags
• 📄 Supports multi-page HTML content
• ⏭️ Navigate between matches (next / previous)
• 📊 Match count per page
• 🧭 Scroll positioning for matches
• 🎨 Fully customizable UI (search bar, styles, icons)
• ⚡ Built on flutter_html + HTML parser

---

🚀 Quick Start

import 'package:flutter_html_search_highlight/flutter_html_search_highlight.dart';

HtmlPagedSearchReader(
  htmlContent: "<p>Hello Flutter world</p>",
)

That’s it. No extra setup needed.

---

📦 Installation

dependencies:
  flutter_html_search_highlight: ^0.1.0

---

💡 Why use this?

Instead of building everything manually on top of flutter_html, this package gives you:

• ✅ Built-in search UI
• ✅ Automatic highlighting
• ✅ Match navigation (next / previous)
• ✅ Multi-page support
• ✅ Scroll-to-match logic

All without writing complex parsing or state management.

---

🧩 When should I use this?

Use this package if you need:

• Search inside long HTML content
• Highlight keywords dynamically
• Navigate between search results
• Handle multi-page or paginated HTML

Perfect for:

• 📖 Reader apps
• 📄 Documentation viewers
• 📰 Article-based apps

🧠 Core API (Custom UI)

Use this if you want full control over UI.

final cleaned = pages.map(HtmlSearchHighlighter.cleanHtml).toList();

final result = HtmlSearchHighlighter.searchPages(cleaned, "week's");

// Access results
result.displayPages;
result.matches;
result.matchesPerPage;

Scroll alignment helper

final offset = HtmlSearchHighlighter.scrollOffsetForMatch(
  sourcePageHtml: cleaned[page],
  keyword: keyword,
  matchIndex: 0,
  maxScrollExtent: controller.position.maxScrollExtent,
);

---

📖 Built-in Paged Reader

Multi-page HTML

HtmlPagedSearchReader(
  htmlPages: const [
    '<p>First page mentions <b>Flutter</b>.</p>',
    '<p>Second page also talks about Flutter.</p>',
  ],
)

Single HTML content

HtmlPagedSearchReader(
  htmlContent: '<h1>One page</h1><p>Search me.</p>',
)

---

🔄 Content Modes

Force behavior explicitly:

HtmlPagedSearchReader(
  htmlPages: manySections,
  contentMode: HtmlContentMode.singlePage,
  singlePageSeparator: '<hr/>',
)

HtmlPagedSearchReader(
  htmlContent: myHtml,
  contentMode: HtmlContentMode.multiPage,
)

---

🎨 Customization

Highlight & styles

HtmlPagedSearchReader(
  htmlPages: myPages,
  highlightColor: Colors.orangeAccent,
  markStyle: Style(backgroundColor: Colors.lime),
  htmlStyles: {
    'h1': Style(fontSize: FontSize(22)),
  },
)

---

Customize search UI

HtmlPagedSearchReader(
  htmlPages: myPages,
  searchFieldBuilder: (context, controller, onChanged, keyword) {
    return TextField(
      controller: controller,
      onChanged: onChanged,
      decoration: const InputDecoration(hintText: 'Search...'),
    );
  },
)

---

Customize navigation UI

HtmlPagedSearchReader(
  htmlPages: myPages,
  matchNavigationBuilder: (
    context,
    currentMatch,
    totalMatches,
    onPrevious,
    onNext,
  ) {
    return Row(
      children: [
        Text('$currentMatch/$totalMatches'),
        IconButton(onPressed: onPrevious, icon: Icon(Icons.expand_less)),
        IconButton(onPressed: onNext, icon: Icon(Icons.expand_more)),
      ],
    );
  },
)

---

📁 Example

Check the /example folder for a complete working demo.

---

⚙️ Tips

• Call cleanHtml() once for better performance
• Set cleanPagesOnLoad: false if already cleaned
• Use pagination for large HTML content

---

🤝 Contributing

Contributions, issues, and feature requests are welcome!

---

📄 License

This package is licensed under the MIT License. See the LICENSE file for details.

---

⭐ Support

If this package helps you, consider giving it a ⭐ on GitHub and a 👍 on pub.dev.