gallery/me.tbsten.compose.preview.lab.gallery

Package-level declarations

Types

NoOpPreviewLabGalleryNavigator

object NoOpPreviewLabGalleryNavigator : PreviewLabGalleryNavigator

PreviewLabGalleryNavigator

interface PreviewLabGalleryNavigator

PreviewLabGalleryState

@Stable

class PreviewLabGalleryState(initialSelectedPreview: Pair<String, PreviewLabPreview>? = null)

State holder for PreviewLabGallery.

SelectedPreview

class SelectedPreview(val groupName: String, val preview: PreviewLabPreview, val title: String = preview.displayName)

Properties

AllGroupName

const val AllGroupName: String

The default group name used for showing all previews in the PreviewLabGallery. This group contains all previews regardless of their featured file categorization.

LocalPreviewLabGalleryNavigator

val LocalPreviewLabGalleryNavigator: ProvidableCompositionLocal<PreviewLabGalleryNavigator?>

Functions

navigateOr

inline fun PreviewLabGalleryNavigator?.navigateOr(id: String, fallback: () -> Unit)

PreviewLabGallery

@Composable

fun PreviewLabGallery(previewList: List<PreviewLabPreview>, modifier: Modifier = Modifier, state: PreviewLabGalleryState = remember { PreviewLabGalleryState() }, openFileHandler: OpenFileHandler<out Any?>? = null, featuredFileList: Map<String, List<String>> = emptyMap(), noSelectedContents: @Composable (Map<String, List<PreviewLabPreview>>) -> Unit = { groupedPreviews -> PreviewListGrid( groupedPreviewList = groupedPreviews, onPreviewClick = { group, preview -> state.select(group, preview) }, contentPadding = PaddingValues(adaptive(12.dp, 20.dp)), ) })

A Composable function that catalogs and displays a list of Previews. The left sidebar actually displays the list of Previews, and the selected Preview is displayed in the center of the screen.

PreviewListGrid

@Composable

fun PreviewListGrid(groupedPreviewList: Map<String, List<PreviewLabPreview>>, onPreviewClick: (String, PreviewLabPreview) -> Unit, contentPadding: PaddingValues = PaddingValues.Zero)

PreviewListGridCard

@Composable

fun PreviewListGridCard(preview: PreviewLabPreview, onClick: () -> Unit)