JengaAvatar

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))(source)

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

For an image avatar, use the content slot overload.

Parameters

name

the full name; initials are derived from its first two words.

modifier

the Modifier for this avatar.

size

the avatar size preset; see JengaAvatarSize.

diameter

the avatar diameter; defaults to the size preset.

textStyle

the initials text style; defaults to the size preset.

Samples

JengaAvatar(
    name = "Ada Lovelace",
)

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

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

Parameters

modifier

the Modifier for this avatar.

size

the avatar size preset; see JengaAvatarSize.

diameter

the avatar diameter; defaults to the size preset.

content

the avatar content, clipped to the circle (e.g. an Image).