viddik-annotations/io.github.youndie.viddik.annotations

Package-level declarations

Types

data class ViddikComponent(val name: String, val group: String, val width: Int = 400, val height: Int = AUTO_HEIGHT, val fontScale: Float = 1.0f, val tolerancePercent: Double? = null, val content: @Composable () -> Unit)

ViddikPreviewLabel

interface ViddikPreviewLabel

ViddikScreenshot

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class ViddikScreenshot(val name: String = "", val group: String = "", val width: Int = UNSPECIFIED, val height: Int = UNSPECIFIED, val darkVariant: Boolean = false, val tolerancePercent: Double = UNSPECIFIED_TOLERANCE)

Marks a @Composable as a viddik fixture: one golden image, and one entry in the showroom.

Properties

AUTO_HEIGHT

const val AUTO_HEIGHT: Int

UNSPECIFIED

const val UNSPECIFIED: Int

A ViddikScreenshot size that was not given, as opposed to one that was given as a number.

UNSPECIFIED_TOLERANCE

const val UNSPECIFIED_TOLERANCE: Double

A ViddikScreenshot tolerance that was not given, for the same reason UNSPECIFIED exists: KSP substitutes the default before the processor sees it, so the default has to be a value no one would write. A tolerance is a share of pixels, so a negative one is exactly that.