core/me.tbsten.compose.preview.lab

Package-level declarations

Types

data class CollectedPreview(val id: String, val displayName: String = id, val filePath: String? = null, val startLineNumber: Int? = null, val endLineNumber: Int? = null, val code: String? = null, val kdoc: String? = null, val content: @Composable () -> Unit) : PreviewLabPreview

LabPreview

@Preview(widthDp = 800, heightDp = -1)

annotation class LabPreview

PreviewLabEvent

@Immutable

data class PreviewLabEvent(val title: String, val description: String? = null, val createAt: Instant = Clock.System.now())

Represents an event that occurred during preview interaction

PreviewLabPreview

interface PreviewLabPreview

Have me.tbsten.compose.preview.lab.gallery.previewlist.PreviewTreeNode.Preview information collected by gradle plugin. It can be used to display the Preview catalog by passing it to PreviewLabGallery.

Properties

LocalIsInPreviewLabGalleryCardBody

val LocalIsInPreviewLabGalleryCardBody: ProvidableCompositionLocal<Boolean>

CompositionLocal that indicates whether the current composition is inside a PreviewLabGallery card body. When true, PreviewLab will skip rendering its full UI and only render the preview content directly. This is used to show scaled-down preview thumbnails in the gallery view.

LocalPreviewLabPreview

val LocalPreviewLabPreview: ProvidableCompositionLocal<PreviewLabPreview?>

CompositionLocal that provides the current PreviewLabPreview being displayed. This is set by PreviewLabGallery when a preview is selected.

Functions

collectAllModulePreviews

fun collectAllModulePreviews(): Lazy<List<CollectedPreview>>

Returns a Lazy that provides the list of @Preview functions collected from this module and all dependency modules that export their preview properties.

collectModulePreviews

fun collectModulePreviews(): Lazy<List<CollectedPreview>>

Returns a Lazy that provides the list of @Preview functions collected from this module only.

PreviewLabPreview

fun PreviewLabPreview(id: String, displayName: String = id, filePath: String? = null, startLineNumber: Int? = null, endLineNumber: Int? = null, code: String? = null, kdoc: String? = null, content: @Composable () -> Unit): PreviewLabPreview

Create a CollectedPreview instance.