gravatar-ui/com.gravatar.ui.components.atomic/Avatar

Avatar

@Composable
fun Avatar(profile: Profile, size: Dp, modifier: Modifier = Modifier, avatarQueryOptions: AvatarQueryOptions? = null, forceRefresh: Boolean = false)

Avatar is a composable that displays a user's avatar.

Parameters

profile

The user's profile information

size

The size of the avatar

modifier

Composable modifier

avatarQueryOptions

Options to customize the avatar query

forceRefresh

While this is true, we'll force the refresh of the avatar in every recomposition. When false, we'll use the default URL for that profile (without cache buster) to fetch the avatar.

@Composable
fun Avatar(state: ComponentState<Profile>, size: Dp, modifier: Modifier = Modifier, avatarQueryOptions: AvatarQueryOptions? = null, forceRefresh: Boolean = false)

Avatar is a composable that displays a user's avatar.

Parameters

state
size

The size of the avatar

modifier

Composable modifier

avatarQueryOptions

Options to customize the avatar query

forceRefresh

While this is true, we'll force the refresh of the avatar in every recomposition

@Composable
fun Avatar(state: ComponentState<String>, size: Dp, modifier: Modifier = Modifier)

Avatar is a composable that displays a user's avatar.

Parameters

state

The state of the avatar, when loaded it should contain the Avatar URL

size

The size of the avatar

modifier

Composable modifier

@Composable
fun Avatar(email: Email, size: Dp, modifier: Modifier = Modifier, avatarQueryOptions: AvatarQueryOptions? = null, cacheBuster: String? = null)

Atomic Avatar composable that displays a user's avatar that is generated from the user's email address. A skeleton overlay will be shown while loading the image.

Parameters

email

The user's email address

size

The size of the avatar

modifier

Composable modifier

avatarQueryOptions

Options to customize the avatar query

cacheBuster

Random string value to force a cache bust