stream-video-android-ui-compose/io.getstream.video.android.compose.ui.components.avatar

Package-level declarations

Types

Link copied to clipboard
enum OnlineIndicatorAlignment : Enum<OnlineIndicatorAlignment>

Represents the position of the online indicator in user avatars.

Properties

Link copied to clipboard
val LocalAvatarLoadingPlaceholder: ProvidableCompositionLocal<Int?>

Local containing the preferred loading placeholder for providing the same instance in our composable hierarchy.

Link copied to clipboard
val LocalAvatarPreviewPlaceholder: ProvidableCompositionLocal<Int>

Local containing the preferred preview placeholder for providing the same instance in our composable hierarchy.

Functions

Link copied to clipboard
@Composable
fun OnlineIndicator(modifier: Modifier = Modifier)

Component that represents an online indicator to be used with UserAvatar.

Link copied to clipboard
@Composable
fun UserAvatar(modifier: Modifier = Modifier, userImage: String? = null, userName: String? = null, shape: Shape = VideoTheme.shapes.circle, imageScale: ContentScale = ContentScale.Crop, imageDescription: String? = null, imageRequestSize: IntSize = IntSize(DEFAULT_IMAGE_SIZE, DEFAULT_IMAGE_SIZE), @DrawableRes loadingPlaceholder: Int? = LocalAvatarPreviewProvider.getLocalAvatarLoadingPlaceholder(), @DrawableRes previewModePlaceholder: Int = LocalAvatarPreviewProvider.getLocalAvatarPreviewPlaceholder(), textStyle: TextStyle = VideoTheme.typography.titleM, textOffset: DpOffset = DpOffset(0.dp, 0.dp), isShowingOnlineIndicator: Boolean = false, onlineIndicatorAlignment: OnlineIndicatorAlignment = OnlineIndicatorAlignment.TopEnd, onlineIndicator: @Composable BoxScope.() -> Unit = { DefaultOnlineIndicator(onlineIndicatorAlignment) }, onClick: () -> Unit? = null)

Component that renders an image or a name as an avatar. If the image is null or unavailable, it uses the name initials. Can also show an "is online" indicator. If needed, the initials font size is gradually decreased automatically until the text fits within the avatar boundaries.

Link copied to clipboard
@Composable
fun UserAvatarBackground(modifier: Modifier = Modifier, userImage: String?, userName: String?, shape: Shape = VideoTheme.shapes.circle, avatarSize: Dp = VideoTheme.dimens.genericMax, imageScale: ContentScale = ContentScale.Crop, imageDescription: String? = null, imageRequestSize: IntSize = IntSize(DEFAULT_IMAGE_SIZE, DEFAULT_IMAGE_SIZE), @DrawableRes loadingPlaceholder: Int? = LocalAvatarPreviewProvider.getLocalAvatarLoadingPlaceholder(), @DrawableRes previewModePlaceholder: Int = LocalAvatarPreviewProvider.getLocalAvatarPreviewPlaceholder(), textStyle: TextStyle = VideoTheme.typography.titleM, textOffset: DpOffset = DpOffset(0.dp, 0.dp))

Component that displays a user avatar and a background that reflects the avatar.