textContaining method Null safety

Finder textContaining(
  1. Pattern pattern,
  2. {bool findRichText = false,
  3. bool skipOffstage = true}
)

Finds Text and EditableText, and optionally RichText widgets which contain the given pattern argument.

If findRichText is false, all standalone RichText widgets are ignored and pattern is matched with Text.data or Text.textSpan. If findRichText is true, RichText widgets (and therefore also Text and Text.rich widgets) are matched by comparing the InlineSpan.toPlainText with the given pattern.

For EditableText widgets, the pattern is always compared to the currentt value of the EditableText.controller.

If the skipOffstage argument is true (the default), then this skips nodes that are Offstage or that are from inactive Routes.

Sample code

expect(find.textContain('Back'), findsOneWidget);
expect(find.textContain(RegExp(r'(\w+)')), findsOneWidget);

This will match Text, Text.rich, and EditableText widgets that contain the given pattern : 'Back' or RegExp(r'(\w+)').

expect(find.textContain('Close', findRichText: true), findsOneWidget);
expect(find.textContain(RegExp(r'(\w+)'), findRichText: true), findsOneWidget);

This will match Text, Text.rich, EditableText, as well as standalone RichText widgets that contain the given pattern : 'Close' or RegExp(r'(\w+)').

Implementation

Finder textContaining(
  Pattern pattern, {
  bool findRichText = false,
  bool skipOffstage = true,
}) {
  return _TextContainingFinder(
    pattern,
    findRichText: findRichText,
    skipOffstage: skipOffstage
  );
}