TextHighlight class
TextHighlight will provide you a easy way to display highlighted words on your app
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- TextHighlight
Constructors
-
TextHighlight({required String text, required Map<
String, HighlightedWord> words, TextStyle? textStyle, TextAlign textAlign = TextAlign.start, TextDirection? textDirection, bool softWrap = true, TextOverflow overflow = TextOverflow.clip, double textScaleFactor = 1.0, int? maxLines, Locale? locale, StrutStyle? strutStyle, bool matchCase = false, HighlightBinding binding = HighlightBinding.all, PlaceholderAlignment spanAlignment = PlaceholderAlignment.middle, bool splitOnLongWord = false})
Properties
- binding → HighlightBinding
-
Change the occurrence of a highlight
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- locale → Locale?
-
final
- matchCase → bool
-
If it is true, it will highlight the exactly same match
final
- maxLines → int?
-
final
- overflow → TextOverflow
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- softWrap → bool
-
final
- spanAlignment → PlaceholderAlignment
-
Change the alignment of the text inside span
final
- splitOnLongWord → bool
-
Split the highlighted word to fit in the same line as the text
final
- strutStyle → StrutStyle?
-
final
- text → String
-
The text you want to show
final
- textAlign → TextAlign
-
final
- textDirection → TextDirection?
-
final
- textScaleFactor → double
-
final
- textStyle → TextStyle?
-
final
-
words
→ Map<
String, HighlightedWord> -
Map with the word you need to highlight
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
DiagnosticsNodeobjects 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