com.airbnb.android.showkase.annotation.ShowkaseRoot.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of showkase-annotation Show documentation

Showkase is an Android library that helps you organize, discover, search and visualize Jetpack Compose components.

There is a newer version: 1.0.3

package com.airbnb.android.showkase.annotation

/**
 * Used to annotate the [ShowkaseRootModule] implementation class. This is needed to let Showkase
 * know more about the module that is going to be the root module for aggregating all the Showkase 
 * supported UI elements across all the different modules(if you are using a multi-module 
 * project). If you are only using a single module in your project, add it to that module. You 
 * are allowed to have only one @ShowkaseRoot per module.
 * 
 * 
 * Here's an example of how you would use it:
 *
 * @ShowkaseRoot
 * fun MyRootModule: ShowkaseRootModule
 * 
 * 
 * The root module that you declare is also important to start the Showkase browser in order to 
 * view your composables. You will have to pass in the canonical name of this implementation when
 * starting the [ShowkaseBrowserActiity]. Here's is how you would do it:
 * 
 * startActivity(ShowkaseBrowserActivity.getIntent(this, MyRootModule::class.java.canonicalName!!))
 */
@MustBeDocumented
@Retention(AnnotationRetention.SOURCE)
@Target(AnnotationTarget.CLASS)
annotation class ShowkaseRoot