OnAnimationBuilder class

Widget used to listen to an InjectedAnimation and call its builder each time the animation ticks.

Example of Implicit Animated Container

 final animation = RM.injectAnimation(
   duration: Duration(seconds: 2),
   curve: Curves.fastOutSlowIn,
 );

 class _MyStatefulWidgetState extends State<MyStatefulWidget> {
   bool selected = false;

   @override
   Widget build(BuildContext context) {
     return GestureDetector(
       onTap: () {
         setState(() {
           selected = !selected;
         });
       },
       child: Center(
         child: OnAnimationBuilder(
           listenTo: animation,
           builder: (animate) {
             final width = animate(selected ? 200.0 : 100.0);
             final height = animate(selected ? 100.0 : 200.0, 'height');
             final alignment = animate(
               selected ? Alignment.center : AlignmentDirectional.topCenter,
             );
             final Color? color = animate(
               selected ? Colors.red : Colors.blue,
             );
             return Container(
               width: width,
               height: height,
               color: color,
               alignment: alignment,
               child: const FlutterLogo(size: 75),
             );
           },
         ),
       ),
     );
   }
 }
Inheritance
Available extensions

Constructors

OnAnimationBuilder({Key? key, required InjectedAnimation listenTo, required Widget builder(Animate), void onInitialized()?})
const

Properties

builder → Widget Function(Animate)
The builder callback. It is invoked for each tick. It exposes an Animate object. The Animate object is used to set Tweens, explicitly or implicitly
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
listenTo → InjectedAnimation
InjectedAnimation to listen to.
final
onInitialized → void Function()?
Callback fired after animation is set up.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addMaterialWidget() → Material

Available on Widget, provided by the GenericExtensions extension

addTooltipWidget(String toolTip) → Tooltip

Available on Widget, provided by the GenericExtensions extension

animate({Key? key, List<Effect>? effects, AnimateCallback? onInit, AnimateCallback? onPlay, AnimateCallback? onComplete, bool? autoPlay, Duration? delay, AnimationController? controller, Adapter? adapter, double? target, double? value}) → Animate

Available on Widget, provided by the AnimateWidgetExtensions extension

Wraps the target Widget in an Animate instance, and returns the instance for chaining calls. Ex. myWidget.animate() is equivalent to Animate(child: myWidget).
borderRadius([BorderRadiusGeometry? borderRadius]) → Widget

Available on Widget, provided by the GenericExtensions extension

boxDecoration([BoxDecoration? boxDecoration]) → Widget

Available on Widget, provided by the GenericExtensions extension

colorFilter([ColorFilter? colorFilter]) → Widget

Available on Widget, provided by the GenericExtensions extension

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