Merge pull request #1 from amsavarthan/dev

Adds label as tooltip for reaction item
amsavarthan · Apr 17, 2024 · 7228860 · 7228860
2 parents d204979 + 4d0cca6
commit 7228860
Show file tree

Hide file tree

Showing 3 changed files with 104 additions and 54 deletions.
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -1,16 +1,15 @@
 [versions]
-agp = "8.3.1"
+agp = "8.3.2"
 kotlin = "1.9.22"
 material = "1.11.0"
 activityCompose = "1.8.2"
-composeBom = "2024.03.00"
+composeBom = "2024.04.00"
 
 [libraries]
 material = { group = "com.google.android.material", name = "material", version.ref = "material" }
 androidx-activity-compose = { group = "androidx.activity", name = "activity-compose", version.ref = "activityCompose" }
 androidx-compose-bom = { group = "androidx.compose", name = "compose-bom", version.ref = "composeBom" }
 androidx-ui = { group = "androidx.compose.ui", name = "ui" }
-androidx-foundation = { group = "androidx.compose.foundation", name = "foundation" }
 androidx-ui-graphics = { group = "androidx.compose.ui", name = "ui-graphics" }
 androidx-material3 = { group = "androidx.compose.material3", name = "material3" }
 

diff --git a/library/build.gradle.kts b/library/build.gradle.kts
@@ -55,7 +55,7 @@ dependencies {
     implementation(platform(libs.androidx.compose.bom))
     implementation(libs.androidx.ui)
     implementation(libs.androidx.ui.graphics)
-    implementation(libs.androidx.foundation)
+    implementation(libs.androidx.material3)
 
 }
 
