AnimatedContainerModifier class

Animated version of Container that gradually changes its values over a period of time.

The AnimatedContainer will automatically animate between the old and new values of properties when they change using the provided curve and duration. Properties that are null are not animated. Its child and descendants are not animated.

This class is useful for generating simple implicit transitions between different parameters to Container with its internal AnimationController. For more complex animations, you'll likely want to use a subclass of AnimatedWidget such as the DecoratedBoxTransition or use your own AnimationController.

{@tool dartpad} The following example (depicted above) transitions an AnimatedContainer between two states. It adjusts the height, width, color, and alignment properties when tapped.

** See code in examples/api/lib/widgets/implicit_animations/animated_container.0.dart ** {@end-tool}

See also:

• AnimatedPadding, which is a subset of this widget that only supports animating the padding.
• The catalog of layout widgets.
• AnimatedPositioned, which, as a child of a Stack, automatically transitions its child's position over a given duration whenever the given position changes.
• AnimatedAlign, which automatically transitions its child's position over a given duration whenever the given AnimatedAlign.alignment changes.
• AnimatedSwitcher, which switches out a child for a new one with a customizable transition.
• AnimatedCrossFade, which fades between two children and interpolates their sizes.

Inheritance

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

Available extensions

• ModifierTransformer

Constructors

AnimatedContainerModifier({Key? key, Widget? child, Curve curve = Curves.linear, required Duration duration, VoidCallback? onEnd, Key? modifierKey, AlignmentGeometry? alignment, EdgeInsetsGeometry? padding, Color? color, Decoration? decoration, Decoration? foregroundDecoration, double? width, double? height, BoxConstraints? constraints, EdgeInsetsGeometry? margin, Matrix4? transform, AlignmentGeometry? transformAlignment, Clip clipBehavior = Clip.none})

Creates a container that animates its parameters implicitly.

const

Properties

alignment → AlignmentGeometry?

Align the child within the container.

final

clipBehavior → Clip

The clip behavior when AnimatedContainer.decoration is not null.

final

color → Color?

The color to paint behind the child.

final

constraints → BoxConstraints?

Additional constraints to apply to the child.

final

curve → Curve

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

final, inherited

decoration → Decoration?

The decoration to paint behind the child.

final

duration → Duration

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

final, inherited

foregroundDecoration → Decoration?

The decoration to paint in front of the child.

final

hashCode → int

The hash code for this object.

no setter, inherited

height → double?

The container width you can't declare height and constraints at the same time

final

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

margin → EdgeInsetsGeometry?

Empty space to surround the decoration and child.

final

modifierKey → Key?

The actual key of the widget, which Modifier wrapped

final, inherited

onEnd → VoidCallback?

Called every time an animation completes.

final, inherited

padding → EdgeInsetsGeometry?

Empty space to inscribe inside the decoration. The child, if any, is placed inside this padding.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transform → Matrix4?

The transformation matrix to apply before painting the container.

final

transformAlignment → AlignmentGeometry?

The alignment of the origin, relative to the size of the container, if transform is specified.

final

width → double?

The container width you can't declare width and constraints at the same time

final

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.

override

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