ApiInspectorOverlay class

Drop-in overlay that shows/hides based on ApiInspectorController.

Usage (recommended):

final controller = ApiInspectorController();

MaterialApp(
  builder: (context, child) {
    return Stack(
      children: [
        if (child != null) child,
        ApiInspectorOverlay(controller: controller),
      ],
    );
  },
)
Inheritance

Constructors

ApiInspectorOverlay({Key? key, required ApiInspectorController controller, double bubbleSize = 60.0, double edgePadding = -20.0, bool showSecondsInLabel = true, bool showRequestCountInLabel = true, bool showDoneErrorCountInLabel = true, bool showRecordingBadge = true, bool showRecordingErrorCountInBadge = true, double badgeDiameter = 16.0})
Creates an ApiInspectorOverlay.
const

Properties

badgeDiameter → double
Diameter of the recording badge in logical pixels.
final
bubbleSize → double
Diameter of the floating bubble in logical pixels.
final
controller → ApiInspectorController
The controller that drives overlay visibility and state.
final
edgePadding → double
Edge padding passed to the underlying AssistiveTouchOverlay.
final
hashCode → int
The hash code for this object.
no setterinherited
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
showDoneErrorCountInLabel → bool
When true, the error count is shown inside the bubble after recording finishes.
final
showRecordingBadge → bool
Shows a small badge while recording (top-right of the bubble).
final
showRecordingErrorCountInBadge → bool
When recording, show error count inside the badge if > 0.
final
showRequestCountInLabel → bool
When true, the captured request count is shown inside the bubble while recording.
final
showSecondsInLabel → bool
When true, the remaining-seconds countdown is shown inside the bubble while recording.
final

Methods

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