Merge pull request #2503 from switchifyapp/feature/pc-keyboard-navigation-component-2502

Add reusable PC keyboard navigation cluster

Author: enaboapps

app/src/main/java/com/enaboapps/switchify/screens/pc/PcKeyboardNavigationCluster.kt

@@ -0,0 +1,36 @@
+package com.enaboapps.switchify.screens.pc
+
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+import com.enaboapps.switchify.pc.PcKeyboardKey
+
+@Composable
+fun PcKeyboardNavigationCluster(
+    enabled: Boolean,
+    onKeySelected: (PcKeyboardKey) -> Unit,
+    modifier: Modifier = Modifier
+) {
+    PcCompactCommandGrid(
+        columns = 3,
+        minTileHeightDp = 52,
+        cells = pcKeyboardNavigationKeys().map { key ->
+            PcCompactCommandCell(
+                labelResId = key.labelResId,
+                enabled = enabled,
+                onClick = { onKeySelected(key) }
+            )
+        },
+        modifier = modifier
+    )
+}
+
+fun pcKeyboardNavigationKeys(): List<PcKeyboardKey> {
+    return listOf(
+        PcKeyboardKey.Escape,
+        PcKeyboardKey.ArrowUp,
+        PcKeyboardKey.Enter,
+        PcKeyboardKey.ArrowLeft,
+        PcKeyboardKey.ArrowDown,
+        PcKeyboardKey.ArrowRight
+    )
+}

app/src/main/java/com/enaboapps/switchify/screens/pc/PcTypingControlScreen.kt

@@ -58,6 +58,10 @@ fun PcTypingControlScreen(
             onClear = onClear,
             onKeySelected = onKeySelected
         )
+        PcKeyboardNavigationCluster(
+            enabled = enabled,
+            onKeySelected = onKeySelected
+        )
     }
 }
 
@@ -157,14 +161,8 @@ fun pcTypingCompactCommandSpecs(): List<PcTypingCompactCommandSpec> {
         PcTypingCompactCommandSpec.Clear,
         PcTypingCompactCommandSpec.Key(PcTypingKeySpec(R.string.pc_key_backspace, PcKeyboardKey.Backspace)),
         PcTypingCompactCommandSpec.Key(PcTypingKeySpec(R.string.pc_key_delete, PcKeyboardKey.Delete)),
-        PcTypingCompactCommandSpec.Key(PcTypingKeySpec(R.string.pc_key_enter, PcKeyboardKey.Enter)),
         PcTypingCompactCommandSpec.Key(PcTypingKeySpec(R.string.pc_key_space, PcKeyboardKey.Space)),
         PcTypingCompactCommandSpec.Key(PcTypingKeySpec(R.string.pc_key_tab, PcKeyboardKey.Tab)),
-        PcTypingCompactCommandSpec.Key(PcTypingKeySpec(R.string.pc_key_escape, PcKeyboardKey.Escape)),
-        PcTypingCompactCommandSpec.Key(PcTypingKeySpec(R.string.pc_key_arrow_left, PcKeyboardKey.ArrowLeft)),
-        PcTypingCompactCommandSpec.Key(PcTypingKeySpec(R.string.pc_key_arrow_up, PcKeyboardKey.ArrowUp)),
-        PcTypingCompactCommandSpec.Key(PcTypingKeySpec(R.string.pc_key_arrow_down, PcKeyboardKey.ArrowDown)),
-        PcTypingCompactCommandSpec.Key(PcTypingKeySpec(R.string.pc_key_arrow_right, PcKeyboardKey.ArrowRight)),
         PcTypingCompactCommandSpec.Key(PcTypingKeySpec(R.string.pc_key_home, PcKeyboardKey.Home)),
         PcTypingCompactCommandSpec.Key(PcTypingKeySpec(R.string.pc_key_end, PcKeyboardKey.End)),
         PcTypingCompactCommandSpec.Key(PcTypingKeySpec(R.string.pc_key_page_up, PcKeyboardKey.PageUp)),

app/src/main/java/com/enaboapps/switchify/screens/pc/PcWindowControlScreen.kt

@@ -47,6 +47,12 @@ fun PcWindowControlScreen(
                 }
             }
         )
