flutter_ume 1.1.1+1 icon indicating copy to clipboard operation
flutter_ume: ^1.1.1+1 copied to clipboard

UME is an in-app debug kits platform for Flutter apps. Produced by Flutter Infra team of ByteDance.

flutter_ume #

简体中文

UME is an in-app debug kits platform for Flutter apps.

platforms license

pub package pub package pub package pub package pub package

banner

Since ^1.0.0, flutter_ume starts adapting to the Flutter 3. See [Quick Start] to learn more.

banner

Scan QR code or click link to download apk. Try it now! https://github.com/bytedance/flutter_ume/releases/download/v0.2.1.0/app-debug.apk

There are 13 plugin kits built in the latest open source version of UME. Developer could create custom plugin kits, and integrate them into UME. Visit Develop plugin kits for UME for more details.

Quick Start #

All packages whose names are prefixed with flutter_ume_kit_ are function plug-ins of UME, and users can access them according to demand

  1. Edit pubspec.yaml, and add dependencies.

    Compatible with Flutter 3 since version 1.0.0.

     dev_dependencies:
       flutter_ume: ^1.0.1
       flutter_ume_kit_ui: ^1.0.0
       flutter_ume_kit_device: ^1.0.0
       flutter_ume_kit_perf: ^1.0.0
       flutter_ume_kit_show_code: ^1.0.0
       flutter_ume_kit_console: ^1.0.0
       flutter_ume_kit_dio: ^1.0.0
    
**↓ Null-safety version, compatible with Flutter 2.x**

``` yaml
dev_dependencies: # Don't use UME in release mode
  flutter_ume: ^0.3.0+1
  flutter_ume_kit_ui: ^0.3.0+1
  flutter_ume_kit_device: ^0.3.0
  flutter_ume_kit_perf: ^0.3.0
  flutter_ume_kit_show_code: ^0.3.0
  flutter_ume_kit_console: ^0.3.0
  flutter_ume_kit_dio: ^0.3.0
```

**↓ Non-null-safety version, compatible with Flutter 1.x**

``` yaml
dev_dependencies: # Don't use UME in release mode
  flutter_ume: ^0.1.1
  flutter_ume_kit_ui: ^0.1.1
  flutter_ume_kit_device: ^0.1.1
  flutter_ume_kit_perf: ^0.1.1
  flutter_ume_kit_show_code: ^0.1.1
  flutter_ume_kit_console: ^0.1.1 
```
  1. Run flutter pub get

  2. Import packages

     import 'package:flutter_ume/flutter_ume.dart'; // UME framework
     import 'package:flutter_ume_kit_ui/flutter_ume_kit_ui.dart'; // UI kits
     import 'package:flutter_ume_kit_perf/flutter_ume_kit_perf.dart'; // Performance kits
     import 'package:flutter_ume_kit_show_code/flutter_ume_kit_show_code.dart'; // Show Code
     import 'package:flutter_ume_kit_device/flutter_ume_kit_device.dart'; // Device info
     import 'package:flutter_ume_kit_console/flutter_ume_kit_console.dart'; // Show debugPrint
     import 'package:flutter_ume_kit_dio/flutter_ume_kit_dio.dart'; // Dio Inspector
    
  3. Edit main method of your app, register plugin kits and initial UME

     void main() {
       if (kDebugMode) {
         PluginManager.instance                                 // Register plugin kits
           ..register(WidgetInfoInspector())
           ..register(WidgetDetailInspector())
           ..register(ColorSucker())
           ..register(AlignRuler())
           ..register(ColorPicker())                            // New feature
           ..register(TouchIndicator())                         // New feature
           ..register(Performance())
           ..register(ShowCode())
           ..register(MemoryInfoPage())
           ..register(CpuInfoPage())
           ..register(DeviceInfoPanel())
           ..register(Console())
           ..register(DioInspector(dio: dio));                  // Pass in your Dio instance
         // After flutter_ume 0.3.0
         runApp(UMEWidget(child: MyApp(), enable: true));
         // Before flutter_ume 0.3.0
         runApp(injectUMEWidget(child: MyApp(), enable: true));
       } else {
         runApp(MyApp());
       }
     }
    
  4. flutter run for running or flutter build apk --debugflutter build ios --debug for building productions.

