Adding generateScreenshot into ShowkaseComposable annotation #360
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
October 11, 2023 12:20
…ation * writing functionName property into the generated files this is already defined into ShowkaseMetadata.elementName * creating MyPaparazziShowkaseScreenshotTestFiltered.kt to generate the screenshots for previews that have the new property generateScreenshot = true * updating BasicChip.kt to use generateScreenshot property in the two previews defined on it
|
@marcorighini maybe you can help me out here, what do I need to get feedback for this PR? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.