Support HapticFeedback on iOS (#1255)

## Proposed Changes Bridge `HapticFeedback` interface with `UIFeedbackGenerator`s, provide the constructed bridge as static composition local. ## Testing Test: APIs that request a haptic feedback should trigger one on iOS (text selection, on-demand, etc) ## Issues Fixed Fixes: JetBrains/compose-multiplatform#4598
JetBrains · Apr 10, 2024 · fb98098 · fb98098
1 parent 7f4929c
commit fb98098
Show file tree

Hide file tree

Showing 17 changed files with 147 additions and 24 deletions.
diff --git a/...ose/mpp/demo/src/uikitMain/kotlin/androidx/compose/mpp/demo/IosSpecificFeaturesExample.kt b/...ose/mpp/demo/src/uikitMain/kotlin/androidx/compose/mpp/demo/IosSpecificFeaturesExample.kt
@@ -0,0 +1,54 @@
+/*
+ * Copyright 2024 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package androidx.compose.mpp.demo
+
+import androidx.compose.foundation.layout.Column
+import androidx.compose.foundation.layout.Spacer
+import androidx.compose.foundation.layout.height
+import androidx.compose.foundation.layout.padding
+import androidx.compose.material.Button
+import androidx.compose.material.Text
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.hapticfeedback.HapticFeedbackType
+import androidx.compose.ui.platform.LocalHapticFeedback
+import androidx.compose.ui.unit.dp
+
+val HapticFeedbackExample = Screen.Example("Haptic feedback") {
+    val feedback = LocalHapticFeedback.current
+
+    Column(modifier = Modifier.padding(16.dp)) {
+        Button(onClick = {
+            feedback.performHapticFeedback(HapticFeedbackType.TextHandleMove)
+        }) {
+            Text("TextHandleMove")
+        }
+
+        Spacer(Modifier.height(16.dp))
+
+        Button(onClick = {
+            feedback.performHapticFeedback(HapticFeedbackType.LongPress)
+        }) {
+            Text("LongPress")
+        }
+    }
+}
+
+val IosSpecificFeatures = Screen.Selection(
+    "iOS-specific features",
+    NativeModalWithNaviationExample,
+    HapticFeedbackExample,
+)
diff --git a/...rc/uikitMain/kotlin/NativePopupExample.kt → ...dx/compose/mpp/demo/NativePopupExample.kt b/...rc/uikitMain/kotlin/NativePopupExample.kt → ...dx/compose/mpp/demo/NativePopupExample.kt
@@ -1,3 +1,21 @@
+/*
+ * Copyright 2024 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package androidx.compose.mpp.demo
+
 import androidx.compose.foundation.background
 import androidx.compose.foundation.layout.Arrangement
 import androidx.compose.foundation.layout.Box
@@ -11,10 +29,8 @@ import androidx.compose.foundation.lazy.grid.GridCells
 import androidx.compose.foundation.lazy.grid.LazyVerticalGrid
 import androidx.compose.material.Button
 import androidx.compose.material.Text
-import androidx.compose.mpp.demo.Screen
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.DisposableEffect
-import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.mutableStateListOf
 import androidx.compose.runtime.mutableStateOf
@@ -31,8 +47,6 @@ import androidx.compose.ui.window.ComposeUIViewController
 import androidx.lifecycle.LifecycleEventObserver
 import platform.UIKit.*
 import platform.Foundation.*
-import platform.darwin.dispatch_async
-import platform.darwin.dispatch_get_main_queue
 
 /*
  * Copyright 2023 The Android Open Source Project

diff --git a/...uikitMain/kotlin/SwiftUIInteropExample.kt → ...compose/mpp/demo/SwiftUIInteropExample.kt b/...uikitMain/kotlin/SwiftUIInteropExample.kt → ...compose/mpp/demo/SwiftUIInteropExample.kt
@@ -1,3 +1,21 @@
+/*
+ * Copyright 2024 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package androidx.compose.mpp.demo
+
 import androidx.compose.foundation.background
 import androidx.compose.foundation.layout.Column
 import androidx.compose.foundation.layout.Spacer

diff --git a/...ain/kotlin/bugs/ComposeAndNativeScroll.kt → ...e/mpp/demo/bugs/ComposeAndNativeScroll.kt b/...ain/kotlin/bugs/ComposeAndNativeScroll.kt → ...e/mpp/demo/bugs/ComposeAndNativeScroll.kt
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package bugs
+package androidx.compose.mpp.demo.bugs
 
 import androidx.compose.foundation.background
 import androidx.compose.foundation.horizontalScroll

diff --git a/.../kotlin/bugs/DispatchersMainDelayCheck.kt → ...pp/demo/bugs/DispatchersMainDelayCheck.kt b/.../kotlin/bugs/DispatchersMainDelayCheck.kt → ...pp/demo/bugs/DispatchersMainDelayCheck.kt
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package bugs
+package androidx.compose.mpp.demo.bugs
 
 import androidx.compose.foundation.layout.fillMaxSize
 import androidx.compose.foundation.lazy.LazyColumn

diff --git a/...demo/src/uikitMain/kotlin/bugs/IosBugs.kt → ...androidx/compose/mpp/demo/bugs/IosBugs.kt b/...demo/src/uikitMain/kotlin/bugs/IosBugs.kt → ...androidx/compose/mpp/demo/bugs/IosBugs.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 The Android Open Source Project
+ * Copyright 2024 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package bugs
+package androidx.compose.mpp.demo.bugs
 
 import androidx.compose.mpp.demo.Screen
 import androidx.compose.mpp.demo.bug.BackspaceIssue

diff --git a/...in/kotlin/bugs/KeyboardEmptyWhiteSpace.kt → .../mpp/demo/bugs/KeyboardEmptyWhiteSpace.kt b/...in/kotlin/bugs/KeyboardEmptyWhiteSpace.kt → .../mpp/demo/bugs/KeyboardEmptyWhiteSpace.kt
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package bugs
+package androidx.compose.mpp.demo.bugs
 
 import androidx.compose.foundation.background
 import androidx.compose.foundation.border

diff --git a/...tMain/kotlin/bugs/KeyboardPasswordType.kt → ...ose/mpp/demo/bugs/KeyboardPasswordType.kt b/...tMain/kotlin/bugs/KeyboardPasswordType.kt → ...ose/mpp/demo/bugs/KeyboardPasswordType.kt
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package bugs
+package androidx.compose.mpp.demo.bugs
 
 import androidx.compose.foundation.layout.Column
 import androidx.compose.foundation.text.KeyboardOptions

diff --git a/...Main/kotlin/bugs/MeasureAndLayoutCrash.kt → ...se/mpp/demo/bugs/MeasureAndLayoutCrash.kt b/...Main/kotlin/bugs/MeasureAndLayoutCrash.kt → ...se/mpp/demo/bugs/MeasureAndLayoutCrash.kt
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package bugs
+package androidx.compose.mpp.demo.bugs
 
 import androidx.compose.foundation.layout.*
 import androidx.compose.foundation.lazy.LazyColumn

diff --git a/.../kotlin/bugs/ProperContainmentDisposal.kt → ...pp/demo/bugs/ProperContainmentDisposal.kt b/.../kotlin/bugs/ProperContainmentDisposal.kt → ...pp/demo/bugs/ProperContainmentDisposal.kt
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package bugs
+package androidx.compose.mpp.demo.bugs
 
 import androidx.compose.foundation.background
 import androidx.compose.foundation.layout.Box

diff --git a/...in/kotlin/bugs/StartRecompositionCheck.kt → .../mpp/demo/bugs/StartRecompositionCheck.kt b/...in/kotlin/bugs/StartRecompositionCheck.kt → .../mpp/demo/bugs/StartRecompositionCheck.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 The Android Open Source Project
+ * Copyright 2024 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package bugs
+package androidx.compose.mpp.demo.bugs
 
 import androidx.compose.foundation.layout.Column
 import androidx.compose.foundation.layout.Spacer

diff --git a/.../uikitMain/kotlin/bugs/UIKitRenderSync.kt → .../compose/mpp/demo/bugs/UIKitRenderSync.kt b/.../uikitMain/kotlin/bugs/UIKitRenderSync.kt → .../compose/mpp/demo/bugs/UIKitRenderSync.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 The Android Open Source Project
+ * Copyright 2024 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package bugs
+package androidx.compose.mpp.demo.bugs
 
 import androidx.compose.foundation.layout.*
 import androidx.compose.foundation.lazy.LazyColumn

diff --git a/...n/kotlin/bugs/UIKitViewAndDropDownMenu.kt → ...mpp/demo/bugs/UIKitViewAndDropDownMenu.kt b/...n/kotlin/bugs/UIKitViewAndDropDownMenu.kt → ...mpp/demo/bugs/UIKitViewAndDropDownMenu.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 The Android Open Source Project
+ * Copyright 2024 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package bugs
+package androidx.compose.mpp.demo.bugs
 
 import androidx.compose.foundation.layout.Box
 import androidx.compose.foundation.layout.Column

diff --git a/...itMain/kotlin/bugs/UIKitViewMatryoshka.kt → ...pose/mpp/demo/bugs/UIKitViewMatryoshka.kt b/...itMain/kotlin/bugs/UIKitViewMatryoshka.kt → ...pose/mpp/demo/bugs/UIKitViewMatryoshka.kt
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package bugs
+package androidx.compose.mpp.demo.bugs
 
 import androidx.compose.foundation.background
 import androidx.compose.foundation.layout.Box

diff --git a/compose/mpp/demo/src/uikitMain/kotlin/androidx/compose/mpp/demo/main.uikit.kt b/compose/mpp/demo/src/uikitMain/kotlin/androidx/compose/mpp/demo/main.uikit.kt
@@ -1,8 +1,6 @@
 // Use `xcodegen` first, then `open ./SkikoSample.xcodeproj` and then Run button in XCode.
 package androidx.compose.mpp.demo
 
-import NativeModalWithNaviationExample
-import SwiftUIInteropExample
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.ExperimentalComposeApi
 import androidx.compose.runtime.remember
@@ -11,8 +9,8 @@ import androidx.compose.ui.main.defaultUIKitMain
 import androidx.compose.ui.platform.AccessibilityDebugLogger
 import androidx.compose.ui.platform.AccessibilitySyncOptions
 import androidx.compose.ui.window.ComposeUIViewController
-import bugs.IosBugs
-import bugs.StartRecompositionCheck
+import androidx.compose.mpp.demo.bugs.IosBugs
+import androidx.compose.mpp.demo.bugs.StartRecompositionCheck
 import platform.UIKit.UIViewController
 
 @OptIn(ExperimentalComposeApi::class, ExperimentalComposeUiApi::class)
@@ -41,7 +39,7 @@ fun IosDemo(arg: String, makeHostingController: ((Int) -> UIViewController)? = n
         App(
             extraScreens = listOf(
                 IosBugs,
-                NativeModalWithNaviationExample,
+                IosSpecificFeatures,
             ) + listOf(makeHostingController).mapNotNull {
                 it?.let {
                     SwiftUIInteropExample(it)

diff --git a/...ose/ui/ui/src/uikitMain/kotlin/androidx/compose/ui/hapticfeedback/HapticFeedback.uikit.kt b/...ose/ui/ui/src/uikitMain/kotlin/androidx/compose/ui/hapticfeedback/HapticFeedback.uikit.kt
@@ -0,0 +1,35 @@
+/*
+ * Copyright 2024 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package androidx.compose.ui.hapticfeedback
+
+import platform.UIKit.UIImpactFeedbackGenerator
+import platform.UIKit.UISelectionFeedbackGenerator
+
+// TODO: minor UX improvement, add `prepare()` calls when internal APIs are likely to use HapticFeedback
+//  (e.g. pan started during the text selection) to reduce haptic feedback latency
+//  see https://developer.apple.com/documentation/uikit/uifeedbackgenerator
+internal class CupertinoHapticFeedback : HapticFeedback {
+    private val impactGenerator = UIImpactFeedbackGenerator()
+    private val selectionGenerator = UISelectionFeedbackGenerator()
+
+    override fun performHapticFeedback(hapticFeedbackType: HapticFeedbackType) {
+        when (hapticFeedbackType) {
+            HapticFeedbackType.LongPress -> impactGenerator.impactOccurred()
+            HapticFeedbackType.TextHandleMove -> selectionGenerator.selectionChanged()
+        }
+    }
+}
diff --git a/compose/ui/ui/src/uikitMain/kotlin/androidx/compose/ui/window/ComposeContainer.uikit.kt b/compose/ui/ui/src/uikitMain/kotlin/androidx/compose/ui/window/ComposeContainer.uikit.kt
@@ -25,8 +25,10 @@ import androidx.compose.runtime.MutableState
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.ui.LocalSystemTheme
 import androidx.compose.ui.SystemTheme
+import androidx.compose.ui.hapticfeedback.CupertinoHapticFeedback
 import androidx.compose.ui.interop.LocalUIViewController
 import androidx.compose.ui.interop.UIKitInteropContext
+import androidx.compose.ui.platform.LocalHapticFeedback
 import androidx.compose.ui.platform.LocalLifecycleOwner
 import androidx.compose.ui.platform.PlatformContext
 import androidx.compose.ui.platform.PlatformWindowContext
@@ -96,6 +98,7 @@ internal class ComposeContainer(
     private val content: @Composable () -> Unit,
 ) : CMPViewController(nibName = null, bundle = null) {
     val lifecycleOwner = ViewControllerBasedLifecycleOwner()
+    val hapticFeedback = CupertinoHapticFeedback()
 
     private var isInsideSwiftUI = false
     private var mediator: ComposeSceneMediator? = null
@@ -426,6 +429,7 @@ internal fun ProvideContainerCompositionLocals(
     content: @Composable () -> Unit,
 ) = with(composeContainer) {
     CompositionLocalProvider(
+        LocalHapticFeedback provides hapticFeedback,
         LocalUIViewController provides this,
         LocalInterfaceOrientation provides interfaceOrientationState.value,
         LocalSystemTheme provides systemThemeState.value,