Expect insets in common (#586)

* Expect WindowInsets in commonMain * Move app layout mpp example to common * Copy comments to common
JetBrains · Jun 9, 2023 · 16167ae · 16167ae
1 parent 47c012b
commit 16167ae
Show file tree

Hide file tree

Showing 8 changed files with 269 additions and 110 deletions.
diff --git a/compose/foundation/foundation-layout/build.gradle b/compose/foundation/foundation-layout/build.gradle
@@ -106,6 +106,11 @@ if(AndroidXComposePlugin.isMultiplatformEnabled(project)) {
 
             jsWasmMain.dependsOn(jsNativeMain)
 
+            notMobileMain.dependsOn(commonMain)
+            desktopMain.dependsOn(notMobileMain)
+            macosMain.dependsOn(notMobileMain)
+            jsWasmMain.dependsOn(notMobileMain)
+
             jsMain {
                 dependsOn(jsWasmMain)
                 dependencies {

diff --git a/...-layout/src/androidMain/kotlin/androidx/compose/foundation/layout/WindowInsets.android.kt b/...-layout/src/androidMain/kotlin/androidx/compose/foundation/layout/WindowInsets.android.kt
@@ -120,7 +120,7 @@ var ComposeView.consumeWindowInsets: Boolean
 /**
  * For the [WindowInsetsCompat.Type.captionBar].
  */
-val WindowInsets.Companion.captionBar: WindowInsets
+actual val WindowInsets.Companion.captionBar: WindowInsets
     @Composable
     @NonRestartableComposable
     get() = WindowInsetsHolder.current().captionBar
@@ -129,7 +129,7 @@ val WindowInsets.Companion.captionBar: WindowInsets
  * For the [WindowInsetsCompat.Type.displayCutout]. This insets represents the area that the
  * display cutout (e.g. for camera) is and important content should be excluded from.
  */
-val WindowInsets.Companion.displayCutout: WindowInsets
+actual val WindowInsets.Companion.displayCutout: WindowInsets
     @Composable
     @NonRestartableComposable
     get() = WindowInsetsHolder.current().displayCutout
@@ -143,7 +143,7 @@ val WindowInsets.Companion.displayCutout: WindowInsets
  * `AndroidManifest.xml` file and call `WindowCompat.setDecorFitsSystemWindows(window, false)`
  * in their [android.app.Activity.onCreate].
  */
-val WindowInsets.Companion.ime: WindowInsets
+actual val WindowInsets.Companion.ime: WindowInsets
     @Composable
     @NonRestartableComposable
     get() = WindowInsetsHolder.current().ime
@@ -152,7 +152,7 @@ val WindowInsets.Companion.ime: WindowInsets
  * For the [WindowInsetsCompat.Type.mandatorySystemGestures]. These insets represents the
  * space where system gestures have priority over application gestures.
  */
-val WindowInsets.Companion.mandatorySystemGestures: WindowInsets
+actual val WindowInsets.Companion.mandatorySystemGestures: WindowInsets
     @Composable
     @NonRestartableComposable
     get() = WindowInsetsHolder.current().mandatorySystemGestures
@@ -162,47 +162,47 @@ val WindowInsets.Companion.mandatorySystemGestures: WindowInsets
  * system UI places navigation bars. Interactive UI should avoid the navigation bars
  * area.
  */
-val WindowInsets.Companion.navigationBars: WindowInsets
+actual val WindowInsets.Companion.navigationBars: WindowInsets
     @Composable
     @NonRestartableComposable
     get() = WindowInsetsHolder.current().navigationBars
 
 /**
  * For the [WindowInsetsCompat.Type.statusBars].
  */
-val WindowInsets.Companion.statusBars: WindowInsets
+actual val WindowInsets.Companion.statusBars: WindowInsets
     @Composable
     @NonRestartableComposable
     get() = WindowInsetsHolder.current().statusBars
 
 /**
  * For the [WindowInsetsCompat.Type.systemBars].
  */
-val WindowInsets.Companion.systemBars: WindowInsets
+actual val WindowInsets.Companion.systemBars: WindowInsets
     @Composable
     @NonRestartableComposable
     get() = WindowInsetsHolder.current().systemBars
 
 /**
  * For the [WindowInsetsCompat.Type.systemGestures].
  */
-val WindowInsets.Companion.systemGestures: WindowInsets
+actual val WindowInsets.Companion.systemGestures: WindowInsets
     @Composable
     @NonRestartableComposable
     get() = WindowInsetsHolder.current().systemGestures
 
 /**
  * For the [WindowInsetsCompat.Type.tappableElement].
  */
-val WindowInsets.Companion.tappableElement: WindowInsets
+actual val WindowInsets.Companion.tappableElement: WindowInsets
     @Composable
     @NonRestartableComposable
     get() = WindowInsetsHolder.current().tappableElement
 
 /**
  * The insets for the curved areas in a waterfall display.
  */
-val WindowInsets.Companion.waterfall: WindowInsets
+actual val WindowInsets.Companion.waterfall: WindowInsets
     @Composable
     @NonRestartableComposable
     get() = WindowInsetsHolder.current().waterfall
@@ -212,7 +212,7 @@ val WindowInsets.Companion.waterfall: WindowInsets
  * This includes all [system bars][systemBars], [display cutout][displayCutout], and
  * [soft keyboard][ime].
  */
-val WindowInsets.Companion.safeDrawing: WindowInsets
+actual val WindowInsets.Companion.safeDrawing: WindowInsets
     @Composable
     @NonRestartableComposable
     get() = WindowInsetsHolder.current().safeDrawing
@@ -223,7 +223,7 @@ val WindowInsets.Companion.safeDrawing: WindowInsets
  * [mandatory system gestures][mandatorySystemGestures],
  * [rounded display areas][waterfall], and [tappable areas][tappableElement].
  */
-val WindowInsets.Companion.safeGestures: WindowInsets
+actual val WindowInsets.Companion.safeGestures: WindowInsets
     @Composable
     @NonRestartableComposable
     get() = WindowInsetsHolder.current().safeGestures
@@ -232,7 +232,7 @@ val WindowInsets.Companion.safeGestures: WindowInsets
  * The insets that include all areas that may be drawn over or have gesture confusion,
  * including everything in [safeDrawing] and [safeGestures].
  */
-val WindowInsets.Companion.safeContent: WindowInsets
+actual val WindowInsets.Companion.safeContent: WindowInsets
     @Composable
     @NonRestartableComposable
     get() = WindowInsetsHolder.current().safeContent

diff --git a/...oundation-layout/src/commonMain/kotlin/androidx/compose/foundation/layout/WindowInsets.kt b/...oundation-layout/src/commonMain/kotlin/androidx/compose/foundation/layout/WindowInsets.kt
@@ -671,3 +671,75 @@ private class InsetsPaddingValues(
         return result
     }
 }
+
+/**
+ * An insets type representing the window of a caption bar.
+ */
+expect val WindowInsets.Companion.captionBar: WindowInsets
+
+/**
+ * This [WindowInsets] represents the area with the display cutout (e.g. for camera).
+ */
+expect val WindowInsets.Companion.displayCutout: WindowInsets
+
+/**
+ * An insets type representing the window of the software keyboard.
+ */
+expect val WindowInsets.Companion.ime: WindowInsets
+
+/**
+ * These insets represent the space where system gestures have priority over application gestures.
+ */
+expect val WindowInsets.Companion.mandatorySystemGestures: WindowInsets
+
+/**
+ * These insets represent where system UI places navigation bars.
+ * Interactive UI should avoid the navigation bars area.
+ */
+expect val WindowInsets.Companion.navigationBars: WindowInsets
+
+/**
+ * These insets represent status bar.
+ */
+expect val WindowInsets.Companion.statusBars: WindowInsets
+
+/**
+ * These insets represent all system bars.
+ * Includes [statusBars], [captionBar] as well as [navigationBars], but not [ime].
+ */
+expect val WindowInsets.Companion.systemBars: WindowInsets
+
+/**
+ * The [systemGestures] insets represent the area of a window where system gestures have
+ * priority and may consume some or all touch input, e.g. due to the system bar
+ * occupying it, or it being reserved for touch-only gestures.
+ */
+expect val WindowInsets.Companion.systemGestures: WindowInsets
+
+/**
+ * Returns the tappable element insets.
+ */
+expect val WindowInsets.Companion.tappableElement: WindowInsets
+
+/**
+ * The insets for the curved areas in a waterfall display.
+ */
+expect val WindowInsets.Companion.waterfall: WindowInsets
+
+/**
+ * The insets that include areas where content may be covered by other drawn content.
+ * This includes all [systemBars], [displayCutout], and [ime].
+ */
+expect val WindowInsets.Companion.safeDrawing: WindowInsets
+
+/**
+ * The insets that include areas where gestures may be confused with other input,
+ * including [systemGestures], [mandatorySystemGestures], [waterfall], and [tappableElement].
+ */
+expect val WindowInsets.Companion.safeGestures: WindowInsets
+
+/**
+ * The insets that include all areas that may be drawn over or have gesture confusion,
+ * including everything in [safeDrawing] and [safeGestures].
+ */
+expect val WindowInsets.Companion.safeContent: WindowInsets
diff --git a/...out/src/notMobileMain/kotlin/androidx/compose/foundation/layout/WindowInsets.notMobile.kt b/...out/src/notMobileMain/kotlin/androidx/compose/foundation/layout/WindowInsets.notMobile.kt
@@ -0,0 +1,58 @@
+/*
+ * Copyright 2023 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.foundation.layout
+
+private val ZeroInsets = WindowInsets(0, 0, 0, 0)
+
+actual val WindowInsets.Companion.captionBar: WindowInsets
+    get() = ZeroInsets
+
+actual val WindowInsets.Companion.displayCutout: WindowInsets
+    get() = ZeroInsets
+
+actual val WindowInsets.Companion.ime: WindowInsets
+    get() = ZeroInsets
+
+actual val WindowInsets.Companion.mandatorySystemGestures: WindowInsets
+    get() = ZeroInsets
+
+actual val WindowInsets.Companion.navigationBars: WindowInsets
+    get() = ZeroInsets
+
+actual val WindowInsets.Companion.statusBars: WindowInsets
+    get() = ZeroInsets
+
+actual val WindowInsets.Companion.systemBars: WindowInsets
+    get() = ZeroInsets
+
+actual val WindowInsets.Companion.systemGestures: WindowInsets
+    get() = ZeroInsets
+
+actual val WindowInsets.Companion.tappableElement: WindowInsets
+    get() = ZeroInsets
+
+actual val WindowInsets.Companion.waterfall: WindowInsets
+    get() = ZeroInsets
+
+actual val WindowInsets.Companion.safeDrawing: WindowInsets
+    get() = ZeroInsets
+
+actual val WindowInsets.Companion.safeGestures: WindowInsets
+    get() = ZeroInsets
+
+actual val WindowInsets.Companion.safeContent: WindowInsets
+    get() = ZeroInsets
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
@@ -53,12 +53,13 @@ private val WindowInsets.Companion.layoutMargins: WindowInsets
  * An insets type representing the window of a caption bar.
  * It is useless for iOS.
  */
-val WindowInsets.Companion.captionBar get() = ZeroInsets
+actual val WindowInsets.Companion.captionBar: WindowInsets
+    get() = ZeroInsets
 
 /**
  * This [WindowInsets] represents the area with the display cutout (e.g. for camera).
  */
-val WindowInsets.Companion.displayCutout: WindowInsets
+actual val WindowInsets.Companion.displayCutout: WindowInsets
     @Composable
     @OptIn(InternalComposeApi::class)
     get() = when (LocalInterfaceOrientationState.current.value) {
@@ -74,30 +75,30 @@ val WindowInsets.Companion.displayCutout: WindowInsets
  *
  * TODO: Animation doesn't work on iOS yet
  */
-val WindowInsets.Companion.ime: WindowInsets
+actual val WindowInsets.Companion.ime: WindowInsets
     @Composable
     @OptIn(InternalComposeApi::class)
     get() = WindowInsets(bottom = LocalKeyboardOverlapHeightState.current.value.dp)
 
 /**
- * These insets represents the space where system gestures have priority over application gestures.
+ * These insets represent the space where system gestures have priority over application gestures.
  */
-val WindowInsets.Companion.mandatorySystemGestures: WindowInsets
+actual val WindowInsets.Companion.mandatorySystemGestures: WindowInsets
     @Composable
     get() = iosSafeArea.only(WindowInsetsSides.Top + WindowInsetsSides.Bottom)
 
 /**
  * These insets represent where system UI places navigation bars.
  * Interactive UI should avoid the navigation bars area.
  */
-val WindowInsets.Companion.navigationBars: WindowInsets
+actual val WindowInsets.Companion.navigationBars: WindowInsets
     @Composable
     get() = iosSafeArea.only(WindowInsetsSides.Bottom)
 
 /**
- * These insets represents status bar.
+ * These insets represent status bar.
  */
-val WindowInsets.Companion.statusBars: WindowInsets
+actual val WindowInsets.Companion.statusBars: WindowInsets
     @Composable
     @OptIn(InternalComposeApi::class)
     get() = when (LocalInterfaceOrientationState.current.value) {
@@ -106,56 +107,56 @@ val WindowInsets.Companion.statusBars: WindowInsets
     }
 
 /**
- * These insets represents all system bars.
+ * These insets represent all system bars.
  * Includes [statusBars], [captionBar] as well as [navigationBars], but not [ime].
  */
-val WindowInsets.Companion.systemBars: WindowInsets
+actual val WindowInsets.Companion.systemBars: WindowInsets
     @Composable
     get() = iosSafeArea
 
 /**
- * The systemGestures insets represent the area of a window where system gestures have
+ * The [systemGestures] insets represent the area of a window where system gestures have
  * priority and may consume some or all touch input, e.g. due to the system bar
  * occupying it, or it being reserved for touch-only gestures.
  */
-val WindowInsets.Companion.systemGestures: WindowInsets
+actual val WindowInsets.Companion.systemGestures: WindowInsets
     @Composable
     get() = layoutMargins // the same as iosSafeArea.add(WindowInsets(left = 16.dp, right = 16.dp))
 
 /**
  * Returns the tappable element insets.
  */
-val WindowInsets.Companion.tappableElement: WindowInsets
+actual val WindowInsets.Companion.tappableElement: WindowInsets
     @Composable
     get() = iosSafeArea.only(WindowInsetsSides.Top)
 
 /**
  * The insets for the curved areas in a waterfall display.
  * It is useless for iOS.
  */
-val WindowInsets.Companion.waterfall: WindowInsets get() = ZeroInsets
+actual val WindowInsets.Companion.waterfall: WindowInsets get() = ZeroInsets
 
 /**
  * The insets that include areas where content may be covered by other drawn content.
  * This includes all [systemBars], [displayCutout], and [ime].
  */
-val WindowInsets.Companion.safeDrawing
+actual val WindowInsets.Companion.safeDrawing: WindowInsets
     @Composable
     get() = systemBars.union(ime).union(displayCutout)
 
 /**
  * The insets that include areas where gestures may be confused with other input,
  * including [systemGestures], [mandatorySystemGestures], [waterfall], and [tappableElement].
  */
-val WindowInsets.Companion.safeGestures: WindowInsets
+actual val WindowInsets.Companion.safeGestures: WindowInsets
     @Composable
     get() = tappableElement.union(mandatorySystemGestures).union(systemGestures).union(waterfall)
 
 /**
  * The insets that include all areas that may be drawn over or have gesture confusion,
  * including everything in [safeDrawing] and [safeGestures].
  */
-val WindowInsets.Companion.safeContent: WindowInsets
+actual val WindowInsets.Companion.safeContent: WindowInsets
     @Composable
     get() = safeDrawing.union(safeGestures)