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

Package-level declarations

JengaAvatar: initials or an image in a circle, in fixed sizes.

Types

Defaults for JengaAvatar. textStyle follows the theme's JengaAvatarStyle; diameter is Jenga's built-in value, and JengaAvatar resolves the theme's diameter over it.

JengaAvatarSize

enum JengaAvatarSize : Enum<JengaAvatarSize>

Size of a JengaAvatar.

JengaAvatarSizeStyle

@Immutable

class JengaAvatarSizeStyle(val diameter: Dp? = null, val textStyle: TextStyle? = null)

Theme-wide metrics for one JengaAvatarSize, part of a JengaAvatarStyle. A null value keeps Jenga's default.

JengaAvatarStyle

@Immutable

class JengaAvatarStyle(val small: JengaAvatarSizeStyle? = null, val medium: JengaAvatarSizeStyle? = null, val large: JengaAvatarSizeStyle? = null)

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

Functions

JengaAvatar

@Composable

fun JengaAvatar(modifier: Modifier = Modifier, size: JengaAvatarSize = JengaAvatarSize.Medium, diameter: Dp = JengaTheme.components.avatar?.size(size)?.diameter ?: JengaAvatarDefaults.diameter(size), content: @Composable () -> Unit)

A circular avatar with custom content (e.g. an image), clipped to a circle.

@Composable

fun JengaAvatar(name: String, modifier: Modifier = Modifier, size: JengaAvatarSize = JengaAvatarSize.Medium, diameter: Dp = JengaTheme.components.avatar?.size(size)?.diameter ?: JengaAvatarDefaults.diameter(size), textStyle: TextStyle = JengaAvatarDefaults.textStyle(size))

A circular avatar showing up to two initials derived from name.