com.airbnb.android.showkase.annotation.ShowkaseScreenshot.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

import kotlin.reflect.KClass


/**
 * Used to annotate the [ShowkaseScreenshotTest] implementation class. This is needed to let
 * Showkase know that it needs to generate screenshot tests for your UI elements that are integrated
 * with Showkase.
 *
 * 
 * Here's an example of how you would typically use it:
 *
 * @ShowkaseScreenshotTest
 * abstract class MyScreenshotTest: ShowkaseScreenshotModule {
 *   override fun onScreenshot(
 *       id: String,
 *       name: String,
 *       group: String,
 *       screenshotType: ShowkaseScreenshotType,
 *       screenshotBitmap: Bitmap
 *   ) {
 *       // Here you do the action you want to take with the screenshot.
 *   }
 * }
 *
 * 
 *
 * Note: you should add this class to the androidTest sourceSet as that's where your testing
 * dependencies will exists otherwise the generated test won't compile.Additionally,its important
 * that the class you annotate with [ShowkaseScreenshot] is either abstract or open as Showkase
 * generates a class that extends this class in order to get access to the onScreenshot method.
 *
 * @param rootShowkaseClass: Pass the [ShowkaseRoot] declaration that you declared when setting up
 * Compose. If you have multiple implementations of [ShowkaseRoot], pass the one that you want to
 * test.
 */
@MustBeDocumented
@Retention(AnnotationRetention.SOURCE)
@Target(AnnotationTarget.CLASS)
annotation class ShowkaseScreenshot(
    val rootShowkaseClass: KClass<*>
)