SearchHighlightText class

This widget is used to highlight the search text in the text widget before using this widget you must use the SearchTextInheritedWidget to pass the search text to this widget, or you can pass the search text directly to this widget.

you can also provide the highlightStyle to customize the highlight style if you don't provide the highlightStyle the default style will be used, The default style is SearchTextInheritedWidget.maybeOf(context)?.highlightStyle ?? TextStyle(color: Colors.red,)

Example:

SearchTextInheritedWidget(
searchText: 'search text',
child: SearchHighlightText('text to highlight')
)

or

SearchHighlightText('text to highlight', searchText: 'search text')

you can also pass the search text as a RegExp:

SearchHighlightText(
'text to highlight',
searchRegExp: RegExp('search text with RegExp'), // you can use any RegExp here, like RegExp('[1-9]'), RegExp('search text with RegExp', caseSensitive: false), etc.
)
Inheritance

Constructors

SearchHighlightText(String text, {Key? key, String? searchText, RegExp? searchRegExp, TextStyle? style, int? maxLines, TextOverflow? overflow, TextAlign? textAlign, TextDirection? textDirection, bool? softWrap, double? textScaleFactor, Locale? locale, StrutStyle? strutStyle, TextWidthBasis? textWidthBasis, TextStyle? highlightStyle})
const

Properties

hashCode int
The hash code for this object.
no setterinherited
highlightStyle TextStyle?
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
locale Locale?
final
maxLines int?
final
overflow TextOverflow?
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
searchRegExp RegExp?
final
searchText String?
final
softWrap bool?
final
strutStyle StrutStyle?
final
style TextStyle?
final
text String
final
textAlign TextAlign?
final
textDirection TextDirection?
final
textScaleFactor double?
final
textWidthBasis TextWidthBasis?
final

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
override
createElement() StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
inherited
toStringShort() String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited