annotation/me.tbsten.compose.preview.lab

Package-level declarations

Types

This is an internal annotation for Compose Preview Lab. Don't use this api manually.

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class ComposePreviewLabOption(val displayName: String = "{{qualifiedName}}", val ignore: Boolean = false, val id: String = "{{qualifiedName}}", val collectScopes: Array<String> = [DefaultCollectScope])

By default, the qualifiedName of the Preview (ex. com.example.my.buttons.MyButtonPreview) is used as the Preview name, but this can be overridden by displayName. The name MyButtonPreview can be displayed on ComposePreviewLab by specifying the following.

ExperimentalComposePreviewLabApi

@RequiresOptIn(message = "This API is experimental. It could change in the future without notice.")

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.VALUE_PARAMETER])

annotation class ExperimentalComposePreviewLabApi

The API marked with this annotation is experimental and unstable. Binary compatibility is not guaranteed and may be changed or removed in the future.

InternalComposePreviewLabApi

@RequiresOptIn(message = "This API is for internal. It could change in the future without notice.")

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.PROPERTY_SETTER])

annotation class InternalComposePreviewLabApi

The API marked with this annotation is internal and should not be used outside of the Compose Preview Lab library. If for some reason you have no choice but to use the library, please take the latest precautions when updating the library. It may change or be removed in future versions without notice.

SyntheticPreviewHint

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

annotation class SyntheticPreviewHint

Marker annotation attached by the Compose Preview Lab compiler plugin to every synthesized previewHint_<scope> overload and PreviewHintMarker_* class. The IR-side hint discovery (HintDiscovery.discoverHints) requires this marker on candidate hint declarations before accepting them — declarations that share the me.tbsten.compose.preview.lab.hints package but lack @SyntheticPreviewHint are rejected with a compile-time warning so a third-party library cannot squat the hint package and inject its own previews into a downstream consumer's collectAllModulePreviews().

UiComposePreviewLabApi

@RequiresOptIn(message = "This API is for UI components. It could change in the future without notice.")

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.PROPERTY_SETTER])

annotation class UiComposePreviewLabApi

The API marked with this annotation is the UI component API. These UI components are designed for use within the Compose Preview Lab library, but can be used by users who want to customize the UI. Binary compatibility is not guaranteed and may be changed in future versions.