
# Search in a Flutter app

In a Flutter app the `SearchService` is a bean like any other: a widget gets it, searches at every keystroke, and shows the hits with their matches highlighted. With the navigation starter, a hit's link opens its screen and the app's language picks the index; a shortcut opens the search from anywhere. The search of the site you are reading is built this way.

## Why

The index is in memory and built once, so a search answers within a frame or two, offline, in a browser as on a phone. The Flutter starter already has the parts around it: `HighlightedText` for the matches, `ThemeText` for results that change the theme's way, shortcuts in the configuration.

## Example

```yaml
# lib/resources/application.yml
spring:
  search:
    collapse-by: page
    markdown:
      - location: resources:content/docs/**/*.md
        exclude: ['**/contents*.md']
        link: /docs/{path}
  flutter:
    shortcuts:
      search.open: [primary+k, slash]
```

```dart
// The results of the query, as the user types.
class SearchPanel extends StatefulWidget {
  const SearchPanel({super.key});

  @override
  State<SearchPanel> createState() => _SearchPanelState();
}

class _SearchPanelState extends State<SearchPanel> {
  var _hits = <SearchHit>[];

  Future<void> _search(String query) async {
    final route = context.route;
    final hits = await context.bean<SearchService>().search(
      query,
      language: route.language,      // the address's language, with the navigation
    );
    if (mounted) setState(() => _hits = hits);
  }

  @override
  Widget build(BuildContext context) => Column(
    children: [
      TextField(autofocus: true, onChanged: _search),
      for (final hit in _hits) _Result(hit),
    ],
  );
}

class _Result extends StatelessWidget {
  const _Result(this.hit);

  final SearchHit hit;

  @override
  Widget build(BuildContext context) {
    final snippet = hit.snippet('body', length: 140);
    return GestureDetector(
      onTap: () => context.route.go(hit.document.link!),
      child: Column(
        crossAxisAlignment: CrossAxisAlignment.start,
        children: [
          Text(hit.document.fields['heading'] ?? hit.document.title),
          HighlightedText(
            snippet.text,
            highlights: [
              for (final r in snippet.ranges) TextRange(start: r.start, end: r.end),
            ],
            highlightStyle: TextStyle(color: SpringTheme.of(context).colorScheme.primary),
            maxLines: 2,
          ),
        ],
      ),
    );
  }
}
```

```dart
// ⌘K, Ctrl+K or / opens the search from any screen.
@Component()
class SearchActions {
  @Shortcut('search.open')
  Future<void> open(BuildContext context) => showSearchPanel(context);
}
```

## Notes

- **Languages.** With `spring.flutter.navigation.languages`, `context.route.language` is the address's language, and `name.ja.md` files are searched in Japanese. Without the navigation, pass the app's locale (`Localizations.localeOf(context).languageCode`).
- **As you type.** The last word is a prefix until a space follows it, so `bea` already finds `bean`. A search per keystroke is cheap; the first one builds the index.
- **Highlights.** `hit.highlights['title']` and the snippet's `ranges` become `TextRange`s for `HighlightedText`, or for `ThemeText(highlights:, changeKey: query)`, which plays the theme's text change when the results change.
- **The first search on the web** reads the index the build wrote for `spring.search.markdown`: one file per language, a Flutter asset, decoded in a fraction of a second ([The index the build writes](searching.md#the-index-the-build-writes)). List `lib/resources/spring_gen/search/` under `flutter: assets:`. Call `prepare(language: ...)` when the search opens, or a little after the splash, so the file is there before the first keystroke.
- **Fonts on the web.** Japanese or Chinese results need Flutter's downloaded fonts; the [font warm-up](../spring-boot-starter-flutter/splash.md) of the Flutter starter fetches them behind the splash.

## See also

- [Searching](searching.md)
- [Keyboard shortcuts](../spring-boot-starter-flutter/shortcuts.md)
- [Languages of the navigation](../spring-boot-starter-flutter-navigation/languages.md)
