DebugOverlay class

Adds a draggable debug button on top of the app.

Usually created by DioDebugLogger.builder(). Use it directly only if you need full control:

MaterialApp(
  builder: (context, child) => DebugOverlay(
    enabled: kDebugMode,
    child: child ?? const SizedBox.shrink(),
  ),
);

Inheritance

Constructors

DebugOverlay({Key? key, required Widget child, bool enabled = kDebugMode, Color? backgroundColor, Color? foregroundColor, IconData icon = Icons.bug_report_rounded, double buttonSize = 56, bool showBadge = true, Alignment initialAlignment = Alignment.centerLeft, bool snapToEdge = true, double edgeMargin = 12}): const

backgroundColor → Color?: final
buttonSize → double: final
child → Widget: final
edgeMargin → double: final
enabled → bool: When false, the button is not built at all. Defaults to false in release builds.
final
foregroundColor → Color?: final
hashCode → int: The hash code for this object.
no setterinherited
icon → IconData: final
initialAlignment → Alignment: final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
showBadge → bool: Shows a badge with the request/error count.
final
snapToEdge → bool: Whether the button snaps to the nearest edge when released.
final

createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<DebugOverlay>: 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