HighlightText class

A widget that displays text with a highlighted section.

This widget provides an easy way to display a piece of text with highlighted sections. The highlight is based on the string provided to the highlight parameter.

Inheritance

Constructors

HighlightText({Key? key, required String text, String? highlight, TextStyle? style, Color? highlightColor = const Color.fromRGBO(255, 255, 0, 0.3), TextStyle? highlightStyle, bool ignoreCase = false, bool selectable = true, int? maxLines, TextOverflow? overflow, bool? softWrap})
Creates a HighlightText widget.
const

Properties

hashCode → int
The hash code for this object.
no setterinherited
highlight → String?
The text to be highlighted.
final
highlightColor → Color?
The background color of the highlighted text.
final
highlightStyle → TextStyle?
The style for the highlighted text. If not provided, highlightColor will be used.
final
ignoreCase → bool
Determines if the text matching should be case insensitive.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
maxLines → int?
final
overflow → TextOverflow?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectable → bool
Whether the text can be selected or not.
final
softWrap → bool?
final
style → TextStyle?
The base style for the text.
final
text → String
The text to display.
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, int wrapWidth = 65}) → 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