Box class

Inheritance
Available extensions

Constructors

Box({Key? key, bool show = true, Color? color, EdgeInsetsGeometry? padding, double? width, double? height, AlignmentGeometry? alignment, Widget? child, bool removePaddingWhenNoChild = false, Decoration? decoration, DecorationPosition decorationPosition = DecorationPosition.background})
Box is something between a Container and a SizedBox. Unlike a Container it can be made const, so it's good for creating colored boxes, with or without padding:
const
Box.b({Key? key, bool show = true, Color? color, EdgeInsetsGeometry? padding, double? width, double? height, Alignment? alignment, Widget? child, bool removePaddingWhenNoChild = false, Decoration? decoration, DecorationPosition decorationPosition = DecorationPosition.background})
Adding .b to the box will make it blue. Use this for debugging purposes only. This constructor is marked as deprecated so that you don't forget to remove it.
const
Box.g({Key? key, bool show = true, Color? color, EdgeInsetsGeometry? padding, double? width, double? height, Alignment? alignment, Widget? child, bool removePaddingWhenNoChild = false, Decoration? decoration, DecorationPosition decorationPosition = DecorationPosition.background})
Adding .g to the box will make it green. Use this for debugging purposes only. This constructor is marked as deprecated so that you don't forget to remove it.
const
Box.gap(double gap)
Creates a square box with gap by gap pixels. This may be used for small gaps between widgets. For example:
const
Box.r({Key? key, bool show = true, Color? color, EdgeInsetsGeometry? padding, double? width, double? height, Alignment? alignment, Widget? child, bool removePaddingWhenNoChild = false, Decoration? decoration, DecorationPosition decorationPosition = DecorationPosition.background})
Adding .r to the box will make it red. Use this for debugging purposes only. This constructor is marked as deprecated so that you don't forget to remove it.
const
Box.rand({Key? key, bool show = true, Color? color, EdgeInsetsGeometry? padding, double? width, double? height, AlignmentGeometry? alignment, Widget? child, bool removePaddingWhenNoChild = false, Decoration? decoration, DecorationPosition decorationPosition = DecorationPosition.background})
Use the Box.rand constructor to see when the widget rebuilds. It will change its color to a random one, whenever its build method is called. This constructor is marked as deprecated so that you don't forget to remove it.
const
Box.y({Key? key, bool show = true, Color? color, EdgeInsetsGeometry? padding, double? width, double? height, Alignment? alignment, Widget? child, bool removePaddingWhenNoChild = false, Decoration? decoration, DecorationPosition decorationPosition = DecorationPosition.background})
Adding .y to the box will make it yellow. Use this for debugging purposes only. This constructor is marked as deprecated so that you don't forget to remove it.
const

Properties

alignment → AlignmentGeometry?
final
child → Widget?
final
color → Color?
final
decoration → Decoration?
final
decorationPosition → DecorationPosition
final
hashCode → int
The hash code for this object.
no setterinherited
height → double?
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
makeRefreshable → Widget

Available on Widget?, provided by the WidgetExtension extension

Make your any widget refreshable with RefreshIndicator on top
no setter
padding → EdgeInsetsGeometry?
final
removePaddingWhenNoChild → bool
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
show → bool
final
size → Size
Return the width/height of the box, if set. Note this is not the real size of the box, since it ignores the child and the layout.
no setter
width → double?
final

Methods

add({double? width, double? height}) → Box
Returns a box with its width or height increased by width or height (or decreased if the given width or height are negative, clamped to zero).
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

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
center({double? heightFactor, double? widthFactor}) → Widget

Available on Widget?, provided by the WidgetExtension extension

set parent widget in center
colorFilter([ColorFilter? colorFilter]) → Widget

Available on Widget, provided by the GenericExtensions extension

set parent widget in center
copyWith({Key? key, bool? show, Color? color, EdgeInsetsGeometry? padding, double? width, double? height, AlignmentGeometry? alignment, bool? random, Decoration? decoration, DecorationPosition? decorationPosition, Widget? child}) → Box
Creates a copy of this Box but with the given fields replaced with the new values.
cornerRadiusWithClipRRect(double radius) → ClipRRect

Available on Widget?, provided by the WidgetExtension extension

add corner radius
cornerRadiusWithClipRRectOnly({int bottomLeft = 0, int bottomRight = 0, int topLeft = 0, int topRight = 0}) → ClipRRect

Available on Widget?, provided by the WidgetExtension extension

add custom corner radius each side
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
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.
override
expand({int flex = 1}) → Widget

Available on Widget?, provided by the WidgetExtension extension

add Expanded to parent widget
fit({BoxFit? fit, AlignmentGeometry? alignment}) → Widget

Available on Widget?, provided by the WidgetExtension extension

add FittedBox to parent widget
flexible({int flex = 1, FlexFit? fit}) → Widget

Available on Widget?, provided by the WidgetExtension extension

add Flexible to parent widget
launch<T>(BuildContext context, {bool isNewTask = false, PageRouteAnimation? pageRouteAnimation, Duration? duration, String? routeName, Object? routeArguments}) → Future<T?>

