assorted_layout_widgets 5.0.2 assorted_layout_widgets: ^5.0.2 copied to clipboard
ColumnSuper, RowSuper, FitHorizontally, Box, WrapSuper, TextOneLine, Delayed, Pad, ButtonBarSuper, NormalizedOverflowBox, showDialogSuper.
assorted_layout_widgets #
I will slowly but surely add interesting widgets to this package.
Widgets, classes and methods in this package:
ColumnSuper
RowSuper
FitHorizontally
Box
WrapSuper
ButtonBarSuper
TextOneLine
Delayed
Pad
NormalizedOverflowBox
showDialogSuper
andshowCupertinoDialogSuper
Note: All these widgets are lightweight. And the ones you don't use will be removed by Flutter's tree shaking. So feel free to add the library even if you want to use only one of them.
ColumnSuper #
Given a list of children widgets, this will arrange them in a column. It can overlap cells, add separators and more.
ColumnSuper({
List<Widget> children,
double outerDistance,
double innerDistance,
bool invert,
Alignment alignment,
Widget separator,
bool separatorOnTop,
});
-
children
is the list of widgets that represent the column cells, just like in a regularColumn
widget. However, the list may containnull
s, which will be ignored. -
outerDistance
is the distance in pixels before the first and after the last widget. It can be negative, in which case the cells will overflow the column (without any overflow warnings). -
innerDistance
is the distance in pixels between the cells. It can be negative, in which case the cells will overlap. -
invert
if true will paint the cells that come later on top of the ones that came before. This is specially useful when cells overlap (negativeinnerDistance
). -
alignment
will align the cells horizontally if they are smaller than the available horizontal space. -
separator
is a widget which will be painted between each cells. Its height doesn't matter, since the distance between cells is given byinnerDistance
(in other words, separators don't occupy space). The separator may overflow if its width is larger than the column's width. -
separatorOnTop
iftrue
(the default) will paint the separator on top of the cells. Iffalse
will paint the separator below the cells.
Note: This is not a substitute for Flutter's native Column
, it doesn't try to have a similar API,
and it doesn't do all that Column
does. In special, Expanded
and Flexible
widgets don't work
inside of ColumnSuper
, and it will overflow if the column is not big enough to fit its contents.
ColumnSuper
is meant only for certain use cases where Column
won't work, like when you need
overlapping cells or separators.
Try running the ColumnSuper example.
Also, try ColumnSuper Playground.
RowSuper #
Given a list of children widgets, this will arrange them in a row. It can overlap cells, add separators and more.
RowSuper({
List<Widget> children,
double outerDistance,
double innerDistance,
bool invert,
Alignment alignment,
Widget separator,
bool separatorOnTop,
bool fitHorizontally,
double shrinkLimit,
MainAxisSize mainAxisSize,
});
On contrary to ColumnSuper
and the native Row
(which will overflow if the children are too large to fit the available free space),
RowSuper
may resize its children proportionately to their minimum intrinsic width.
Try running the RowSuper example.
Also, try RowSuper Playground.
Most parameters are the same as the ones of ColumnSuper
, except:
-
fill
if true will force the children to grow their widths proportionately to their minimum intrinsic width, so that they fill the whole row width. This parameter is only useful if the children are not wide enough to fill the whole row width. In case the children are larger than the row width, they will always shrink proportionately to their minimum intrinsic width, and thefill
parameter will be ignored. See: RowSuper Fill example. -
fitHorizontally
if true will shrink the children, horizontally only, until theshrinkLimit
is reached. This parameter is only useful if the children are not wide enough to fill the whole row width. Avoid usingfitHorizontally
together withfill: true
. -
shrinkLimit
by default is 67%, which means the cell contents will shrink until 67% of their original width, and then overflow. MakeshrinkLimit
equal to0.0
if you want the cell contents to shrink with no limits. Note, iffitHorizontally
is false, theshrinkLimit
is not used. -
mainAxisSize
by default isMainAxisSize.min
, which means the row will occupy no more than its content's width. Make itMainAxisSize.max
to expand the row to occupy the whole horizontal space.
You can also use a RowSpacer
to add empty space (if available) between cells. For example:
RowSuper(
children: [
widget1,
RowSpacer(),
widget2,
widget3,
],
);
Try running the RowSuper with FitHorizontally example.
Note: This is not a substitute for Flutter's native Row
, it doesn't try to have a similar API,
and it doesn't do all that Row
does. In special, Expanded
and Flexible
widgets don't work
inside of RowSuper
, since RowSuper
will resize cells proportionately when content doesn't fit.
RowSuper
is meant only for certain use cases where Row
won't work, like when you need
overlapping cells, or when you need to scale the contents of the cells when they don't fit.
FitHorizontally #
FitHorizontally({
Widget child,
double shrinkLimit,
bool fitsHeight,
AlignmentGeometry alignment,
});
The child
will be asked to define its own intrinsic height. If fitsHeight
is true, the child
will be proportionately resized (keeping its aspect ratio)
to fit the available height.
Then, if the child doesn't fit the width, it will be shrinked horizontally only (not keeping its
aspect ratio) until it fits, unless shrinkLimit
is larger than zero, in which case it will shrink
only until that limit. Note if shrinkLimit
is 1.0 the child will not shrink at all. The default is
0.67 (67%).
This is specially useful for text that is displayed in a single line. When text doesn't fit the
container it will shrink only horizontally, until it reaches the shrink limit. From that point on it
will clip, display ellipsis or fade, according to the text's Text.overflow
property.
Note: FitHorizontally
with shrinkLimit
0.0 is not the same as FittedBox
with BoxFit.fitWidth
, because FitHorizontally
will only scale horizontally, while FittedBox
will maintain the aspect ratio.
Try running the FitHorizontally example.
Box #
Box
is something between a Container
and a SizedBox
, which is less verbose and can be
made const
.
const Box({
bool show = true,
Color color,
EdgeInsetsGeometry padding,
double width,
double height,
Alignment alignment,
Widget child,
});
Since Box
can be made const
, it's good for creating colored boxes, with or without a child and
padding:
const Box(color: Colors.red, width: 50, height:30);
Const objects are final/immutable and created in compile time. So you don't waste time creating them. Also, all const objects of the same type with the same parameters are the same instance. So you don't waste memory creating more than one of them. In other words, const objects make your program faster and more memory efficient.
The padding
is only applied if the child is not null. If the child
is null
and width
and height
are also null
, this means the box will occupy no space
(will be hidden). Note: This will be extended in the future, so that it ignores horizontal
padding when the child has zero width, and ignores vertical padding when the child has zero height.
You can also hide the box by making the show
parameter equal to false
.
Note: You can use the Pad
class (provided in this package)
for the padding
, instead of EdgeInsets
.
Debugging:
-
If need to quickly and temporarily add a color to your box so that you can see it, you can use the constructors
Box.r
for red,Box.g
for green,Box.b
for blue, andBox.y
for yellow.Box(child: myChild); Box.r(child: myChild); Box.g(child: myChild); Box.b(child: myChild); Box.y(child: myChild);
-
If you want to see rebuilds, you can use the
Box.rand
constructor. It will then change its color to a random one, whenever its build method is called.Box.rand(child: myChild);
All these debugging constructors are marked as deprecated so that you don't forget to remove them.
WrapSuper #
WrapSuper
is similar to the native Wrap
widget with direction = Axis.horizontal
, but it allows
you to choose different algorithms for the
line-breaks.
WrapSuper
displays its children in lines. It will leave spacing
horizontal space between each
child, and it will leave lineSpacing
vertical space between each line. The contents of each line
will then be aligned according to the alignment
. The algorithm for the line-breaks is chosen
by wrapType
.
WrapSuper({
Key key,
WrapType wrapType,
double spacing,
double lineSpacing,
WrapSuperAlignment alignment,
List<Widget> children,
});
WrapSuper
with WrapType.fit
uses a
greedy algorithm for line breaks, which
is the same one used by the native Wrap
widget.
However, WrapSuper
with WrapType.balanced
(the default) uses a
minimum
raggedness algorithm
for line breaks. It will position its child widgets in the same number of lines as the greedy
algorithm, but these lines will tend to be more similar in width.
For example:
- Here is my original StackOverflow question that resulted in this widget.
-
The algorithm I used was based on this one (Divide and Conquer), which always considers
spacing: 1.0
. It was changed (with the help of CodeChef) to allow for other spacings. -
Add your thumbs up here if you want native
Text
widgets to also allow for better line-breaks.
WrapFit #
After WrapSuper
distributes its children in each line, the wrapFit
parameter defines the width
of the widgets:
-
min
(the default) will keep each widget's original width. -
divided
will make widgets fit all the available horizontal space. All widgets in a line will have the same width, even if it makes them smaller that their original width. -
proportional
will make widgets larger, so that they fit all the available space. Each widget width will be proportional to their original width. -
larger
will make widgets larger, so that they fit all the available space. Will try to make all widgets the same width, but won't make any widgets smaller than their original width. In more detail: 1) First, divide the available line width by the number of widgets in the line. That is the preferred width. 2) Keep the width of all widgets larger than that preferred width. 3) Calculate the remaining width and divide it equally by the remaining widgets.
Some examples:
Try running the WrapFit example.
ButtonBarSuper #
ButtonBarSuper
has a similar API to a regular ButtonBar
, but will distribute its buttons by
using a WrapSuper
.
The default (which may be changed) is WrapType.balanced
and WrapFit.larger
, which means it will
distribute the buttons in as little lines as possible in a balanced way; will make the buttons fill
all the available horizontal space; and will try to make buttons have similar width in each line,
without reducing their widths.
Try running the ButtonBarSuper example.
TextOneLine #
TextOneLine
is a substitute for Text
when maxLines: 1
, to fix this issue:
https://github.com/flutter/flutter/issues/18761 filled by myself a long time ago.
It renders ellipsis as expected, much better than the current/ buggy and ugly-looking ellipsis of
the native Text
widget, which cuts the whole word.
For example, this:
Text("This isAVeryLongWordToDemonstrateAProblem", maxLines: 1, softWrap: false);
Will print this in the screen:
This ...
While this:
TextOneLine("This isAVeryLongWordToDemonstrateAProblem");
Will print this:
This isAVeryLongWordToDemonst...
Delayed #
Delayed
can be used to give a widget some initial value, and then, after some delay, change it to
another value. As we'll see, Delayed
is specially useful when used with implicitly animated
widgets.
As soon as Delayed
is inserted into the tree, it will build the widget returned by builder
with initialized==false
. Then:
-
If
delay
isnull
, it will rebuild withinitialized==true
in the next frame (usually 16 milliseconds later). -
If
delay
is NOT null, it will rebuild withinitialized==true
after that delay.
For example, this shows a widget after a 2 seconds delay:
Delayed(delay: const Duration(seconds: 1),
builder: (context, bool initialized) =>
initialized
? Container(color: Colors.red, width: 50, height: 50)
: SizedBox()));
For example, this changes a widget color after a 3 seconds delay:
Delayed(delay: const Duration(seconds: 3),
builder: (context, bool initialized) =>
Container(color: initialized ? Colors.red : Colors.blue,
width: 50,
height: 50)
)
)
For example, this will fade-in a widget as soon as it enters the screen:
Delayed(
builder: (context, bool initialized) =>
AnimatedOpacity(opacity: initialized ? 1.0 : 0.0,
duration: const Duration(seconds: 1),
child: MyWidget()
)
);
For example, this will fade-in a widget 300 milliseconds after it enters the screen:
Delayed(delay: const Duration(milliseconds: 300),
builder: (context, bool initialized) =>
AnimatedOpacity(opacity: initialized ? 1.0 : 0.0,
duration: const Duration(seconds: 1),
child: MyWidget()
)
);
Try running the Delayed example.
Pad #
Pad
is an EdgeInsetsGeometry
which is easy to type and remember.
For example, instead of writing padding: EdgeInsets.symmetric(vertical: 12)
you can write simply padding: Pad(vertical: 12)
.
// Instead of EdgeInsets.all(12)
padding: Pad(all: 12)
// Instead of EdgeInsets.only(top: 8, bottom: 8, left: 4, right: 2)
padding: Pad(top: 8, bottom: 8, left: 4, right: 2)
// Instead of EdgeInsets.symmetric(vertical: 12)
padding: Pad(vertical: 12)
// Instead of EdgeInsets.symmetric(vertical: 12, horizontal: 6)
padding: Pad(vertical: 12, horizontal: 6)
You can also compose paddings. For example, if you want 40 pixels of padding in all directions,
except the top with 50 pixels: padding: Pad(all: 40, top: 10)
.
During development you sometimes need to temporarily remove the padding, for debugging reasons.
Unfortunately you can't just comment the padding parameter, because the
Padding
widget doesn't accept null
padding. But you can just add .x
to the
Pad
class to remove it. It's marked as deprecated
so that you don't forget to change it back to
normal:
// This is the same as Pad.zero.
padding: Pad.x(top: 8, bottom: 8, left: 4)
NormalizedOverflowBox #
A NormalizedOverflowBox
is a widget that imposes different constraints on its child than it gets
from its parent, possibly allowing the child to overflow the parent.
A NormalizedOverflowBox
is similar to an OverflowBox
. However, then OverflowBox
may throw
errors if it gets constraints which are incompatible with its own constraints. For example, if an
OverflowBox
is inside a container with maxWidth
100, and its own minWidth
is 150, it will
throw:
The following assertion was thrown during performLayout():
BoxConstraints has non-normalized width constraints.
The NormalizedOverflowBox
, on the other hand, will just make sure maxWidth
is also 150 in the
above example, and throw no errors. In other words, a NormalizedOverflowBox
is safer to use, and
in my opinion has the behavior OverflowBox
should have had.
Try running
the
NormalizedOverflowBox Example. Then substitute the NormalizedOverflowBox
s with
regular OverflowBox
es and see where it fails.
showDialogSuper and showCupertinoDialogSuper #
Functions showDialogSuper
and showCupertinoDialogSuper
are identical to the native showDialog
and showCupertinoDialog
, except that they let you define an onDismissed
callback for when the
dialog is dismissed:
showDialogSuper(
context: context,
onDismissed: (dynamic result) { print("Dialog dismissed"); }
builder: ...
}
Usually there are 3 ways to close a dialog:
- Pressing some button on the dialog that closes it (usually by calling
Navigator.pop(context)
). - Tapping the barrier.
- Pressing the Android back button.
All three ways will result in the onDismissed
callback being called.
However, when the dialog is popped by Navigator.of(context).pop(result)
you will get the result
in the onDismissed
callback. That way you can differentiate between the dialog being dismissed by
an Ok or a Cancel button. The result
is null
when the dialog is dismissed by tapping the barrier
or pressing BACK in Android. Example:
showDialogSuper<int>(
...
actions: [
ElevatedButton( onPressed: (){Navigator.pop(context, 1);}, child: const Text("OK"),
ElevatedButton( onPressed: (){Navigator.pop(context, 2);}, child: const Text("CANCEL"),
]
...
onDismissed: (int? result) {
if (result == 1) print("Pressed the OK button.");
else if (result == 2) print("Pressed the CANCEL button.");
else if (result == null) print("Dismissed with BACK or tapping the barrier.");
});
This method was created to solve this issue: https://github.com/flutter/flutter/issues/26542 filled by myself a long time ago.
Try running the showDialogSuper Example.
AlignPositioned #
See package align_positioned
for widgets AlignPositioned
and its siblings AnimatedAlignPositioned
and AnimChain
. They
should be part of this package, but will remain in their own package for historical reasons.
The Flutter packages I've authored:
- async_redux
- fast_immutable_collections
- provider_for_redux
- i18n_extension
- align_positioned
- network_to_file_image
- image_pixels
- matrix4_transform
- back_button_interceptor
- indexed_list_view
- animated_size_and_fade
- assorted_layout_widgets
- weak_map
My Medium Articles:
- Async Redux: Flutter’s non-boilerplate version of Redux ( versions: Português)
- i18n_extension ( versions: Português)
- Flutter: The Advanced Layout Rule Even Beginners Must Know ( versions: русский)
My article in the official Flutter documentation:
Marcelo Glasberg:
https://github.com/marcglasberg
https://twitter.com/glasbergmarcelo
https://stackoverflow.com/users/3411681/marcg
https://medium.com/@marcglasberg