debug_overlay 2.0.0

View debug infos and change settings via a central overlay for your app.

Changelog

All notable changes to this project will be documented in this file.

This project adheres to Semantic Versioning.

2.0.0 · 2026-08-26

⚠️ BREAKING CHANGES

• remove shake-to-open support (ce6c9c2)
  • shake_detector uses very outdated dependencies and doesn't support all platforms. You can still implement your own shake-to-open logic.
  • drop the shake_detector dependency
  • remove DebugOverlay's/DebugOverlay.builder's showOnShake and createShakeDetector parameters — call DebugOverlay.show() to open the overlay instead

⚡ Changes

• MediaQueryDebugHelper: show textScaler instead of the deprecated textScaleFactor (1f50a7e)

🐛 Bug Fixes

• add missing string to FlagProperty for enableOnlyInDebugMode (a8c1655)

📦 Build & CI

• update to Flutter >=3.47.0 and Dart ^3.13.0 (7796d5e, db72472)
• update device_info_plus to ^13.0.0, package_info_plus to ^10.0.0 (e342c0d)
• update supernova_lints and use dot-shorthands & primary constructors throughout (540a976, 1bf689e, 74d9de7)
• CI: add workflow_dispatch trigger, re-enable Flutter beta in example CI, and update actions/setup-java to v6 (4a8ddfc, e912204, 1bbfe6b)
• re-generate the example app's Android platform directory (Groovy → Kotlin DSL Gradle files) (9290fc4)

1.0.0 · 2024-12-22

⚠️ BREAKING CHANGES

• convert DebugHelper & co. to slivers (a23c55c)
  • this avoids stutters for large numbers of logs
  • rename DebugHelper's child to sliver
• switch from shake to shake_detector (18d59b8)

🎉 New Features

• LogsDebugHelper: add option to copy all logs (2cfbad9)
• LogsDebugHelper: add logCollection.onlyStoreLogsInDebugMode to configure whether logs are also stored in non-debug builds (8a9d885)

⚡ Changes

• increase default log maximum from 50 to 500 (1b5a9ae)

📦 Build & CI

• update device_info_plus to >=8.0.0 <12.0.0 (9c12480)
• upgrade to Flutter >=3.27.0-0 (5f81679)

0.2.12 · 2024-08-29

📦 Build & CI

• update package_info_plus to >=3.0.0 <9.0.0 (#22). Thanks to @nikolashaag!
• update device_info_plus to >=8.0.0 <11.0.0 (5d91238)

0.2.11 · 2023-12-04

📦 Build & CI

• update package_info_plus to >=3.0.0 <6.0.0 (ac133bd)

0.2.10 · 2023-11-07

🎉 New Features

• make MediaQueryDebugHelper, PackageInfoDebugHelper, and DeviceInfoDebugHelper const (4a251d2)
• add logsDebugHelper.initialMinLevel (57ae361)
• customize level titles in DiagnosticLevelSelector (3108197)
• make log entries expandable/collapsible (9c480be)
• add JSON viewer for log data (991bee8)
• add missing key parameters to widgets (b06e5a3)
• override debugFillProperties(…) (6ce47c0)

📦 Build & CI

• update device_info_plus to >=8.0.0 <10.0.0, package_info_plus to >=3.0.0 <5.0.0 (c2dc258), (822ccbc) (the newer major releases got retracted)

0.2.9 · 2023-10-11

📦 Build & CI

• update device_info_plus to >=9.0.0 < 11.0.0, package_info_plus to >=4.0.0 < 6.0.0 (63cca81)

0.2.8 · 2023-05-16

📦 Build & CI

• upgrade to Flutter >=3.10.0, Dart >=3.0.0 <4.0.0 (6dafaa0)
• update device_info_plus to ^9.0.0, package_info_plus to ^4.0.0 (be4e68f)

0.2.7 · 2023-02-17

🎉 New Features

• implement Diagnosticable for Log (21a96cb)

0.2.6 · 2023-01-24

🎉 New Features

• add debugOverlay.createShakeDetector, allowing you to customize the ShakeDetector (f3cab7c), closes: #6

0.2.5 · 2023-01-24

📜 Documentation updates

• fix changelog links (b6c3f66)

0.2.4 · 2023-01-24

🎉 New Features

• add option to show newest logs first (bdfb520), closes: #5

📦 Build & CI

• upgrade to Flutter >=3.3.0, Dart >=2.18.0 <3.0.0 (5c7230e)
• update black_hole_flutter to ^1.0.0 (3f40d9f)

0.2.3 · 2022-11-02

📦 Build & CI

• update device_info_plus to ^8.0.0, package_info_plus to ^3.0.1 (2beb8e5)

0.2.2 · 2022-10-10

📦 Build & CI

• update device_info_plus to ^5.0.5 (5c645e6)

0.2.1 · 2022-08-15

🐛 Bug Fixes

• Remove Android ID entry because it got removed in device_info_plus (6fc6f21)

0.2.0 · 2022-07-18

⚠️ BREAKING CHANGES

• Store logs even if not in debug mode (6193833)
• Only add default debug helpers in debug mode (cc6698e)

📜 Documentation updates

• Add note about DiagnosticsBasedDebugHelper only working in debug mode (947a224)

0.1.5 · 2022-07-18

🎉 New Features

• add debugOverlay.enableOnlyInDebugMode and a corresponding parameter in DebugOverlay.builder (both default to false) to optionally enable the overlay in release or profile builds (f662e57)

0.1.4 · 2022-06-10

📦 Build & CI

• update to Flutter 3 (15b65ed)

0.1.3 · 2022-01-05

📦 Build & CI

• remove dependency on the discontinued supercharged (967171d)

0.1.2 · 2021-11-10

🏗️ Refactoring

• migrate to flutter_lints

📦 Build & CI

• update device_info_plus to ^3.0.0
• update shake to ^2.0.0

0.1.1 · 2021-03-29

🎉 New Features

• support device_info_plus_platform_interface ^1.0.1

0.1.0 · 2021-03-25

Initial release 🎉