Available on Widget?, provided by the WidgetExtension extension

Launch a new screen
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onTap(Function? function, {BorderRadius? borderRadius, Color? splashColor, Color? hoverColor, Color? highlightColor, Color? focusColor, WidgetStateProperty<Color?>? overlayColor}) → Widget

Available on Widget?, provided by the WidgetExtension extension

add tap to parent widget
opacity({required double opacity, int durationInSecond = 1, Duration? duration}) → Widget

Available on Widget?, provided by the WidgetExtension extension

add opacity to parent widget
paddingAll(double padding) → Padding

Available on Widget?, provided by the WidgetExtension extension

return padding all
paddingBottom(double bottom) → Padding

Available on Widget?, provided by the WidgetExtension extension

return padding bottom
paddingDirectional({double start = 0.0, double top = 0.0, double end = 0.0, double bottom = 0.0}) → Widget

Available on Widget?, provided by the WidgetExtension extension

paddingLeft(double left) → Padding

Available on Widget?, provided by the WidgetExtension extension

return padding left
paddingOnly({double top = 0.0, double left = 0.0, double bottom = 0.0, double right = 0.0}) → Padding

Available on Widget?, provided by the WidgetExtension extension

return custom padding from each side
paddingRight(double right) → Padding

Available on Widget?, provided by the WidgetExtension extension

return padding right
paddingSymmetric({double vertical = 0.0, double horizontal = 0.0}) → Padding

Available on Widget?, provided by the WidgetExtension extension

return padding symmetric
paddingTop(double top) → Padding

Available on Widget?, provided by the WidgetExtension extension

return padding top
rotate({required double angle, bool transformHitTests = true, Offset? origin}) → Widget

Available on Widget?, provided by the WidgetExtension extension

add rotation to parent widget
scale({required double scale, Offset? origin, AlignmentGeometry? alignment, bool transformHitTests = true}) → Widget

Available on Widget?, provided by the WidgetExtension extension

add scaling to parent widget
subtract({double? width, double? height}) → Box
Returns a box with its width or height decreased by width or height (clamped to zero).
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
tooltip({required String msg}) → Widget

Available on Widget?, provided by the WidgetExtension extension

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
translate({required Offset offset, bool transformHitTests = true, Key? key}) → Widget

Available on Widget?, provided by the WidgetExtension extension

add translate to parent widget
validate({Widget value = const SizedBox()}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Validate given widget is not null and returns given value if null.
visible(bool visible, {Widget? defaultWidget}) → Widget

Available on Widget?, provided by the WidgetExtension extension

set visibility
withHeight(double height) → SizedBox

Available on Widget?, provided by the WidgetExtension extension

With custom height
withRoundedCorners({Color backgroundColor = whiteColor, BorderRadius borderRadius = const BorderRadius.all(Radius.circular(8.0)), LinearGradient? gradient, BoxBorder? border, List<BoxShadow>? boxShadow, DecorationImage? decorationImage, BoxShape boxShape = BoxShape.rectangle}) → Container

Available on Widget?, provided by the WidgetExtension extension

withScroll({ScrollPhysics? physics, EdgeInsetsGeometry? padding, Axis scrollDirection = Axis.vertical, ScrollController? controller, DragStartBehavior dragStartBehavior = DragStartBehavior.start, bool? primary, required bool reverse}) → Widget

Available on Widget?, provided by the WidgetExtension extension

withShaderMask(List<Color> colors, {BlendMode blendMode = BlendMode.srcATop}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Wrap with ShaderMask widget
withShaderMaskGradient(Gradient gradient, {BlendMode blendMode = BlendMode.srcATop}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Wrap with ShaderMask widget Gradient
withShadow({Color bgColor = whiteColor, Color shadowColor = Colors.black12, dynamic blurRadius = 10.0, dynamic spreadRadius = 0.0, Offset offset = const Offset(0.0, 0.0), LinearGradient? gradient, BoxBorder? border, DecorationImage? decorationImage, BoxShape boxShape = BoxShape.rectangle}) → Container

Available on Widget?, provided by the WidgetExtension extension

withSize({double width = 0.0, double height = 0.0}) → SizedBox

Available on Widget?, provided by the WidgetExtension extension

With custom height and width
withTooltip({required String msg}) → Widget

Available on Widget?, provided by the WidgetExtension extension

Validate given widget is not null and returns given value if null.
withVisibility(bool visible, {Widget? replacement, bool maintainAnimation = false, bool maintainState = false, bool maintainSize = false, bool maintainSemantics = false, bool maintainInteractivity = false}) → Visibility

Available on Widget?, provided by the WidgetExtension extension

set widget visibility
withWidth(double width) → SizedBox

Available on Widget?, provided by the WidgetExtension extension

With custom width

Operators

operator +(Object? obj) → Box
You can create boxes by adding a Box to one these types: bool, Color, EdgeInsetsGeometry, AlignmentGeometry, or Widget.
operator ==(Object other) → bool
The equality operator.
inherited