build method

@override Widget build(BuildContext context)

Describes the part of the user interface represented by this widget.

The framework calls this method when this widget is inserted into the tree in a given BuildContext and when the dependencies of this widget change (e.g., an InheritedWidget referenced by this widget changes). This method can potentially be called in every frame and should not have any side effects beyond building a widget.

The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing subtree, as determined by calling Widget.canUpdate.

Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and from the given BuildContext.

The given BuildContext contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A given widget might be built with multiple different BuildContext arguments over time if the widget is moved around the tree or if the widget is inserted into the tree in multiple places at once.

The implementation of this method must only depend on:

• the fields of the widget, which themselves must not change over time, and
• any ambient state obtained from the context using BuildContext.dependOnInheritedWidgetOfExactType.

If a widget's build method is to depend on anything else, use a StatefulWidget instead.

See also:

• StatelessWidget, which contains the discussion on performance considerations.

Implementation

@override
Widget build(BuildContext context) {
  final String textLC = caseSensitive ? text : text.toLowerCase();

  // Combine term and terms
  final List<String> termList = [term ?? '', ...(terms ?? [])];

  // Remove empty search terms and apply case sensitivity
  final List<String> termListLC = termList
      .where((s) => s.isNotEmpty)
      .map((s) => caseSensitive ? s : s.toLowerCase())
      .toList();

  List<InlineSpan> children = [];

  // Find the first occurrence of any term
  int? firstOccurrence;
  String? matchedTerm;

  for (String searchTerm in termListLC) {
    int index = textLC.indexOf(searchTerm);
    if (index >= 0) {
      if (words) {
        bool isValidWord = true;

        // Check preceding character
        if (index > 0 && !wordDelimiters.contains(textLC[index - 1])) {
          isValidWord = false;
        }

        // Check following character
        int followingIdx = index + searchTerm.length;
        if (followingIdx < textLC.length &&
            !wordDelimiters.contains(textLC[followingIdx])) {
          isValidWord = false;
        }

        if (!isValidWord) continue;
      }

      if (firstOccurrence == null || index < firstOccurrence) {
        firstOccurrence = index;
        matchedTerm = searchTerm;
      }
    }
  }

  if (firstOccurrence != null && matchedTerm != null) {
    // Add text before the match
    if (firstOccurrence > 0) {
      children.add(TextSpan(
          text: text.substring(0, firstOccurrence), style: textStyle));
    }

    // Add the highlighted match
    children.add(TextSpan(
        text: text.substring(
            firstOccurrence, firstOccurrence + matchedTerm.length),
        style: textStyleHighlight));

    // Add remaining text
    if (firstOccurrence + matchedTerm.length < text.length) {
      children.add(TextSpan(
          text: text.substring(firstOccurrence + matchedTerm.length),
          style: textStyle));
    }
  } else {
    // No match found, return the entire text unhighlighted
    children.add(TextSpan(text: text, style: textStyle));
  }

  return Text.rich(TextSpan(children: children),
      maxLines: maxLines,
      overflow: overflow,
      textAlign: textAlign,
      textScaler: MediaQuery.of(context).textScaler);
}