debug_overlay
3.0.1, released 3 days ago by wanke.dev
Adds a configurable debug overlay with tools like logs, media query info, and theme overrides.
Uses material_ui
What it does
Provides a central overlay that can be opened in debug mode to view app diagnostics and change settings at runtime. Tools are registered as DebugTool instances and displayed in a draggable bubble or expanded sheet.
AI-written summary of version 3.0.1, based on the package's README and metadata. Report an inaccuracy
Use it when
- You need quick access to runtime diagnostics without leaving the app
- You want to toggle debug features like logs or media overrides on the fly
Skip it when
- You target only release builds
- You prefer a separate logging or analytics solution
Strengths
- Works on all Flutter platforms
- Extensible via custom DebugTools
- No code generation required
Weaknesses
- Only active in debug mode by default
- Adds overlay UI overhead
- Requires manual registration of tools
Setup
- Kind
- Flutter widgets
- Effort
- Low
- Code generation
- No
- Direct dependencies
- 7
MaterialApp(
builder: DebugOverlay.builder(),
home: MyHomePage(),
);Alternatives
Packages that do the same job and could replace debug_overlay.
Works with
Packages commonly used together with debug_overlay: ones it builds on, ones built on it, and its own family.
- material_uidebug_overlay depends on itOfficial Flutter Material UI library implementing Google’s Material Design system.
- sliver_toolsdebug_overlay depends on itUtility sliver widgets missing from the Flutter framework
- implicitly_animated_listdebug_overlay depends on itA Flutter widget that implicitly animates a list when it rebuilds with new items.
- black_hole_flutterdebug_overlay depends on itFlutter utility functions, extension methods, and custom widgets.
- json_viewdebug_overlay depends on itA Flutter widget for previewing and viewing JSON data with lazy loading.
- swipeable_page_routeSame familyA specialized page route allowing users to navigate back by swiping anywhere.