Skip to content

Repository files navigation

Android DebugKit

LicenseDownload

DebugKit lib for Android allows you to use a fancy hovering debug tool to trigger some actions directly in the app. This tool is very useful to trigger some event at runtime, and to have a written feedback directly on your testing phone screen.

Requirements

  • Android SDK 15+

Example

You can download an example apk here : DebugKit-Example.apk

Installation

repositories {
jcenter()
}
dependencies {
compile 'com.hulab.android:debugkit:1.2.1'
}

Usage

finalDevTool.Builderbuilder = newDevTool.Builder(mContext);
builder.addFunction(newDebugFunction() {
@OverridepublicStringcall() throwsException {
log("doing some stuff...");
doSomeStuff();
return"Some stuff was done.";
}
}).addFunction(newDebugFunction() {
@OverridepublicStringcall() throwsException {
log("doing some other stuff...");
doSomeStuff();
return"Some stuff was done.";
}
}).addFunction(newDebugFunction("My function") {
@OverridepublicStringcall() throwsException {
log("doing some stuff again and again...");
doSomeStuff();
return"This function has a title!";
}
}); // This is a prebuilt function to clear the console, you can call clear() in any function// as well.
.addFunction(newDebugFunction.Clear("Clear"))
// This is a prebuilt function to dump the content of your shared preferences file.
.addFunction(newDebugFunction.DumpSharedPreferences("Shared prefs", PREFS_FILE_NAME));
// optional, DevToolFragment.DevToolTheme.DARK is set by defaultbuilder.setTheme(DevToolFragment.DevToolTheme.DARK)
//you can set the initial position of your debug tool (0,0) by default
.displayAt(100, 100)
.build();

Result

Here we have 3 debug tools, from top to bottom:

  • LIGHT theme with 5 defined functions
  • Minified mode (clicking on the top left corner arrow)
  • DARK theme with 3 defined functions and the logged text when clicking on each F1, F2 and F3

Screenshot.png


dark themelight theme


Have fun!

About

Ever hid debug functions in your UI? Here is now a clean way to do it!

Resources

Stars

649 stars

Watchers

12 watching

Forks

Releases

Packages

Used by

Contributors

Languages