compose-ui-book icon indicating copy to clipboard operation
compose-ui-book copied to clipboard

UI Component Explorer for Android

Android UI Book

Simple and extensible UI component explorer for Android

You can check the demo video here

Getting Started

Setup Module

Usually the UI component explorer is separated from the main app. So the first thing you should do is to create empty module with com.android.application plugin. After that:

In your root build.gradle

allprojects {
  repositories {
    ...
    maven { url 'https://jitpack.io' }
  }
}

And in your project build.gradle

dependencies {
  implementation 'com.github.esafirm.android-ui-book:browser:x.y.z'
  kapt 'com.github.esafirm.android-ui-book:processors:x.y.z'	
}

change x.y.z to version in the release page

Create First Book

To create book simple creat an extension function that extend BookHost, return View and give the function @UIBook annotation. In this case I will create a Kotlin file with name Catalogue.kt and then create this function:

@UIBook(name = "TextView")
fun BookHost.createTextView(text: String): TextView {
  /**
  * This will draw text
  */
  return TextView(context).apply {
    this.text = text
    setTextColor(Color.RED)
  }
}

That's it now run the new module that you just created.

Advanced

For now, you can check :sample module for complete features.

Support

Buy Me a Coffee at ko-fi.com

License

Esa @ MIT