Some functions rely on VM Service, and additional parameters need to be added for local operation to ensure that it can connect to the VM Service.

Flutter 2.0.x, 2.2.x and other versions run on real devices, flutter run needs to add the --disable-dds parameter. After Pull Request #80900 merging, --disable-dds was renamed to --no-dds.

IMPORTANT #

From 0.1.1/0.2.1 version,we don't need set useRootNavigator: false. The following section only applies to versions before version 0.1.1/0.2.1 .

Since UME manages the routing stack at the top level, methods such as showDialog use rootNavigator to pop up by default, therefore must pass in the parameter useRootNavigator: false in showDialog, showGeneralDialog and other 'show dialog' methods to avoid navigator errors.

showDialog(
  context: context,
  builder: (ctx) => AlertDialog(
        title: const Text('Dialog'),
        actions: <Widget>[
          TextButton(
              onPressed: () => Navigator.pop(context),
              child: const Text('OK'))
        ],
      ),
  useRootNavigator: false); // <===== It's very IMPORTANT!

Features #

There are 13 plugin kits built in the current open source version of UME.

UI kits

Widget Info
Widget Info
Widget Detail
Widget Detail
Align Ruler
Align Ruler
Color Picker
Color Picker
Color Sucker
Color Sucker
Touch Indicator
Touch Indicator

Performance Kits

Memory Info
Memory Info
Perf Overlay
Perf Overlay

Device Info Kits

CPU Info
CPU Info
Device Info
Device Info

Show Code

Show Code
Show Code

Console

Console
Console

Dio Inspector

Dio Inspector
Dio Inspector

Develop plugin kits for UME #

UME plugins are located in the ./kits directory, and each one is a package. You can refer to the example in ./custom_plugin_example about this chapter.

  1. Run flutter create -t package custom_plugin to create your custom plugin kit, it could be package or plugin.

  2. Edit pubspec.yaml of the custom plugin kit to add UME framework dependency.

     dependencies:
       flutter_ume: '>=0.3.0 <0.4.0'
    
  3. Create the class of the plugin kit which should implement Pluggable.

     import 'package:flutter_ume/flutter_ume.dart';
    
     class CustomPlugin implements Pluggable {
       CustomPlugin({Key key});
    
       @override
       Widget buildWidget(BuildContext context) => Container(
         color: Colors.white
         width: 100,
         height: 100,
         child: Center(
           child: Text('Custom Plugin')
         ),
       ); // The panel of the plugin kit
    
       @override
       String get name => 'CustomPlugin'; // The name of the plugin kit
    
       @override
       String get displayName => 'CustomPlugin';
    
       @override
       void onTrigger() {} // Call when tap the icon of plugin kit
    
       @override
       ImageProvider<Object> get iconImageProvider => NetworkImage('url'); // The icon image of the plugin kit
     }
    
  4. Use your custom plugin kit in project

    1. Edit pubspec.yaml of host app project to add custom_plugin dependency.

       dev_dependencies:
         custom_plugin:
           path: path/to/custom_plugin
      
    2. Run flutter pub get

    3. Import package

       import 'package:custom_plugin/custom_plugin.dart';
      
  5. Edit main method of your app, register your custom_plugin plugin kit

     if (kDebugMode) {
       PluginManager.instance
         ..register(CustomPlugin());
       runApp(
         UMEWidget(
           child: MyApp(), 
           enable: true
         )
       );
     } else {
       runApp(MyApp());
     }
    
  6. Run your app

Access the nested widget debug kits quickly #

We introduce the PluggableWithNestedWidget from 0.3.0. It is used to insert nested Widgets in the Widget tree and quickly access embedded kits with nested widget.

