CustomText class

A text widget that decorates strings in it and enables tap, long-press and/or hover gestures based on flexible definitions.

This widget is useful for making partial strings in text such as URLs, email addresses or phone numbers clickable, or for only highlighting some parts of text with colors and different font settings depending on the types of text elements.

Inheritance

Constructors

CustomText(String text, {Key? key, required List<Definition> definitions, ParserOptions parserOptions = const ParserOptions(), TextStyle? style, TextStyle? matchStyle, TextStyle? tapStyle, TextStyle? hoverStyle, void onTap(GestureDetails)?, void onLongPress(GestureDetails)?, void onGesture(GestureDetails)?, Duration? longPressDuration, bool preventBlocking = false, StrutStyle? strutStyle, TextAlign? textAlign, TextDirection? textDirection, Locale? locale, bool? softWrap, TextOverflow? overflow, double? textScaleFactor, int? maxLines, String? semanticsLabel, TextWidthBasis? textWidthBasis, TextHeightBehavior? textHeightBehavior})
Creates a text widget that decorates strings and enables tap, long-press and/or hover gestures based on flexible definitions.
const

Properties

definitions → List<Definition>
Definitions that specify rules for parsing, appearance and actions.
final
hashCode → int
The hash code for this object.
read-onlyinherited
hoverStyle → TextStyle?
The default text style used for matched strings while they are under the mouse pointer.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
locale → Locale?
final
longPressDuration → Duration?
The duration before a tap is regarded as a long-press and the onLongPress function is called.
final
matchStyle → TextStyle?
The default text style for matched strings.
final
maxLines → int?
final
onGesture → (void Function(GestureDetails)?)
The callback function called when a gesture happens on a text element.
final
onLongPress → (void Function(GestureDetails)?)
The callback function called when a tappable element is long-pressed.
final
onTap → (void Function(GestureDetails)?)
The callback function called when a tappable element is tapped.
final
overflow → TextOverflow?
final
parserOptions → ParserOptions
The options for RegExp that configure how regular expressions are treated.
final
preventBlocking → bool
Parsing is executed in an isolate to prevent blocking of the UI if set to true, except on the web where isolates are not supported.
final
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited
semanticsLabel → String?
final
softWrap → bool?
final
strutStyle → StrutStyle?
final
style → TextStyle?
The text style for strings that did not match any match patterns.
final
tapStyle → TextStyle?
The default text style used for tappable strings while they are being pressed.
final
text → String
The text to parse and display.
final
textAlign → TextAlign?
final
textDirection → TextDirection?
final
textHeightBehavior → TextHeightBehavior?
final
textScaleFactor → double?
final
textWidthBasis → TextWidthBasis?
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<CustomText>
Creates the mutable state for this widget at a given location in the tree.
override
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