DeveloperToolsExtension class abstract

Base class for pluggable developer tools extensions.

Packages like developer_tools_riverpod or developer_tools_get can subclass this and provide extra overlay entries that are merged into the main DeveloperTools overlay.

The widget itself is never inserted into the tree – its build method returns an empty box by default – but being a widget allows extensions to use BuildContext and other Flutter APIs naturally.

Inheritance
Implementers

Constructors

DeveloperToolsExtension({Key? key, String? packageName, String? displayName, bool pinned = false})
const

Properties

displayName → String?
Optional display name for this extension in the developer tools UI.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
packageName → String?
The name of the package that this extension is for.
final
pinned → bool
When true, this extension's section is shown at the top of the developer tools overlay. Set by the developer for frequently used tools.
final
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
buildEntries(BuildContext context) → List<DeveloperToolEntry>
Returns the list of entries contributed by this extension.
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
debugInfo(BuildContext context) → Future<String?>
Returns debug information for this extension.
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