Support ime inset in Dialog

JetBrains · Feb 7, 2024 · 7db8837 · 7db8837
1 parent 5b36158
commit 7db8837
Show file tree

Hide file tree

Showing 5 changed files with 81 additions and 21 deletions.
diff --git a/...tion-layout/src/uikitMain/kotlin/androidx/compose/foundation/layout/WindowInsets.uikit.kt b/...tion-layout/src/uikitMain/kotlin/androidx/compose/foundation/layout/WindowInsets.uikit.kt
@@ -74,8 +74,6 @@ actual val WindowInsets.Companion.displayCutout: WindowInsets
 /**
  * An insets type representing the window of an "input method",
  * for iOS IME representing the software keyboard.
- *
- * TODO: Animation doesn't work on iOS yet
  */
 actual val WindowInsets.Companion.ime: WindowInsets
     @Composable

diff --git a/compose/ui/ui/src/skikoMain/kotlin/androidx/compose/ui/platform/PlatformInsets.skiko.kt b/compose/ui/ui/src/skikoMain/kotlin/androidx/compose/ui/platform/PlatformInsets.skiko.kt
@@ -67,6 +67,13 @@ class PlatformInsets(
     }
 }
 
+internal fun PlatformInsets.union(insets: PlatformInsets) = PlatformInsets(
+    left = maxOf(left, insets.left),
+    top = maxOf(top, insets.top),
+    right = maxOf(right, insets.right),
+    bottom = maxOf(bottom, insets.bottom)
+)
+
 internal fun PlatformInsets.exclude(insets: PlatformInsets) = PlatformInsets(
     left = (left - insets.left).coerceAtLeast(0.dp),
     top = (top - insets.top).coerceAtLeast(0.dp),
@@ -80,18 +87,32 @@ internal interface InsetsConfig {
     val safeInsets: PlatformInsets
         @Composable get
 
+    val ime: PlatformInsets
+        @Composable get
+
     // Don't make it public, it should be implementation details for creating new root layout nodes.
     // TODO: Ensure encapsulation and proper control flow during refactoring [Owner]s
     @Composable
-    fun excludeSafeInsets(content: @Composable () -> Unit)
+    fun excludeInsets(
+        safeInsets: Boolean,
+        ime: Boolean,
+        content: @Composable () -> Unit
+    )
 }
 
 internal object ZeroInsetsConfig : InsetsConfig {
     override val safeInsets: PlatformInsets
         @Composable get() = PlatformInsets.Zero
 
+    override val ime: PlatformInsets
+        @Composable get() = PlatformInsets.Zero
+
     @Composable
-    override fun excludeSafeInsets(content: @Composable () -> Unit) {
+    override fun excludeInsets(
+        safeInsets: Boolean,
+        ime: Boolean,
+        content: @Composable () -> Unit
+    ) {
         content()
     }
 }
@@ -103,6 +124,6 @@ internal object ZeroInsetsConfig : InsetsConfig {
  * different on each platform.
  *
  * TODO: Stabilize and make the window paddings in the foundation-layout module depend on it.
- *  There is a plan to potentially move this variable into the [Platform] interface.
+ *  There is a plan to potentially move this variable into the [PlatformContext] interface.
  */
 internal expect var PlatformInsetsConfig: InsetsConfig
diff --git a/compose/ui/ui/src/skikoMain/kotlin/androidx/compose/ui/window/Dialog.skiko.kt b/compose/ui/ui/src/skikoMain/kotlin/androidx/compose/ui/window/Dialog.skiko.kt
@@ -29,18 +29,18 @@ import androidx.compose.ui.input.key.key
 import androidx.compose.ui.input.key.type
 import androidx.compose.ui.input.pointer.PointerEventType
 import androidx.compose.ui.layout.Layout
-import androidx.compose.ui.platform.InsetsConfig
 import androidx.compose.ui.platform.LocalWindowInfo
 import androidx.compose.ui.platform.PlatformInsets
 import androidx.compose.ui.platform.PlatformInsetsConfig
-import androidx.compose.ui.platform.ZeroInsetsConfig
+import androidx.compose.ui.platform.union
 import androidx.compose.ui.scene.ComposeSceneLayer
 import androidx.compose.ui.scene.rememberComposeSceneLayer
 import androidx.compose.ui.semantics.dialog
 import androidx.compose.ui.semantics.semantics
 import androidx.compose.ui.unit.IntRect
 import androidx.compose.ui.unit.IntSize
 import androidx.compose.ui.unit.center
+import androidx.compose.ui.unit.dp
 
 /**
  * The default scrim opacity.
@@ -58,8 +58,10 @@ private val DefaultScrimColor = Color.Black.copy(alpha = DefaultScrimOpacity)
  * dialog's bounds. If true, clicking outside the dialog will call onDismissRequest.
  * @property usePlatformDefaultWidth Whether the width of the dialog's content should be limited to
  * the platform default, which is smaller than the screen width.
- * @property usePlatformInsets Whether the width of the popup's content should be limited by
+ * @property usePlatformInsets Whether the size of the dialog's content should be limited by
  * platform insets.
+ * @property useSoftwareKeyboardInset Whether the size of the dialog's content should be limited by
+ * software keyboard inset.
  * @property scrimColor Color of background fill.
  */
 @Immutable
@@ -68,6 +70,7 @@ actual class DialogProperties @ExperimentalComposeUiApi constructor(
     actual val dismissOnClickOutside: Boolean = true,
     actual val usePlatformDefaultWidth: Boolean = true,
     val usePlatformInsets: Boolean = true,
+    val useSoftwareKeyboardInset: Boolean = true,
     val scrimColor: Color = DefaultScrimColor,
 ) {
     // Constructor with all non-experimental arguments.
@@ -80,6 +83,7 @@ actual class DialogProperties @ExperimentalComposeUiApi constructor(
         dismissOnClickOutside = dismissOnClickOutside,
         usePlatformDefaultWidth = usePlatformDefaultWidth,
         usePlatformInsets = true,
+        useSoftwareKeyboardInset = true,
         scrimColor = DefaultScrimColor,
     )
 
@@ -102,6 +106,7 @@ actual class DialogProperties @ExperimentalComposeUiApi constructor(
         dismissOnClickOutside = dismissOnClickOutside,
         usePlatformDefaultWidth = usePlatformDefaultWidth,
         usePlatformInsets = true,
+        useSoftwareKeyboardInset = true,
         scrimColor = DefaultScrimColor,
     )
 
@@ -113,6 +118,7 @@ actual class DialogProperties @ExperimentalComposeUiApi constructor(
         if (dismissOnClickOutside != other.dismissOnClickOutside) return false
         if (usePlatformDefaultWidth != other.usePlatformDefaultWidth) return false
         if (usePlatformInsets != other.usePlatformInsets) return false
+        if (useSoftwareKeyboardInset != other.useSoftwareKeyboardInset) return false
         if (scrimColor != other.scrimColor) return false
 
         return true
@@ -123,6 +129,7 @@ actual class DialogProperties @ExperimentalComposeUiApi constructor(
         result = 31 * result + dismissOnClickOutside.hashCode()
         result = 31 * result + usePlatformDefaultWidth.hashCode()
         result = 31 * result + usePlatformInsets.hashCode()
+        result = 31 * result + useSoftwareKeyboardInset.hashCode()
         result = 31 * result + scrimColor.hashCode()
         return result
     }
@@ -173,7 +180,7 @@ private fun DialogLayout(
     onOutsidePointerEvent: ((eventType: PointerEventType) -> Unit)? = null,
     content: @Composable () -> Unit
 ) {
-    val platformInsets = properties.insetsConfig.safeInsets
+    val platformInsets = properties.platformInsets
     val layer = rememberComposeSceneLayer(
         focusable = true
     )
@@ -188,7 +195,10 @@ private fun DialogLayout(
             containerSize = containerSize,
             platformInsets = platformInsets
         )
-        properties.insetsConfig.excludeSafeInsets {
+        PlatformInsetsConfig.excludeInsets(
+            safeInsets = properties.usePlatformInsets,
+            ime = properties.useSoftwareKeyboardInset,
+        ) {
             Layout(
                 content = content,
                 modifier = modifier,
@@ -198,16 +208,28 @@ private fun DialogLayout(
     }
 }
 
+private val DialogProperties.platformInsets: PlatformInsets
+    @Composable get() {
+        val safeInsets = if (usePlatformInsets) {
+            PlatformInsetsConfig.safeInsets
+        } else {
+            PlatformInsets.Zero
+        }
+        val ime = if (useSoftwareKeyboardInset) {
+            PlatformInsetsConfig.ime
+        } else {
+            PlatformInsets.Zero
+        }
+        return safeInsets.union(ime)
+    }
+
 @Composable
 private fun rememberLayerContent(layer: ComposeSceneLayer, content: @Composable () -> Unit) {
     remember(layer, content) {
         layer.setContent(content)
     }
 }
 
-private val DialogProperties.insetsConfig: InsetsConfig
-    get() = if (usePlatformInsets) PlatformInsetsConfig else ZeroInsetsConfig
-
 @Composable
 private fun rememberDialogMeasurePolicy(
     layer: ComposeSceneLayer,

diff --git a/compose/ui/ui/src/skikoMain/kotlin/androidx/compose/ui/window/Popup.skiko.kt b/compose/ui/ui/src/skikoMain/kotlin/androidx/compose/ui/window/Popup.skiko.kt
@@ -40,6 +40,7 @@ import androidx.compose.ui.platform.LocalWindowInfo
 import androidx.compose.ui.platform.PlatformInsets
 import androidx.compose.ui.platform.PlatformInsetsConfig
 import androidx.compose.ui.platform.ZeroInsetsConfig
+import androidx.compose.ui.platform.union
 import androidx.compose.ui.scene.ComposeSceneLayer
 import androidx.compose.ui.scene.rememberComposeSceneLayer
 import androidx.compose.ui.semantics.popup
@@ -433,7 +434,7 @@ private fun PopupLayout(
     onOutsidePointerEvent: ((eventType: PointerEventType) -> Unit)? = null,
     content: @Composable () -> Unit
 ) {
-    val platformInsets = properties.insetsConfig.safeInsets
+    val platformInsets = properties.platformInsets
     var layoutParentBoundsInWindow: IntRect? by remember { mutableStateOf(null) }
     EmptyLayout(Modifier.parentBoundsInWindow { layoutParentBoundsInWindow = it })
     val layer = rememberComposeSceneLayer(
@@ -454,7 +455,10 @@ private fun PopupLayout(
             layoutDirection = layoutDirection,
             parentBoundsInWindow = parentBoundsInWindow
         )
-        properties.insetsConfig.excludeSafeInsets {
+        PlatformInsetsConfig.excludeInsets(
+            safeInsets = properties.usePlatformInsets,
+            ime = false,
+        ) {
             Layout(
                 content = content,
                 modifier = modifier,
@@ -464,6 +468,13 @@ private fun PopupLayout(
     }
 }
 
+private val PopupProperties.platformInsets: PlatformInsets
+    @Composable get() = if (usePlatformInsets) {
+        PlatformInsetsConfig.safeInsets
+    } else {
+        PlatformInsets.Zero
+    }
+
 @Composable
 private fun rememberLayerContent(layer: ComposeSceneLayer, content: @Composable () -> Unit) {
     remember(layer, content) {
@@ -480,9 +491,6 @@ private fun EmptyLayout(modifier: Modifier = Modifier) = Layout(
     }
 )
 
-private val PopupProperties.insetsConfig: InsetsConfig
-    get() = if (usePlatformInsets) PlatformInsetsConfig else ZeroInsetsConfig
-
 private fun Modifier.parentBoundsInWindow(
     onBoundsChanged: (IntRect) -> Unit
 ) = this.onGloballyPositioned { childCoordinates ->

diff --git a/compose/ui/ui/src/uikitMain/kotlin/androidx/compose/ui/platform/PlatformInsets.uikit.kt b/compose/ui/ui/src/uikitMain/kotlin/androidx/compose/ui/platform/PlatformInsets.uikit.kt
@@ -20,6 +20,8 @@ import androidx.compose.runtime.Composable
 import androidx.compose.runtime.CompositionLocalProvider
 import androidx.compose.runtime.InternalComposeApi
 import androidx.compose.runtime.staticCompositionLocalOf
+import androidx.compose.ui.uikit.LocalKeyboardOverlapHeight
+import androidx.compose.ui.unit.dp
 
 /**
  * Composition local for SafeArea of ComposeUIViewController
@@ -38,13 +40,22 @@ private object SafeAreaInsetsConfig : InsetsConfig {
     override val safeInsets: PlatformInsets
         @Composable get() = LocalSafeArea.current
 
+    override val ime: PlatformInsets
+        @Composable get() = PlatformInsets(bottom = LocalKeyboardOverlapHeight.current.dp)
+
     @Composable
-    override fun excludeSafeInsets(content: @Composable () -> Unit) {
+    override fun excludeInsets(
+        safeInsets: Boolean,
+        ime: Boolean,
+        content: @Composable () -> Unit
+    ) {
         val safeArea = LocalSafeArea.current
         val layoutMargins = LocalLayoutMargins.current
+        val keyboardOverlapHeight = LocalKeyboardOverlapHeight.current
         CompositionLocalProvider(
-            LocalSafeArea provides PlatformInsets(),
-            LocalLayoutMargins provides layoutMargins.exclude(safeArea),
+            LocalSafeArea provides if (safeInsets) PlatformInsets() else safeArea,
+            LocalLayoutMargins provides if (safeInsets) layoutMargins.exclude(safeArea) else layoutMargins,
+            LocalKeyboardOverlapHeight provides if (ime) 0f else keyboardOverlapHeight,
             content = content
         )
     }