@@ -67,7 +67,7 @@ afterEvaluate {
 
                 groupId = "com.github.amsavarthan"
                 artifactId = "reaction-picker"
-                version = "1.0.0"
+                version = "1.1.0"
 
                 pom {
                     name = "Reaction Picker"

diff --git a/library/src/main/java/dev/amsavarthan/reaction/picker/ReactionPicker.kt b/library/src/main/java/dev/amsavarthan/reaction/picker/ReactionPicker.kt
@@ -1,21 +1,16 @@
 package dev.amsavarthan.reaction.picker
 
 import androidx.activity.compose.BackHandler
-import androidx.compose.animation.AnimatedVisibility
 import androidx.compose.animation.core.Animatable
 import androidx.compose.animation.core.animateDpAsState
 import androidx.compose.animation.core.tween
-import androidx.compose.animation.fadeIn
-import androidx.compose.animation.fadeOut
-import androidx.compose.animation.slideInVertically
 import androidx.compose.foundation.Image
 import androidx.compose.foundation.background
 import androidx.compose.foundation.gestures.awaitEachGesture
 import androidx.compose.foundation.gestures.awaitFirstDown
 import androidx.compose.foundation.gestures.waitForUpOrCancellation
 import androidx.compose.foundation.layout.Arrangement
 import androidx.compose.foundation.layout.Box
-import androidx.compose.foundation.layout.Column
 import androidx.compose.foundation.layout.IntrinsicSize
 import androidx.compose.foundation.layout.Row
 import androidx.compose.foundation.layout.fillMaxSize
@@ -26,13 +21,15 @@ 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.foundation.text.BasicText
+import androidx.compose.material3.ExperimentalMaterial3Api
+import androidx.compose.material3.Text
+import androidx.compose.material3.TooltipBox
+import androidx.compose.material3.rememberTooltipState
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.CompositionLocalProvider
 import androidx.compose.runtime.DisposableEffect
 import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.getValue
-import androidx.compose.runtime.movableContentOf
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
 import androidx.compose.runtime.rememberUpdatedState
@@ -56,19 +53,22 @@ import androidx.compose.ui.input.pointer.PointerType
 import androidx.compose.ui.input.pointer.pointerInput
 import androidx.compose.ui.layout.boundsInRoot
 import androidx.compose.ui.layout.onGloballyPositioned
-import androidx.compose.ui.layout.onPlaced
 import androidx.compose.ui.layout.onSizeChanged
 import androidx.compose.ui.platform.LocalDensity
 import androidx.compose.ui.platform.LocalHapticFeedback
 import androidx.compose.ui.platform.LocalLayoutDirection
 import androidx.compose.ui.platform.LocalView
 import androidx.compose.ui.res.painterResource
 import androidx.compose.ui.res.stringResource
+import androidx.compose.ui.unit.Dp
 import androidx.compose.ui.unit.IntOffset
+import androidx.compose.ui.unit.IntRect
 import androidx.compose.ui.unit.IntSize
+import androidx.compose.ui.unit.LayoutDirection
 import androidx.compose.ui.unit.dp
 import androidx.compose.ui.unit.roundToIntRect
 import androidx.compose.ui.util.fastForEach
+import androidx.compose.ui.window.PopupPositionProvider
 import androidx.compose.ui.zIndex
 import dev.amsavarthan.reaction.picker.enums.Placement
 import dev.amsavarthan.reaction.picker.models.Reaction
@@ -104,7 +104,7 @@ fun ReactionPickerLayout(
     containerColor: Color = Color.Black,
     containerShape: Shape = CircleShape,
     label: @Composable (String) -> Unit = { text ->
-        BasicText(text = text)
+        ReactionLabel(text = text)
     },
     icon: @Composable (Reaction) -> Unit = { reaction ->
         ReactionIcon(
@@ -143,6 +143,24 @@ fun ReactionPickerLayout(
     }
 }
 
+@Composable
+fun ReactionLabel(
+    text: String,
+    modifier: Modifier = Modifier,
+) {
+    Box(
+        modifier = modifier
+            .clip(CircleShape)
+            .background(Color.Black.copy(alpha = 0.5f))
+            .padding(horizontal = 6.dp, vertical = 2.dp)
+    ) {
+        Text(
+            text = text,
+            color = Color.White
+        )
+    }
+}
+
 @Composable
 private fun WrappedContent(
     state: ReactionPickerState?,
@@ -324,6 +342,7 @@ private fun ReactionPicker(
 
 }
 
+@OptIn(ExperimentalMaterial3Api::class)
 @Composable
 private fun AnimatedReactionItem(
     index: Int,
@@ -349,6 +368,7 @@ private fun AnimatedReactionItem(
 
     val currentOnShown by rememberUpdatedState(onShown)
     val currentOnDismiss by rememberUpdatedState(onDismiss)
+    val tooltipState = rememberTooltipState(isPersistent = true)
 
     // Calculate the offset multiplier based on the picker placement
     val offsetMultiplier = when (state.pickerPlacement) {
@@ -380,6 +400,7 @@ private fun AnimatedReactionItem(
     // Start animation when the picker is about to be dismissed
     LaunchedEffect(state.isVisible) {
         if (state.isVisible) return@LaunchedEffect
+        tooltipState.dismiss()
 
         // Concurrently animate the alpha and translation
         if (state.isDismissingWithSelection && state.selectedReaction === reaction) {
@@ -417,47 +438,45 @@ private fun AnimatedReactionItem(
         currentOnDismiss()
     }
 
-    Column(
-        modifier = modifier,
-        horizontalAlignment = Alignment.CenterHorizontally,
-        verticalArrangement = Arrangement.spacedBy(
-            space = properties.spaceBetweenReactionAndLabel
-        )
-    ) {
-        val iconSize by animateDpAsState(
-            label = "Reaction size",
-            targetValue = when {
-                state.hoveredReaction === reaction -> ReactionItemSizeOnHover
-                state.hoveredReaction != null -> ReactionItemSizeOnAnyHover
-                else -> ReactionItemSize
-            },
-        )
-
-        val movableLabel = remember {
-            movableContentOf {
-                AnimatedVisibility(
-                    visible = state.hoveredReaction === reaction,
-                    enter = slideInVertically { it * offsetMultiplier } + fadeIn(),
-                    exit = fadeOut(tween(Duration.VERY_SHORT_DURATION))
-                ) {
-                    val labelText = when {
-                        reaction.labelRes != null -> stringResource(id = reaction.labelRes)
-                        reaction.label != null -> reaction.label
-                        else -> throw IllegalStateException("Either label or labelRes should be provided")
-                    }
-                    label(labelText)
-                }
-            }
-        }
+    val iconSize by animateDpAsState(
+        label = "Reaction size",
+        targetValue = when {
+            state.hoveredReaction === reaction -> ReactionItemSizeOnHover
+            state.hoveredReaction != null -> ReactionItemSizeOnAnyHover
+            else -> ReactionItemSize
+        },
+    )
 
-        if (state.pickerPlacement == Placement.ABOVE) {
-            movableLabel()
+    LaunchedEffect(iconSize) {
+        //When icon size is about to be changed to ReactionItemSizeOnHover, show the tooltip
+        if (iconSize > ReactionItemSizeOnHover - 8.dp) {
+            tooltipState.show()
+        } else {
+            tooltipState.dismiss()
         }
+    }
 
-        val isSelectedReaction = state.selectedReaction === reaction
-
+    val isSelectedReaction = state.selectedReaction === reaction
+
+    TooltipBox(
+        state = tooltipState,
+        focusable = false,
+        enableUserInput = false,
+        positionProvider = rememberTooltipPositionProvider(
+            spacingBetweenTooltipAndAnchor = properties.spaceBetweenReactionAndLabel,
+            placement = state.pickerPlacement
+        ),
+        tooltip = {
+            val labelText = when {
+                reaction.labelRes != null -> stringResource(id = reaction.labelRes)
+                reaction.label != null -> reaction.label
+                else -> throw IllegalStateException("Either label or labelRes should be provided")
+            }
+            label(labelText)
+        },
+    ) {
         Box(
-            modifier = Modifier
+            modifier = modifier
                 .size(iconSize)
                 .graphicsLayer {
                     compositingStrategy = CompositingStrategy.ModulateAlpha
@@ -491,12 +510,44 @@ private fun AnimatedReactionItem(
                 icon(reaction)
             }
         }
+    }
 
-        if (state.pickerPlacement == Placement.BELOW) {
-            movableLabel()
-        }
+}
+
+@Composable
+private fun rememberTooltipPositionProvider(
+    spacingBetweenTooltipAndAnchor: Dp,
+    placement: Placement,
+): PopupPositionProvider {
+    val tooltipAnchorSpacing = with(LocalDensity.current) {
+        spacingBetweenTooltipAndAnchor.roundToPx()
     }
+    return remember(tooltipAnchorSpacing, placement) {
+        object : PopupPositionProvider {
+            override fun calculatePosition(
+                anchorBounds: IntRect,
+                windowSize: IntSize,
+                layoutDirection: LayoutDirection,
+                popupContentSize: IntSize,
+            ): IntOffset {
+                val x = anchorBounds.left + (anchorBounds.width - popupContentSize.width) / 2
+
+                val y = when (placement) {
+                    Placement.ABOVE -> {
+                        // Tooltip prefers to be above the anchor,
+                        // but if this causes the tooltip to overlap with the anchor
+                        // then we place it below the anchor
+                        val posY = anchorBounds.top - popupContentSize.height - tooltipAnchorSpacing
+                        if (posY < 0) anchorBounds.bottom + tooltipAnchorSpacing else posY
+                    }
 
+                    Placement.BELOW -> anchorBounds.bottom + tooltipAnchorSpacing
+                }
+
+                return IntOffset(x, y)
+            }
+        }
+    }
 }
 
 @Composable