LayoutGuard class

Main widget that wraps your app to enable layout overflow detection

Usage:

void main() {
  runApp(
    LayoutGuard(
      child: MyApp(),
    ),
  );
}
Inheritance

Constructors

LayoutGuard({Key? key, required Widget child, bool showOverlay = true, bool enabled = true, OverflowCallback? onOverflowDetected, Color overlayColor = Colors.red, bool printErrors = true})
const

Properties

child → Widget
The child widget (typically your root app widget)
final
enabled → bool
Whether to enable the overflow detector
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onOverflowDetected → OverflowCallback?
Custom callback when overflow is detected
final
overlayColor → Color
Color for the overlay highlights
final
printErrors → bool
Whether to print overflow errors to console
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showOverlay → bool
Whether to show the visual debug overlay
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<LayoutGuard>
Creates the mutable state for this widget at a given location in the tree.
override
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, 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

Operators

operator ==(Object other) → bool
The equality operator.
inherited