flutter_debug_tools 0.0.3+1

A set of tools to help find and debug UI or performance issues from the Flutter app itself.

Flutter Debug Tools

A set of tools to help find and debug UI or performance issues from the Flutter app itself. Works with any Flutter app.

Key Features • Installation • Usage • License • Credits

Example app

Key Features

• Performance Overlay: A widget that overlays your app and shows performance metrics such as FPS, frame rasterizer, and frame build time.

• Device Details: A widget that overlays your app and shows the device details such as device name, model, version, and more.

• Debug Paint: A widget that overlays your app and shows the visual layout of the widgets.

• Layer Bounds: A widget that overlays your app and shows the layer bounds of the widgets.

• Debug Log: A widget that overlays your app and shows the logs from the app.

• Repaint Rainbow: A widget that overlays your app and shows the repaint boundaries of the widgets, and the color changes when the widget is repainted.

• Color Picker: A widget that overlays your app and allows you to pick a color from the screen.

• Widget Name: A widget that overlays your app and shows the name of the current widget.

Installation

Add the following to your pubspec.yaml file:

dependencies:
  flutter_debug_tools: ^0.0.3+1

Usage

import 'package:flutter/material.dart';
import 'package:flutter_debug_tools/flutter_debug_tools.dart';

void main() {
    // (Optional) Initialize Loggy with the DebugLoggyPrinter to show logs in the Debug Log
    Loggy.initLoggy(logOptions: logOptions, logPrinter: DebugLoggyPrinter());

  runApp(MyApp());
}

// Wrap your material app with the `FlutterDebugTools` widget
return FlutterDebugTools(
    builder: (context, value, child) {
      // (Optional) Attach navigatorObserver to observe the screen details
        final DebugNavigatorObserver navigatorObserver = DebugNavigatorObserver();
        return MaterialApp(
            // And pass the value to the `showPerformanceOverlay` property
            showPerformanceOverlay: value,
            home: MyHomePage(),
            // Add `navigatorObservers` to observe the screen details
            navigatorObservers: [navigatorObserver],
        );
    },
);

License

MIT License

Copyright (c) 2024 Abhay Maurya

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Credits

This software uses the following open source packages:

• Loggy
• Shared Preferences
• Device Info Plus

Bugs or Requests

If you encounter any problems feel free to open an issue. If you feel the library is missing a feature, please raise a ticket on GitHub and I'll look into it. Pull request are also welcome.