ScalifyDebugOverlay class

A debug overlay that displays live responsive metrics on screen.

Only renders in debug mode — completely eliminated from release builds via kDebugMode check. Zero overhead in production.

Features

  • Live display of screen size, scale factors, screen type
  • Rebuild counter to track unnecessary rebuilds
  • Draggable panel — move it anywhere on screen
  • Collapsible via tap on the header
  • Isolated repaints via RepaintBoundary

Usage

Wrap your app (or any subtree) with ScalifyDebugOverlay:

ScalifyDebugOverlay(
  enabled: true,
  child: MyApp(),
)

Or use it inside ScalifyProvider:

ScalifyProvider(
  builder: (context, child) => MaterialApp(
    home: ScalifyDebugOverlay(child: child!),
  ),
  child: HomeScreen(),
)
Inheritance

Constructors

ScalifyDebugOverlay({Key? key, required Widget child, bool enabled = true, double initialTop = 50.0, double initialRight = 16.0})
Creates a ScalifyDebugOverlay.
const

Properties

child → Widget
The child widget (your app content).
final
enabled → bool
Whether the overlay is enabled. Defaults to true. Even when true, overlay only shows in kDebugMode.
final
hashCode → int
The hash code for this object.
no setterinherited
initialRight → double
Initial position of the overlay from the right. Default: 16.0.
final
initialTop → double
Initial position of the overlay from the top. Default: 50.0.
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

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
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.
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