Simplify api for compose ViewHolders

rubensousa · Mar 17, 2024 · 7e0320f · 7e0320f
1 parent 4ac0912
commit 7e0320f
Show file tree

Hide file tree

Showing 11 changed files with 29 additions and 100 deletions.
diff --git a/dpadrecyclerview-compose/api/dpadrecyclerview-compose.api b/dpadrecyclerview-compose/api/dpadrecyclerview-compose.api
@@ -2,27 +2,19 @@ public final class com/rubensousa/dpadrecyclerview/compose/DpadComposeExtensions
 	public static final fun dpadClickable (Landroidx/compose/ui/Modifier;Lkotlin/jvm/functions/Function0;Landroidx/compose/runtime/Composer;I)Landroidx/compose/ui/Modifier;
 }
 
-public final class com/rubensousa/dpadrecyclerview/compose/DpadComposeFocusViewHolder : androidx/recyclerview/widget/RecyclerView$ViewHolder, com/rubensousa/dpadrecyclerview/DpadViewHolder {
+public final class com/rubensousa/dpadrecyclerview/compose/DpadComposeFocusViewHolder : androidx/recyclerview/widget/RecyclerView$ViewHolder {
 	public static final field $stable I
-	public fun <init> (Landroid/view/ViewGroup;Landroidx/compose/ui/platform/ViewCompositionStrategy;Lkotlin/jvm/functions/Function4;)V
-	public synthetic fun <init> (Landroid/view/ViewGroup;Landroidx/compose/ui/platform/ViewCompositionStrategy;Lkotlin/jvm/functions/Function4;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (Landroid/view/ViewGroup;Landroidx/compose/ui/platform/ViewCompositionStrategy;Lkotlin/jvm/functions/Function3;)V
+	public synthetic fun <init> (Landroid/view/ViewGroup;Landroidx/compose/ui/platform/ViewCompositionStrategy;Lkotlin/jvm/functions/Function3;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public final fun getItem ()Ljava/lang/Object;
-	public fun getSubPositionAlignments ()Ljava/util/List;
-	public fun onViewHolderDeselected ()V
-	public fun onViewHolderSelected ()V
-	public fun onViewHolderSelectedAndAligned ()V
 	public final fun setItemState (Ljava/lang/Object;)V
 }
 
-public final class com/rubensousa/dpadrecyclerview/compose/DpadComposeViewHolder : androidx/recyclerview/widget/RecyclerView$ViewHolder, com/rubensousa/dpadrecyclerview/DpadViewHolder {
+public final class com/rubensousa/dpadrecyclerview/compose/DpadComposeViewHolder : androidx/recyclerview/widget/RecyclerView$ViewHolder {
 	public static final field $stable I
-	public fun <init> (Landroid/view/ViewGroup;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;ZLandroidx/compose/ui/platform/ViewCompositionStrategy;Lkotlin/jvm/functions/Function5;)V
-	public synthetic fun <init> (Landroid/view/ViewGroup;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;ZLandroidx/compose/ui/platform/ViewCompositionStrategy;Lkotlin/jvm/functions/Function5;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (Landroid/view/ViewGroup;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;ZLandroidx/compose/ui/platform/ViewCompositionStrategy;Lkotlin/jvm/functions/Function4;)V
+	public synthetic fun <init> (Landroid/view/ViewGroup;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;ZLandroidx/compose/ui/platform/ViewCompositionStrategy;Lkotlin/jvm/functions/Function4;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public final fun getItem ()Ljava/lang/Object;
-	public fun getSubPositionAlignments ()Ljava/util/List;
-	public fun onViewHolderDeselected ()V
-	public fun onViewHolderSelected ()V
-	public fun onViewHolderSelectedAndAligned ()V
 	public final fun setItemState (Ljava/lang/Object;)V
 }
 

diff --git a/...ndroidTest/java/com/rubensousa/dpadrecyclerview/compose/DpadComposeFocusViewHolderTest.kt b/...ndroidTest/java/com/rubensousa/dpadrecyclerview/compose/DpadComposeFocusViewHolderTest.kt
@@ -16,6 +16,7 @@
 
 package com.rubensousa.dpadrecyclerview.compose
 
+import androidx.compose.ui.platform.ComposeView
 import androidx.compose.ui.test.SemanticsMatcher
 import androidx.compose.ui.test.assert
 import androidx.compose.ui.test.assertIsDisplayed
@@ -50,13 +51,11 @@ class DpadComposeFocusViewHolderTest {
     @Test
     fun testComposeItemsReceiveFocus() {
         assertFocus(item = 0, isFocused = true)
-        assertSelection(item = 0, isSelected = true)
 
         KeyEvents.pressDown()
         waitForIdleScroll()
 
         assertFocus(item = 1, isFocused = true)
-        assertSelection(item = 1, isSelected = true)
     }
 
     @Test
@@ -67,15 +66,12 @@ class DpadComposeFocusViewHolderTest {
 
         Espresso.onIdle()
         assertFocus(item = 0, isFocused = false)
-        assertSelection(item = 0, isSelected = true)
 
         composeTestRule.activityRule.scenario.onActivity { activity ->
             activity.requestFocus()
         }
 
-        assertFocus(item = 0, isFocused = true)
-        assertSelection(item = 0, isSelected = true)
-    }
+        assertFocus(item = 0, isFocused = true) }
 
     @Test
     fun testClicksAreDispatched() {
@@ -101,8 +97,8 @@ class DpadComposeFocusViewHolderTest {
         }
 
         viewHolders.forEach { viewHolder ->
-            val composeView = viewHolder.itemView as DpadComposeView
-            assertThat(composeView.hasComposition()).isFalse()
+            val composeView = viewHolder.itemView as ComposeView
+            assertThat(composeView.hasComposition).isFalse()
         }
         composeTestRule.onNodeWithText("0").assertDoesNotExist()
     }
@@ -152,9 +148,4 @@ class DpadComposeFocusViewHolderTest {
             .assert(SemanticsMatcher.expectValue(TestComposable.focusedKey, isFocused))
     }
 
-    private fun assertSelection(item: Int, isSelected: Boolean) {
-        composeTestRule.onNodeWithText(item.toString()).assertIsDisplayed()
-            .assert(SemanticsMatcher.expectValue(TestComposable.selectedKey, isSelected))
-    }
-
 }
diff --git a/...src/androidTest/java/com/rubensousa/dpadrecyclerview/compose/DpadComposeViewHolderTest.kt b/...src/androidTest/java/com/rubensousa/dpadrecyclerview/compose/DpadComposeViewHolderTest.kt
@@ -49,13 +49,11 @@ class DpadComposeViewHolderTest {
     @Test
     fun testComposeItemsReceiveFocus() {
         assertFocus(item = 0, isFocused = true)
-        assertSelection(item = 0, isSelected = true)
 
         KeyEvents.pressDown()
         waitForIdleScroll()
 
         assertFocus(item = 1, isFocused = true)
-        assertSelection(item = 1, isSelected = true)
     }
 
     @Test
@@ -66,14 +64,12 @@ class DpadComposeViewHolderTest {
 
         Espresso.onIdle()
         assertFocus(item = 0, isFocused = false)
-        assertSelection(item = 0, isSelected = true)
 
         composeTestRule.activityRule.scenario.onActivity { activity ->
             activity.requestFocus()
         }
 
         assertFocus(item = 0, isFocused = true)
-        assertSelection(item = 0, isSelected = true)
     }
 
     @Test
@@ -160,9 +156,4 @@ class DpadComposeViewHolderTest {
             .assert(SemanticsMatcher.expectValue(TestComposable.focusedKey, isFocused))
     }
 
-    private fun assertSelection(item: Int, isSelected: Boolean) {
-        composeTestRule.onNodeWithText(item.toString()).assertIsDisplayed()
-            .assert(SemanticsMatcher.expectValue(TestComposable.selectedKey, isSelected))
-    }
-
 }
diff --git a/...ompose/src/debug/java/com/rubensousa/dpadrecyclerview/compose/ComposeFocusTestActivity.kt b/...ompose/src/debug/java/com/rubensousa/dpadrecyclerview/compose/ComposeFocusTestActivity.kt
@@ -88,13 +88,12 @@ class ComposeFocusTestActivity : AppCompatActivity() {
         ): DpadComposeFocusViewHolder<Int> {
             return DpadComposeFocusViewHolder(
                 parent = parent,
-                content = { item, isSelected ->
+                content = { item ->
                     TestComposableFocus(
                         modifier = Modifier
                             .fillMaxWidth()
                             .height(150.dp),
                         item = item,
-                        isSelected = isSelected,
                         onClick = {
                             clicks.add(item)
                         },

diff --git a/...clerview-compose/src/debug/java/com/rubensousa/dpadrecyclerview/compose/TestComposable.kt b/...clerview-compose/src/debug/java/com/rubensousa/dpadrecyclerview/compose/TestComposable.kt
@@ -41,21 +41,17 @@ import androidx.compose.ui.tooling.preview.Preview
 
 object TestComposable {
     val focusedKey = SemanticsPropertyKey<Boolean>("Focused")
-    val selectedKey = SemanticsPropertyKey<Boolean>("Selected")
 }
 
 @Composable
 fun TestComposable(
     modifier: Modifier = Modifier,
     item: Int,
     isFocused: Boolean,
-    isSelected: Boolean,
     onDispose: () -> Unit = {},
 ) {
     val backgroundColor = if (isFocused) {
         Color.White
-    } else if (isSelected) {
-        Color.Blue
     } else {
         Color.Black
     }
@@ -67,7 +63,6 @@ fun TestComposable(
         Text(
             modifier = Modifier.semantics {
                 set(TestComposable.focusedKey, isFocused)
-                set(TestComposable.selectedKey, isSelected)
             },
             text = item.toString(),
             style = MaterialTheme.typography.headlineLarge,
@@ -89,15 +84,12 @@ fun TestComposable(
 fun TestComposableFocus(
     modifier: Modifier = Modifier,
     item: Int,
-    isSelected: Boolean,
     onClick: () -> Unit,
     onDispose: () -> Unit = {},
 ) {
     var isFocused by remember { mutableStateOf(false) }
     val backgroundColor = if (isFocused) {
         Color.White
-    } else if (isSelected) {
-        Color.Blue
     } else {
         Color.Black
     }
@@ -116,7 +108,6 @@ fun TestComposableFocus(
         Text(
             modifier = Modifier.semantics {
                 set(TestComposable.focusedKey, isFocused)
-                set(TestComposable.selectedKey, isSelected)
             },
             text = item.toString(),
             style = MaterialTheme.typography.headlineLarge,
@@ -139,7 +130,6 @@ fun TestComposableFocus(
 fun TestComposablePreviewNormal() {
     TestComposableFocus(
         item = 0,
-        isSelected = false,
         onClick = {}
     )
 }
@@ -151,20 +141,9 @@ fun TestComposablePreviewFocused() {
     TestComposableFocus(
         item = 0,
         modifier = Modifier.focusRequester(focusRequester),
-        isSelected = false,
         onClick = {}
     )
     SideEffect {
         focusRequester.requestFocus()
     }
 }
-
-@Preview(widthDp = 300, heightDp = 300)
-@Composable
-fun TestComposablePreviewSelected() {
-    TestComposableFocus(
-        item = 0,
-        isSelected = true,
-        onClick = {}
-    )
-}
diff --git a/...w-compose/src/debug/java/com/rubensousa/dpadrecyclerview/compose/ViewFocusTestActivity.kt b/...w-compose/src/debug/java/com/rubensousa/dpadrecyclerview/compose/ViewFocusTestActivity.kt
@@ -92,14 +92,13 @@ class ViewFocusTestActivity : AppCompatActivity() {
                     clicks.add(it)
                 },
                 isFocusable = true
-            ) { item, isFocused, isSelected ->
+            ) { item, isFocused ->
                 TestComposable(
                     modifier = Modifier
                         .fillMaxWidth()
                         .height(150.dp),
                     item = item,
                     isFocused = isFocused,
-                    isSelected = isSelected,
                     onDispose = {
                         onDispose(item)
                     }

diff --git a/...mpose/src/main/java/com/rubensousa/dpadrecyclerview/compose/DpadComposeFocusViewHolder.kt b/...mpose/src/main/java/com/rubensousa/dpadrecyclerview/compose/DpadComposeFocusViewHolder.kt
@@ -19,9 +19,9 @@ package com.rubensousa.dpadrecyclerview.compose
 import android.view.ViewGroup
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.mutableStateOf
+import androidx.compose.ui.platform.ComposeView
 import androidx.compose.ui.platform.ViewCompositionStrategy
 import androidx.recyclerview.widget.RecyclerView
-import com.rubensousa.dpadrecyclerview.DpadViewHolder
 
 /**
  * Similar to [DpadComposeViewHolder], but sends the focus down to composables
@@ -46,36 +46,26 @@ import com.rubensousa.dpadrecyclerview.DpadViewHolder
 class DpadComposeFocusViewHolder<T>(
     parent: ViewGroup,
     compositionStrategy: ViewCompositionStrategy = RecyclerViewCompositionStrategy.DisposeOnRecycled,
-    private val content: @Composable (item: T, isSelected: Boolean) -> Unit
-) : RecyclerView.ViewHolder(DpadComposeView(parent.context)), DpadViewHolder {
+    private val content: @Composable (item: T) -> Unit
+) : RecyclerView.ViewHolder(ComposeView(parent.context)) {
 
     private val itemState = mutableStateOf<T?>(null)
-    private val selectionState = mutableStateOf(false)
 
     init {
-        val composeView = itemView as DpadComposeView
+        val composeView = itemView as ComposeView
         composeView.apply {
-            setFocusConfiguration(
-                isFocusable = true,
-                dispatchFocusToComposable = true
-            )
+            isFocusable = true
+            isFocusableInTouchMode = true
+            descendantFocusability = ViewGroup.FOCUS_AFTER_DESCENDANTS
             setViewCompositionStrategy(compositionStrategy)
             setContent {
                 itemState.value?.let { item ->
-                    content(item, selectionState.value)
+                    content(item)
                 }
             }
         }
     }
 
-    override fun onViewHolderSelected() {
-        selectionState.value = true
-    }
-
-    override fun onViewHolderDeselected() {
-        selectionState.value = false
-    }
-
     fun setItemState(item: T?) {
         itemState.value = item
     }

diff --git a/...ew-compose/src/main/java/com/rubensousa/dpadrecyclerview/compose/DpadComposeViewHolder.kt b/...ew-compose/src/main/java/com/rubensousa/dpadrecyclerview/compose/DpadComposeViewHolder.kt
@@ -21,10 +21,9 @@ import androidx.compose.runtime.mutableStateOf
 import androidx.compose.ui.platform.ComposeView
 import androidx.compose.ui.platform.ViewCompositionStrategy
 import androidx.recyclerview.widget.RecyclerView
-import com.rubensousa.dpadrecyclerview.DpadViewHolder
 
 /**
- * A basic ViewHolder that forwards [Content] to [composable]
+ * A basic ViewHolder that forwards [content] to a [ComposeView]
  * and handles focus and clicks inside the View system.
  *
  * Focus is kept inside the internal [ComposeView] to ensure that it behaves correctly
@@ -42,8 +41,8 @@ import com.rubensousa.dpadrecyclerview.DpadViewHolder
  *
  * ```kotlin
  * override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): DpadComposeViewHolder<Int> {
- *     return DpadComposeViewHolder(parent) { item, isFocused, isSelected ->
- *          ItemComposable(item, isFocused, isSelected)
+ *     return DpadComposeViewHolder(parent) { item, isFocused ->
+ *          ItemComposable(item, isFocused)
  *     }
  * }
  * ```
@@ -61,12 +60,11 @@ class DpadComposeViewHolder<T>(
     onLongClick: ((item: T) -> Boolean)? = null,
     isFocusable: Boolean = true,
     compositionStrategy: ViewCompositionStrategy = RecyclerViewCompositionStrategy.DisposeOnRecycled,
-    private val composable: DpadComposable<T>,
-) : RecyclerView.ViewHolder(DpadComposeView(parent.context)), DpadViewHolder {
+    private val content: @Composable (item: T, isFocused: Boolean) -> Unit
+) : RecyclerView.ViewHolder(DpadComposeView(parent.context)) {
 
     private val focusState = mutableStateOf(false)
     private val itemState = mutableStateOf<T?>(null)
-    private val selectionState = mutableStateOf(false)
 
     init {
         val composeView = itemView as DpadComposeView
@@ -81,7 +79,7 @@ class DpadComposeViewHolder<T>(
             setViewCompositionStrategy(compositionStrategy)
             setContent {
                 itemState.value?.let { item ->
-                    composable(item, focusState.value, selectionState.value)
+                    content(item, focusState.value)
                 }
             }
         }
@@ -98,19 +96,9 @@ class DpadComposeViewHolder<T>(
         }
     }
 
-    override fun onViewHolderSelected() {
-        selectionState.value = true
-    }
-
-    override fun onViewHolderDeselected() {
-        selectionState.value = false
-    }
-
     fun setItemState(item: T?) {
         itemState.value = item
     }
 
     fun getItem(): T? = itemState.value
 }
-
-typealias DpadComposable<T> = @Composable (T, Boolean, Boolean) -> Unit
diff --git a/.../main/java/com/rubensousa/dpadrecyclerview/sample/ui/screen/compose/ComposeGridAdapter.kt b/.../main/java/com/rubensousa/dpadrecyclerview/sample/ui/screen/compose/ComposeGridAdapter.kt
@@ -32,7 +32,7 @@ class ComposeGridAdapter : MutableListAdapter<Int, DpadComposeFocusViewHolder<In
         parent: ViewGroup,
         viewType: Int
     ): DpadComposeFocusViewHolder<Int> {
-        return DpadComposeFocusViewHolder(parent) { item, isSelected ->
+        return DpadComposeFocusViewHolder(parent) { item ->
             GridItemComposable(
                 item = item,
                 onClick = {

diff --git a/.../main/java/com/rubensousa/dpadrecyclerview/sample/ui/screen/compose/ComposeItemAdapter.kt b/.../main/java/com/rubensousa/dpadrecyclerview/sample/ui/screen/compose/ComposeItemAdapter.kt
@@ -37,7 +37,7 @@ class ComposeItemAdapter(
         parent: ViewGroup,
         viewType: Int
     ): DpadComposeFocusViewHolder<Int> {
-        return DpadComposeFocusViewHolder(parent) { item, isSelected ->
+        return DpadComposeFocusViewHolder(parent) { item ->
             ItemComposable(
                 modifier = Modifier
                     .width(dimensionResource(id = R.dimen.list_item_width))

diff --git a/...ava/com/rubensousa/dpadrecyclerview/sample/ui/widgets/common/ComposePlaceholderAdapter.kt b/...ava/com/rubensousa/dpadrecyclerview/sample/ui/widgets/common/ComposePlaceholderAdapter.kt
@@ -46,7 +46,7 @@ class ComposePlaceholderAdapter(
         return DpadComposeViewHolder(
             parent = parent,
             isFocusable = false
-        ) { _, _, _ ->
+        ) { _, _ ->
             composable()
         }
     }