SingleChildImplicitlyAnimatedModifier class abstract

An abstract class for building widgets that animate changes to their properties.

Widgets of this type will not animate when they are first added to the widget tree. Rather, when they are rebuilt with different values, they will respond to those changes by animating the changes over a specified duration.

Which properties are animated is left up to the subclass. Subclasses' States must extend ImplicitlyAnimatedWidgetState and provide a way to visit the relevant fields to animate.

Relationship to AnimatedWidgets

ImplicitlyAnimatedWidgets (and their subclasses) automatically animate changes in their properties whenever they change. For this, they create and manage their own internal AnimationControllers to power the animation. While these widgets are simple to use and don't require you to manually manage the lifecycle of an AnimationController, they are also somewhat limited: Besides the target value for the animated property, developers can only choose a duration and curve for the animation. If you require more control over the animation (e.g. you want to stop it somewhere in the middle), consider using an AnimatedWidget or one of its subclasses. These widgets take an Animation as an argument to power the animation. This gives the developer full control over the animation at the cost of requiring you to manually manage the underlying AnimationController.

Common implicitly animated widgets

A number of implicitly animated widgets ship with the framework. They are usually named AnimatedFoo, where Foo is the name of the non-animated version of that widget. Commonly used implicitly animated widgets include:

• TweenAnimationBuilder, which animates any property expressed by a Tween to a specified target value.
• AnimatedAlign, which is an implicitly animated version of Align.
• AnimatedContainer, which is an implicitly animated version of Container.
• AnimatedDefaultTextStyle, which is an implicitly animated version of DefaultTextStyle.
• AnimatedScale, which is an implicitly animated version of Transform.scale.
• AnimatedRotation, which is an implicitly animated version of Transform.rotate.
• AnimatedSlide, which implicitly animates the position of a widget relative to its normal position.
• AnimatedOpacity, which is an implicitly animated version of Opacity.
• AnimatedPadding, which is an implicitly animated version of Padding.
• AnimatedPhysicalModel, which is an implicitly animated version of PhysicalModel.
• AnimatedPositioned, which is an implicitly animated version of Positioned.
• AnimatedPositionedDirectional, which is an implicitly animated version of PositionedDirectional.
• AnimatedTheme, which is an implicitly animated version of Theme.
• AnimatedCrossFade, which cross-fades between two given children and animates itself between their sizes.
• AnimatedSize, which automatically transitions its size over a given duration.
• AnimatedSwitcher, which fades from one widget to another.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatelessWidget
• SingleChildStatelessModifier
• SingleChildImplicitlyAnimatedModifier

Implementers

• AnimatedAlignModifier
• AnimatedContainerModifier
• AnimatedDefaultTextStyleModifier
• AnimatedFractionallySizedBoxModifier
• AnimatedOpacityModifier
• AnimatedPaddingModifier
• AnimatedPhysicalModelModifier
• AnimatedPositionedDirectionalModifier
• AnimatedPositionedModifier
• AnimatedRotationModifier
• AnimatedScaleModifier
• AnimatedSlideModifier
• AnimatedThemeModifier
• SliverAnimatedOpacityModifier

Available extensions

• ModifierTransformer

Constructors

SingleChildImplicitlyAnimatedModifier({Key? key, Widget? child, Key? modifierKey, Curve curve = Curves.linear, required Duration duration, VoidCallback? onEnd})

Initializes fields for subclasses.

const

Properties

curve → Curve

The curve to apply when animating the parameters of this container.

final

duration → Duration

The duration over which to animate the parameters of this container.

final

hashCode → int

The hash code for this object.

no setter, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

modifierKey → Key?

The actual key of the widget, which Modifier wrapped

final, inherited

onEnd → VoidCallback?

Called every time an animation completes.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

build(BuildContext context) → Widget

Describes the part of the user interface represented by this widget.

inherited

buildWithChild(BuildContext context, Widget? child) → Widget

A build method that receives an extra child parameter.

inherited

createElement() → SingleChildStatelessElement

Create a SingleChildStatelessElement

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}) → 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