flutter_ume

简体中文

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

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

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.

Please see Plugins from community to make your flutter_ume stronger.

• flutter_ume
  • Quick Start
  • IMPORTANT
  • Features
  • Develop plugin kits for UME
  • Access the nested widget debug kits quickly
  • How to use UME in Release/Profile mode
  • About version
  • Compatibility
  • Coverage
  • Version upgrade rules
  • Null-safety
  • Change log
  • Contributing
  • Contributors
  • Plugins from community
  • About the third-party open-source project dependencies
  • LICENSE
  • Contact the author

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.

   yaml 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

2. Run flutter pub get

3. Import packages

   dart 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

4. Edit main method of your app, register plugin kits and initial UME

   dart 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()); } }

5. flutter run for running or flutter build apk --debug、flutter 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 .

Features

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

UI kits
Widget Info	Widget Detail	Align Ruler
Color Picker	Color Sucker	Touch Indicator
Performance Kits
Memory Info	Perf Overlay
Device Info Kits
CPU Info	Device Info
Show Code
Show Code
Console
Console
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.

   yaml dependencies: flutter_ume: '>=0.3.0 <0.4.0'

3. Create the class of the plugin kit which should implement Pluggable.

   ``` dart import 'package:flutterume/flutterume.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