SearchTextInheritedWidget class

Used to share search text between widgets in the widget tree using InheritedWidget pattern.

you can use this widget to pass the search text to the SearchHighlightText widget, without passing parameters to the SearchHighlightText widget directly.

Example:

SearchTextInheritedWidget(
 searchText: 'search text',
child: ... // your widgets
)

you can also pass the search text as a RegExp:

SearchTextInheritedWidget(
searchRegExp: RegExp('search text with RegExp'), // you can use any RegExp here, like RegExp('[1-9]'), RegExp('search text with RegExp', caseSensitive: false), etc.
child: ... // your widgets
)

then you can use the SearchHighlightText widget without passing the search text to it.

SearchHighlightText('text to highlight')
Inheritance

Constructors

SearchTextInheritedWidget({Key? key, String? searchText, RegExp? searchRegExp, TextStyle? highlightStyle, Color highlightColor = Colors.red, required Widget child})
const

Properties

child → Widget
The widget below this widget in the tree.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
highlightColor → Color
final
highlightStyle → TextStyle?
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
searchRegExp → RegExp
no setter

Methods

createElement() → InheritedElement
Inflates this configuration to a concrete instance.
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
updateShouldNotify(covariant SearchTextInheritedWidget oldWidget) → bool
Whether the framework should notify widgets that inherit from this widget.
override

Operators

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