FlexibleText class

A widget that allows mixing rich text and widgets within a single text block.

The FlexibleText widget allows you to use placeholders in a text string to insert rich text segments or widgets. The text is split based on the richTextSeparator and widgetSeparator characters, which default to # and ~ respectively.

Example:

FlexibleText(
  text: 'Hello #World#~1~',
  style: TextStyle(color: Colors.black),
  richStyles: [TextStyle(color: Colors.red)],
  widgets: [Icon(Icons.star)],
);

In this example, #World# will be styled with TextStyle(color: Colors.red), and ~1~ will be replaced by an Icon(Icons.star).

Inheritance

Constructors

FlexibleText.new({Key? key, required String text, TextStyle? style, List<TextStyle?>? richStyles, List<GestureRecognizer?>? textRecognizers, TextAlign? textAlign, TextOverflow? overflow, List<Widget> widgets = const [], Map<String, Widget> namedWidgets = const {}, PlaceholderAlignment widgetAlignment = PlaceholderAlignment.middle, String richTextSeparator = '#', String widgetSeparator = '~'})
Creates a FlexibleText widget.
const

Properties

hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
namedWidgets → Map<String, Widget>
The map of named widgets to be inserted into the text.
final
overflow → TextOverflow?
How visual overflow should be handled.
final
richStyles → List<TextStyle?>?
A list of styles to be applied to rich text segments.
final
richTextSeparator → String
The character used to separate rich text segments.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
style → TextStyle?
The default text style to be applied to the text.
final
text → String
The text to be displayed, containing placeholders for rich text and widgets.
final
textAlign → TextAlign?
How the text should be aligned horizontally.
final
textRecognizers → List<GestureRecognizer?>?
A list of gesture recognizers for rich text segments.
final
widgetAlignment → PlaceholderAlignment
The alignment of the inline widgets.
final
widgets → List<Widget>
The list of widgets to be inserted into the text.
final
widgetSeparator → String
The character used to separate widget placeholders.
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