AnimatedHighlightedText class

A widget that animates a hand-drawn, sketchy highlight effect behind the text.

Supports two animation modes:

  • Organic Mode: Random wavy lines for a natural, hand-drawn effect.
  • Plain Mode: Smooth, straight highlighting for a more structured look.

Example Usage:

AnimatedHighlightedText(
  text: "Flutter is amazing!",
  highlightColor: Colors.yellow.withOpacity(0.4),
  textStyle: TextStyle(fontSize: 24, color: Colors.black),
  animationMode: SketchyAnimationMode.organic, // or SketchyAnimationMode.plain
  duration: Duration(seconds: 2),
  startDelay: Duration(milliseconds: 500),
)
Inheritance

Constructors

AnimatedHighlightedText.new({Key? key, required String text, required Color highlightColor, required TextStyle textStyle, SketchyAnimationMode animationMode = SketchyAnimationMode.organic, Duration duration = const Duration(milliseconds: 2000), Duration startDelay = Duration.zero})
Creates an animated sketchy highlight effect for text.
const

Properties

animationMode → SketchyAnimationMode
Determines whether the highlight is sketchy (Organic) or straight (Plain).
final
duration → Duration
The total duration of the highlight animation.
final
hashCode → int
The hash code for this object.
no setterinherited
highlightColor → Color
The color of the highlight effect.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startDelay → Duration
The delay before the highlight animation starts.
final
text → String
The text that will be highlighted.
final
textStyle → TextStyle
The text style used to render the text.
final

Methods

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