For more details, see ./kits/flutter_ume_kit_ui/lib/components/color_picker/color_picker.dart and ./kits/flutter_ume_kit_ui/lib/components/touch_indicator/touch_indicator.dart.

The key steps are as follows:

  1. The class of your plugin should implement PluggableWithNestedWidget.
  2. Implements Widget buildNestedWidget(Widget child). Handling the nested widgets and returning the new Widget.

How to use UME in Release/Profile mode #

Once you use flutter_ume in Release/Profile mode, you agree that you will bear the relevant risks by yourself.

The maintainer of flutter_ume does not assume any responsibility for the accident caused by this.

We recommend not to use it in Release/Profile mode for the following reasons:

  1. VM Service is not available in these environments, so some functions are not available
  2. In this environment, developers need to isolate the app distribution channels by themselves to avoid submitting relevant debugging code to the production environment

In order to use in Release/Profile mode, the details that need to be adjusted in the normal access process:

  1. In pubspec.yaml, flutter_ume and plugins should be write below dependencies rather than dev_dependencies.
  2. Don't put the code which call PluginManager.instance.register() and UMEWidget(child: App()) into conditionals which represent debug mode. (Such as kDebugMode)
  3. Ensure the above details, run flutter clean and flutter pub get, then build your app.

About version #

Compatibility #

UME version1.12.131.22.32.0.12.2.32.5.32.8.03.0.53.3.1
0.1.x⚠️⚠️
0.2.x⚠️
0.3.x
1.0.x⚠️⚠️⚠️⚠️
1.1.x⚠️⚠️⚠️⚠️

⚠️ means the version has not been fully tested for compatibility.

Coverage #

Packagemasterdevelopdevelop_nullsafety
flutter_umeCoverageCoverageCoverage
flutter_ume_kit_deviceCoverageCoverageCoverage
flutter_ume_kit_perfCoverageCoverageCoverage
flutter_ume_kit_show_codeCoverageCoverageCoverage
flutter_ume_kit_uiCoverageCoverageCoverage
flutter_ume_kit_consoleCoverageCoverageCoverage
flutter_ume_kit_dioCoverageN/ACoverage

Version upgrade rules #

Please refer to Semantic versions for details.

Null-safety #

PackageSuggest version
flutter_ume0.3.0+1
flutter_ume_kit_ui0.3.0+1
flutter_ume_kit_device0.3.0
flutter_ume_kit_perf0.3.0
flutter_ume_kit_show_code0.3.0
flutter_ume_kit_console0.3.0
flutter_ume_kit_dio0.3.0

Change log #

Changelog

Contributing #

Contributing rules: Contributing

Contributors #

Thanks to the following contributors (names not listed in order):

ShirelyCShirelyC
lpylpyleolpylpyleo
Alex LiAlex Li
SwainSwain
mengdouermengdouer
LAIIIHZLAIIIHZ
XinLeiXinLei
sulisuli

About the third-party open-source project dependencies #

  • The TouchIndicator use the pub touch_indicator, the ColorPicker use the pub cyclop.
  • We fork the package cyclop and modify some code meet our functional needs. We should depend cyclop by pub version after the PR being merged.

LICENSE #

This project is licensed under the MIT License - visit the LICENSE for details.

Contact the author #

Maybe...

  • Found a bug in the code, or an error in the documentation
  • Produces an exception when you use the UME
  • UME is not compatible with the new version Flutter
  • Have a good idea or suggestion

You can submit an issue in any of the above situations.

Maybe...

  • Communicate with the author
  • Communicate with more community developers
  • Cooperate with UME

Welcome to Join the ByteDance Flutter Exchange Group.

Or contact author.

59
likes
140
pub points
88%
popularity

Publisher

verified publisher iconopensource.bytedance.com

UME is an in-app debug kits platform for Flutter apps. Produced by Flutter Infra team of ByteDance.

Repository (GitHub)

Documentation

API reference

License

Icon for licenses.MIT (LICENSE)

Dependencies

flutter, flutter_localizations, shared_preferences, tuple, vm_service

More

Packages that depend on flutter_ume