GKTextEffect class

A widget that applies animated text reveal effects.

Supports four effect types via GKTextEffectType, each with its own animation style. Respects reduced motion by showing the full text immediately.

{@tool snippet}

GKTextEffect(
  text: 'Hello World',
  effect: GKTextEffectType.typewriterGlow,
  style: TextStyle(fontSize: 32, color: Colors.white),
  duration: Duration(milliseconds: 2000),
  onComplete: () => print('done'),
)

{@end-tool}

Inheritance

Constructors

GKTextEffect({Key? key, required String text, required GKTextEffectType effect, TextStyle? style, Duration duration = const Duration(milliseconds: 2000), VoidCallback? onComplete})
Creates a GKTextEffect.
const

Properties

duration → Duration
The total animation duration.
final
effect → GKTextEffectType
The type of text animation.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onComplete → VoidCallback?
Called when the animation completes.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
style → TextStyle?
The text style applied to each character.
final
text → String
The text string to animate.
final

Methods

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