Widgets in this package:
Why are these widgets an indispensable tool?
When your desired layout feels too complex for Columns and Rows,
AlignPositioned is a real life saver.
Flutter is very composable, which is good,
but sometimes it's unnecessarily complex to translate some layout
requirement into a composition of simpler widgets.
AlignPositioned aligns, positions, sizes, rotates and transforms its child
in relation to both the container and the child itself.
In other words, it lets you easily and directly define
where and how a widget should appear in relation to another.
For example, you can tell it to position the top-left of its child at 15 pixels
to the left of the top-left corner of the container,
plus move it two thirds of the child's height to the bottom plus 10 pixels,
and then rotate 15 degrees.
Do you even know how to start doing this by composing basic Flutter widgets?
Maybe, but with
AlignPositioned it's much easier, and it takes a single widget.
AlignPositioned is specially helpful for explicit animations
(those that use a
since you can just calculate the final position, size and rotation you want for each frame.
Without it you may find yourself having to animate a composition of widgets.
are helpful for implicit animations, which are very easy to create.
If you change their parameters they animate
automatically, interpolating between the old and new parameter values.
How it works #
Add align_positioned as a dependency
then import it:
child to the
AlignPositioned or the
and then one or more of the following parameters:
AlignPositioned( child: child, alignment: ..., dx: ..., dy: ..., moveByChildWidth: ..., moveByChildHeight: ..., moveByContainerWidth: ..., moveByContainerHeight: ..., childWidth: ..., childHeight: ..., minChildWidth: ..., minChildHeight: ..., maxChildWidth: ..., maxChildHeight: ..., childWidthRatio: ..., childHeightRatio: ..., minChildWidthRatio: ..., minChildHeightRatio: ..., maxChildWidthRatio: ..., maxChildHeightRatio: ..., rotateDegrees: ..., matrix4Transform: ..., wins: ..., touch: ..., );
Let's study each parameter in detail:
Align and Position parameters #
alignment parameter works as expected. For example,
Alignment.bottomRight represents the bottom right of the container,
Alignment(0.0, 0.0) represents the center of the container.
The distance from -1.0 to +1.0 is the distance from one side of the rectangle
to the other side of the rectangle.
alignment works just like the alignment
Align widget, aligning the child inside of the container.
Touch.outside, then the alignment happens outside of
As another example, if
Alignment(1.0, 0.0) makes the child's
right side touch the right side of the container (it touches the container from the inside).
Alignment(1.0, 0.0) makes the child's
left side touch the right side of the container (it touches the container from the outside).
dy can be positive or negative, and move the child horizontally and
vertically, in pixels.
moveByChildHeight can be positive or negative, and move the child
horizontally and vertically, but the unit here is not pixels, but child widths and heights.
moveByContainerHeight can be positive or negative, and move the child
horizontally and vertically, but the unit here is not pixels, but container widths and heights.
Align and Position Examples #
The below image shows the center of the child positioned 15 pixels to the right of the top-left corner of the container:
AlignPositioned( child: child, alignment: Alignment.topLeft, touch: Touch.inside, dx: 15.0, // Move 4 pixels to the right. moveByChildWidth: -0.5, // Move half child width to the left. moveByChildHeight: -0.5); // Move half child height to the top.
Then, to move the child one container width to the right, and one container height to the bottom:
AlignPositioned( child: child, alignment: Alignment.topLeft, touch: Touch.inside, dx: 15.0, // Move 4 pixels to the right. moveByChildWidth: -0.5, // Move half child width to the left. moveByChildHeight: -0.5, // Move half child height to the top. moveByContainerWidth: 1.0, // Move one container width to the right. moveByContainerHeight: 1.0); // Move one container height to the bottom.
Please, check the example tab for the effects seen below:
Size Parameters #
Optionally, you can also define the child size:
childWidthis the child width, in pixels.
childHeightis the child height, in pixels.
minChildWidthis the minimum width, in pixels. It has precedence over
minChildHeightis the minimum height, in pixels. It has precedence over
maxChildWidthis the maximum width, in pixels. It has precedence over
maxChildHeightis the maximum height, in pixels. It has precedence over
childWidthRatiois the child width, as a fraction of the container width. If between 0.0 and 1.0, the child will be smaller than its container. If more than 1.0, the child will be larger than its container. If you define both
childWidththey will be added.
childHeightRatiois the child height, as a fraction of the container height. If between 0.0 and 1.0, the child will be smaller than its container. If more than 1.0, the child will be larger than its container. If you define both
childHeightthey will be added.
minChildWidthRatiois the minimum child width, as a fraction of the container width. It has precedence over
childWidth. If both
minChildWidthRatioare defined, both will be applied (the minimum will be the larger one).
minChildHeightRatio. is the minimum child height, as a fraction of the container height. It has precedence over
childHeight. If both
minChildHeightRatioare defined, both will be applied (the minimum will be the larger one).
maxChildWidthRatiois the maximum child width, as a fraction of the container width. It has precedence over
childWidth. If both
maxChildWidthRatioare defined, both will be applied (the maximum will be the smaller one).
maxChildHeightRatiois the maximum child height, as a fraction of the container height. It has precedence over
childHeight. If both
maxChildHeightRatioare defined, both will be applied (the maximum will be the smaller one).
winsdecides what happens if the minimum size is larger then the maximum size. If
Wins.min, the default, the minimum size will be used. If
Wins.max, the maximum size will be used.
Rotate and Transform #
Optionally, you can also define rotation and transformation:
rotateDegreesis the rotation, in degrees (1 turn is 360 degrees). The position of the axis of the rotation (the "origin") depends on the
alignmentparameter and the parent. So, for example,
Alignment.centermeans the axis of rotation is at the center of the parent.
matrix4Transformlets you apply any transformation to the child. This uses Matrix4Transform instead of Matrix4, since it's easier to use. However, you can still use Matrix4 directly with the constructor
One widget relative to another #
AlignPositioned.relative() factory if you have a main widget, and you want to
position/size/rotate/translate another widget relative
to the main one, but the second is not a child of the first.
Example, to center the main widget, and then put the relative widget below it:
Center( child: AlignPositioned.relative( widgetA(), widgetB(), moveByContainerHeight: 0.5, moveByChildHeight: 0.5));
Using AlignPositioned inside of a Stack #
Stack positions its children relative to the edges of its box.
Stack documentation contains this text:
In particular, when using a Stack you can't position children relative to their size or the stack's own size.
However, by using
AlignPositioned you can do precisely that:
position (and size, rotate and transform) children relative to their size or the Stack's own size,
and consequently in relation to the other widgets inside of the Stack.
If you recall how a
Stack works, each of its child widgets is either positioned or non-positioned.
The stack sizes itself to contain all the non-positioned children,
which are positioned according to the stacks's
Next, the positioned children are laid out.
If you use the
AlignPositioned default constructor and put it inside of a Stack
it will be a non-positioned child.
To create a positioned widget, use the
AlignPositioned will then expand and fix itself to the corners of the
In other words, the
Stack will size itself to their other non-positioned widgets,
and then you can use the
AlignPositioned to layout its child in relation to the
Stack( children: [ Container(...), Positioner(child: Container(...)), AlignPositioned(...), AlignPositioned.expand(...), ... ]);
Implicit Animation #
If you change the
AnimatedAlignPositioned parameters it will animate automatically:
return AnimatedAlignPositioned( duration: Duration(seconds: 3) alignment: Alignment.bottomCenter, rotateDegrees: isOk ? 0 : 180, child: AnimatedContainer( color: isOk ? Colors.yellow : Colors.red, duration: Duration(seconds: 2) ), );
Chained Implicit Animation #
Or you can chain widgets together so that even the change of parameters is automatic:
return AnimChain(repeat: true) // Show the yellow box and wait 5 seconds. .next( wait: Duration(seconds: 5), widget: AnimatedAlignPositioned( alignment: Alignment.bottomCenter, rotateDegrees: 0, child: Container(color: Colors.yellow), ), ) // Rotate to the red box in 3 seconds. .next( wait: Duration(seconds: 3), widget: AnimatedAlignPositioned( duration: Duration(seconds: 3), rotateDegrees: 180, child: Container(color: Colors.red), ), ) // Finally, translate the blue in the vertical axis. .next( widget: AnimatedAlignPositioned( duration: Duration(seconds: 15), alignment: Alignment.bottomCenter, dy: 150, rotateDegrees: 180, child: Container(color: Colors.blue), ), ), );
The Flutter packages I've authored:
[1.0.4] - 2019/02/22
- Code and examples.
[1.0.6] - 2019/02/23
- Added moveByContainerWidth and moveByContainerHeight.
[1.0.7] - 2019/02/23
- Added size parameters.
[1.0.8] - 2019/08/07
- Better docs.
[1.1.0] - 2019/08/17
- AlignPositioned inside of a Stack.
[1.1.5] - 2019/08/23
- ChildHeightRatio and childHeight may be present at the same time.
[1.1.8] - 2019/08/25
[1.1.9] - 2019/08/26
[1.2.0] - 2019/08/29
[1.2.3] - 2019/09/10
- Removed reverseDuration.
Implicit animations using
Implicit and chained animations using
Position one width in relation to another, when one is not the child of the other.
Use this package as a library
1. Depend on it
Add this to your package's pubspec.yaml file:
dependencies: align_positioned: ^1.2.3
2. Install it
You can install packages from the command line:
$ flutter pub get
Alternatively, your editor might support
flutter pub get.
Check the docs for your editor to learn more.
3. Import it
Now in your Dart code, you can use:
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
We analyzed this package on Oct 21, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
- Dart: 2.5.1
- pana: 0.12.21
- Flutter: 1.9.1+hotfix.4
Detected platforms: Flutter
References Flutter, and has no conflicting libraries.
flutter format to format
flutter format to format