+        PcKeyboardNavigationCluster(
+            enabled = enabled,
+            onKeySelected = { key ->
+                onCommandSelected(PcControlCommand.PressKey(key))
+            }
+        )
     }
 }
 

app/src/test/java/com/enaboapps/switchify/screens/pc/PcKeyboardNavigationClusterTest.kt

@@ -0,0 +1,22 @@
+package com.enaboapps.switchify.screens.pc
+
+import com.enaboapps.switchify.pc.PcKeyboardKey
+import org.junit.Assert.assertEquals
+import org.junit.Test
+
+class PcKeyboardNavigationClusterTest {
+    @Test
+    fun navigationKeysUseStableClusterOrder() {
+        assertEquals(
+            listOf(
+                PcKeyboardKey.Escape,
+                PcKeyboardKey.ArrowUp,
+                PcKeyboardKey.Enter,
+                PcKeyboardKey.ArrowLeft,
+                PcKeyboardKey.ArrowDown,
+                PcKeyboardKey.ArrowRight
+            ),
+            pcKeyboardNavigationKeys()
+        )
+    }
+}

app/src/test/java/com/enaboapps/switchify/screens/pc/PcMouseControlViewModelTest.kt

@@ -242,6 +242,21 @@ class PcMouseControlViewModelTest {
         assertEquals(PcControlSurface.Window, viewModel.uiState.value.activeSurface)
     }
 
+    @Test
+    fun windowSurfaceCanSendNavigationKeyCommand() = runTest(dispatcher) {
+        val connector = FakeConnector()
+        val controller = connectedController(connector = connector)
+        val viewModel = viewModel(controller)
+
+        viewModel.selectControlSurface(PcControlSurface.Window)
+        viewModel.send(PcControlCommand.PressKey(PcKeyboardKey.Escape))
+        advanceUntilIdle()
+
+        assertEquals(listOf(PcControlCommand.PressKey(PcKeyboardKey.Escape)), connector.realtimeCommands)
+        assertTrue(connector.commands.isEmpty())
+        assertEquals(PcControlSurface.Window, viewModel.uiState.value.activeSurface)
+    }
+
     @Test
     fun controlCommandDoesNotSetBusy() = runTest(dispatcher) {
         val connector = FakeConnector()

app/src/test/java/com/enaboapps/switchify/screens/pc/PcTypingControlScreenTest.kt

@@ -85,14 +85,8 @@ class PcTypingControlScreenTest {
             listOf(
                 PcKeyboardKey.Backspace,
                 PcKeyboardKey.Delete,
-                PcKeyboardKey.Enter,
                 PcKeyboardKey.Space,
                 PcKeyboardKey.Tab,
-                PcKeyboardKey.Escape,
-                PcKeyboardKey.ArrowLeft,
-                PcKeyboardKey.ArrowUp,
-                PcKeyboardKey.ArrowDown,
-                PcKeyboardKey.ArrowRight,
                 PcKeyboardKey.Home,
                 PcKeyboardKey.End,
                 PcKeyboardKey.PageUp,

app/src/test/java/com/enaboapps/switchify/screens/pc/PcWindowControlScreenTest.kt

@@ -2,6 +2,7 @@ package com.enaboapps.switchify.screens.pc
 
 import com.enaboapps.switchify.R
 import com.enaboapps.switchify.pc.PcControlCommand
+import com.enaboapps.switchify.pc.PcKeyboardKey
 import com.enaboapps.switchify.pc.PcWindowControlAction
 import org.junit.Assert.assertEquals
 import org.junit.Test
@@ -56,4 +57,19 @@ class PcWindowControlScreenTest {
         assertEquals(null, specs[7])
         assertEquals(null, specs[8])
     }
+
+    @Test
+    fun windowKeyboardNavigationUsesSharedOrder() {
+        assertEquals(
+            listOf(
+                PcKeyboardKey.Escape,
+                PcKeyboardKey.ArrowUp,
+                PcKeyboardKey.Enter,
+                PcKeyboardKey.ArrowLeft,
+                PcKeyboardKey.ArrowDown,
+                PcKeyboardKey.ArrowRight
+            ),
+            pcKeyboardNavigationKeys()
+        )
+    }
 }