Skip to content

Space UI component #5197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Aug 21, 2025
Merged
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ open class AvatarDataProvider : PreviewParameterProvider<AvatarData> {
.map {
sequenceOf(
anAvatarData(size = it),
anAvatarData(size = it).copy(name = null),
anAvatarData(size = it).copy(url = "aUrl"),
anAvatarData(size = it, name = null),
anAvatarData(size = it, url = "aUrl"),
)
}
.flatten()
Expand All @@ -26,10 +26,12 @@ open class AvatarDataProvider : PreviewParameterProvider<AvatarData> {
fun anAvatarData(
// Let's the id not start with a 'a'.
id: String = "@id_of_alice:server.org",
name: String = "Alice",
name: String? = "Alice",
url: String? = null,
size: AvatarSize = AvatarSize.RoomListItem,
) = AvatarData(
id = id,
name = name,
url = url,
size = size,
)
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,6 @@ enum class AvatarSize(val dp: Dp) {
DmCreationConfirmation(64.dp),

UserVerification(52.dp),

OrganizationHeader(64.dp),
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
/*
* Copyright 2025 New Vector Ltd.
*
* SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
* Please see LICENSE files in the repository root for full details.
*/

package io.element.android.libraries.matrix.ui.components

import androidx.compose.foundation.border
import androidx.compose.foundation.clickable
import androidx.compose.foundation.interaction.MutableInteractionSource
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.layout.size
import androidx.compose.foundation.layout.width
import androidx.compose.foundation.shape.CircleShape
import androidx.compose.material3.ripple
import androidx.compose.runtime.Composable
import androidx.compose.runtime.CompositionLocalProvider
import androidx.compose.runtime.remember
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.clip
import androidx.compose.ui.draw.drawWithContent
import androidx.compose.ui.geometry.Offset
import androidx.compose.ui.graphics.BlendMode
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.graphics.CompositingStrategy
import androidx.compose.ui.graphics.graphicsLayer
import androidx.compose.ui.platform.LocalLayoutDirection
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.semantics.clearAndSetSemantics
import androidx.compose.ui.semantics.contentDescription
import androidx.compose.ui.semantics.onClick
import androidx.compose.ui.unit.LayoutDirection
import androidx.compose.ui.unit.dp
import io.element.android.compound.theme.ElementTheme
import io.element.android.compound.tokens.generated.CompoundIcons
import io.element.android.libraries.designsystem.components.avatar.Avatar
import io.element.android.libraries.designsystem.components.avatar.AvatarData
import io.element.android.libraries.designsystem.components.avatar.AvatarSize
import io.element.android.libraries.designsystem.components.avatar.AvatarType
import io.element.android.libraries.designsystem.components.avatar.anAvatarData
import io.element.android.libraries.designsystem.preview.ElementPreview
import io.element.android.libraries.designsystem.preview.PreviewsDayNight
import io.element.android.libraries.designsystem.text.toPx
import io.element.android.libraries.designsystem.theme.components.Icon
import io.element.android.libraries.designsystem.theme.components.Surface
import io.element.android.libraries.ui.strings.CommonStrings

/**
* Ref: https://www.figma.com/design/G1xy0HDZKJf5TCRFmKb5d5/Compound-Android-Components?node-id=3643-2678&m=dev
*/
@Composable
fun EditableOrgAvatar(
avatarData: AvatarData,
onEdit: () -> Unit,
modifier: Modifier = Modifier,
) {
val actionEdit = stringResource(id = CommonStrings.action_edit)
val description = stringResource(CommonStrings.a11y_avatar)
Box(
modifier = modifier
.width(avatarData.size.dp + 16.dp)
.clearAndSetSemantics {
contentDescription = description
// Note: this does not set the click effect to the whole Box
// when talkback is not enabled
onClick(
label = actionEdit,
action = {
onEdit()
true
}
)
}
) {
val isRtl = LocalLayoutDirection.current == LayoutDirection.Rtl
val editIconRadius = 17.dp.toPx()
val editIconXOffset = 7.dp.toPx()
val editIconYOffset = 15.dp.toPx()
Avatar(
avatarData = avatarData,
avatarType = AvatarType.Space(false),
modifier = Modifier
.align(Alignment.Center)
.graphicsLayer {
compositingStrategy = CompositingStrategy.Offscreen
}
.drawWithContent {
drawContent()
val xOffset = if (isRtl) {
editIconXOffset
} else {
size.width - editIconXOffset
}
drawCircle(
color = Color.Black,
center = Offset(
x = xOffset,
y = size.height - editIconYOffset,
),
radius = editIconRadius,
blendMode = BlendMode.Clear,
)
},
)
Surface(
color = ElementTheme.colors.bgCanvasDefault,
modifier = Modifier
.clip(CircleShape)
.size(30.dp)
.border(1.dp, color = ElementTheme.colors.borderInteractiveSecondary, shape = CircleShape)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't Surface already have shape and borderStroke parameters?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I forgot about it. dc0d810

.align(Alignment.BottomEnd)
.clickable(
indication = ripple(),
interactionSource = remember { MutableInteractionSource() },
onClick = onEdit,
),
) {
Icon(
imageVector = CompoundIcons.Edit(),
// Note: keep the context description for the test
contentDescription = stringResource(id = CommonStrings.action_edit),
tint = ElementTheme.colors.iconPrimary,
modifier = Modifier.padding(6.dp)
)
}
}
}

@PreviewsDayNight
@Composable
internal fun EditableOrgAvatarPreview() = ElementPreview {
EditableOrgAvatar(
avatarData = anAvatarData(
url = "anUrl",
size = AvatarSize.OrganizationHeader,
),
onEdit = {},
)
}

@PreviewsDayNight
@Composable
internal fun EditableOrgAvatarRtlPreview() = CompositionLocalProvider(
LocalLayoutDirection provides LayoutDirection.Rtl,
) {
ElementPreview {
EditableOrgAvatar(
avatarData = anAvatarData(
url = "anUrl",
size = AvatarSize.OrganizationHeader,
),
onEdit = {},
)
}
}