airbnb / Showkase

🔦 Showkase is an annotation-processor based Android library that helps you organize, discover, search and visualize Jetpack Compose UI elements
https://medium.com/airbnb-engineering/introducing-showkase-a-library-to-organize-discover-and-visualize-your-jetpack-compose-elements-d5c34ef01095
Apache License 2.0
2.08k stars 106 forks source link

Adding generateScreenshot into ShowkaseComposable annotation #360

Open IvanSanchez-uam opened 9 months ago

IvanSanchez-uam commented 9 months ago

The generateScreenshot property is used when showkase is integrated with paparazzi and the purpose of it is to filter all the previews that we want the screenshot test.

the next code snippet shows the usage of generateScreenshot

// This preview will be skipped from component browser // but will generate the screenshot @ShowkaseComposable( name = "Basic Chip", group = "Chips", defaultStyle = true, generateScreenshot = true, skip = true ) @Composable fun BasicChipPreview() { BasicChip(text = "Chip Component") }

As you can see the screenshot test will be generated for the preview but will not be part of the component browser.

The main idea of this pr is to have the ability to recognize previews that we want to make the screenshot test.

IvanSanchez-uam commented 7 months ago

@marcorighini maybe you can help me out here, what do I need to get feedback for this PR?