Jenga/io.github.joelkanyi.jenga.component.icon/JengaIconTile

JengaIconTile

fun JengaIconTile(icon: ImageVector, contentDescription: String?, modifier: Modifier = Modifier, tone: JengaBadgeTone = JengaBadgeTone.Neutral, size: JengaIconTileSize = JengaIconTileSize.Medium, colors: JengaIconTileColors = JengaIconTileDefaults.colors(tone), shape: Shape = JengaIconTileDefaults.shape, tileSize: Dp = JengaTheme.components.iconTile?.size(size)?.tileSize ?: JengaIconTileDefaults.tileSize(size), iconSize: Dp = JengaTheme.components.iconTile?.size(size)?.iconSize ?: JengaIconTileDefaults.iconSize(size))(source)

An icon on a rounded-square tile, tinted by tone. Use it as the leading visual of a list row or card, where a bare JengaIcon reads too light.

JengaBadgeTone.Neutral sits on a subtle surface; every other tone sits on its soft container with the matching foreground.

Parameters

icon

the icon to draw (e.g. from JengaIcons).

contentDescription

accessibility label; null marks the tile decorative.

modifier

the Modifier for this tile.

tone

the semantic tone driving the tile and icon colors.

size

the tile size; see JengaIconTileSize.

colors

the color set; defaults to JengaIconTileDefaults.colors for tone.

shape

the tile shape.

tileSize

the tile's edge length; defaults to the theme's value for size, else JengaIconTileDefaults.tileSize.

iconSize

the icon's edge length; defaults to the theme's value for size, else JengaIconTileDefaults.iconSize.

Samples

JengaIconTile(
    icon = JengaIcons.Wrench,
    contentDescription = null,
    tone = JengaBadgeTone.Brand,
)