CustomStyledText class

Custom widget with formatting via tags.

Formatting is specified as xml tags. For each tag, you can specify a style, icon, etc. in the tags parameter.

Consider using the simpler StyledText instead.

Example:

CustomStyledText(
  text: '<red>Red</red> text.',
  tags: [
    'red': StyledTextTag(style: TextStyle(color: Colors.red)),
  ],
  builder: (context, textSpan) => Text.rich(textSpan),
)

See also:

  • TextStyle, which discusses how to style text.
Inheritance

Constructors

CustomStyledText({Key? key, bool newLineAsBreaks = true, required String text, Map<String, StyledTextTagBase> tags = const {}, TextStyle? style, required StyledTextWidgetBuilderCallback builder})
Create a CustomStyledText with your own builder function.

Properties

builder → StyledTextWidgetBuilderCallback
The builder with the generated TextSpan as input.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
newLineAsBreaks → bool
Treat newlines as line breaks.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
style → TextStyle?
Default text style.
final
tags → Map<String, StyledTextTagBase>
Map of tag assignments to text style classes and tag handlers.
final
text → String
The text to display in this widget. The text must be valid xml.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → _CustomStyledTextState
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