Jenga/io.github.joelkanyi.jenga.component.shelf

Package-level declarations

JengaImageShelf with JengaShelfCard, and JengaThumbnailStrip.

Types

JengaShelfDefaults

object JengaShelfDefaults

Defaults and token mappings for JengaImageShelf/JengaShelfCard.

JengaThumbnailStripColors

@Immutable

class JengaThumbnailStripColors(val thumbnail: Color, val addBorder: Color, val addContent: Color)

Resolved colors for a JengaThumbnailStrip. Override via JengaThumbnailStripDefaults.colors.

JengaThumbnailStripDefaults

object JengaThumbnailStripDefaults

Defaults and token mappings for JengaThumbnailStrip. The composable members follow the theme's JengaThumbnailStripStyle; the constants are Jenga's built-in values, and JengaThumbnailStrip resolves the theme's values over them.

JengaThumbnailStripLayout

enum JengaThumbnailStripLayout : Enum<JengaThumbnailStripLayout>

How a JengaThumbnailStrip lays out its tiles.

JengaThumbnailStripStyle

@Immutable

class JengaThumbnailStripStyle(val thumbnailSize: Dp? = null, val spacing: Dp? = null, val contentPadding: PaddingValues? = null, val shape: Shape? = null, val colors: JengaThumbnailStripColors? = null)

Theme-wide style for every JengaThumbnailStrip, set through io.github.joelkanyi.jenga.theme.JengaComponentStyles.thumbnailStrip. A null value keeps Jenga's default; arguments passed to a call still win.

Functions

JengaImageShelf

@Composable

fun JengaImageShelf(title: String, modifier: Modifier = Modifier, eyebrow: String? = null, subtitle: String? = null, action: JengaAction? = null, gutter: Dp = JengaShelfDefaults.Gutter, content: @Composable () -> Unit)

A horizontal, edge-to-edge shelf: an optional eyebrow + title header with an optional trailing action, over a horizontally scrolling row of content (typically JengaShelfCards). Content is inset by the screen gutter so cards bleed to the edges as they scroll. Generic and domain-neutral.

JengaShelfCard

@Composable

fun JengaShelfCard(title: String, modifier: Modifier = Modifier, imageUrl: String? = null, meta: String? = null, width: Dp = JengaShelfDefaults.CardWidth, aspectRatio: Float = JengaShelfDefaults.CardAspectRatio, onClick: () -> Unit? = null, overlayTag: @Composable () -> Unit? = null, fallback: Brush = JengaShelfDefaults.fallback, fallbackContent: @Composable BoxScope.() -> Unit? = null)

A single card in a JengaImageShelf: an image slot (cropped, with a themed fallback and an optional overlayTag), a title, and an optional meta line. Generic and token-driven.

JengaThumbnailStrip

@Composable

fun JengaThumbnailStrip(count: Int, modifier: Modifier = Modifier, onAdd: () -> Unit? = null, addContentDescription: String? = null, addIcon: @Composable () -> Unit = { JengaIcon(JengaTheme.icons.add, contentDescription = null) }, thumbnailSize: Dp = JengaTheme.components.thumbnailStrip?.thumbnailSize ?: JengaThumbnailStripDefaults.ThumbnailSize, spacing: Dp = JengaThumbnailStripDefaults.spacing, contentPadding: PaddingValues = JengaThumbnailStripDefaults.contentPadding, shape: Shape = JengaThumbnailStripDefaults.shape, colors: JengaThumbnailStripColors = JengaThumbnailStripDefaults.colors(), layout: JengaThumbnailStripLayout = JengaThumbnailStripLayout.Row, thumbnail: @Composable (index: Int) -> Unit)

Square thumbnails (e.g. photos attached to a record) with an optional dashed "add" tile at the end, in one scrolling row or wrapped over several lines (see layout). Each thumbnail slot is clipped to shape and sized to thumbnailSize; put an image and any tap handling there.