PrismDebugOverlay class

A live inspector for the Prism design system.

Drop it over your app in debug builds and you can see exactly which tokens are active, which window class the layout is in, and whether the platform is asking for reduced motion. It answers the question every theming bug starts with — "are the tokens I set actually the tokens being read?" — without adding a print statement and rebuilding.

MaterialApp(
  builder: (context, child) => PrismDebugOverlay(
    enabled: kDebugMode,
    child: child!,
  ),
  home: const HomePage(),
)

enabled defaults to false, so it is safe to leave in a tree: pass kDebugMode and it disappears in release builds.

Inheritance

Constructors

PrismDebugOverlay({Key? key, required Widget child, bool enabled = false, bool initiallyExpanded = false, Alignment alignment = Alignment.topLeft})
Creates a debug overlay.
const

Properties

alignment → Alignment
Where the badge and panel sit.
final
child → Widget
The app.
final
enabled → bool
Whether the overlay is shown at all.
final
hashCode → int
The hash code for this object.
no setterinherited
initiallyExpanded → bool
Whether the panel starts open.
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

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