Merge pull request #31 from mori-atsushi/v0.1.0-alpha05

Prepare v0.1.0-alpha05

Author: mori-atsushi

README.md

@@ -7,12 +7,12 @@
 
 InsetsX provides a [WindowInsets](https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/WindowInsets) utility for [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform/).
 
-It aim to work with WindowInsets with the same interface on iOS and Android.
+The goal is to have a unified interface for handling WindowInsets across iOS and Android.
 
-This library will be archived when the official library can handle WindowInsets.
+Once the official library supports WindowInsets, this library will be archived.
 
 ## Setup
-Add the dependency as follows:
+To use InsetsX, add the following dependency:
 
 ```kotlin
 kotlin {
@@ -28,37 +28,110 @@ kotlin {
 }
 ```
 
+### Android
+1. (option) If you are using insets for IME support, set the activity's `windowSoftInputMode` to `adjustResize` in your AndroidManifest.xml file.
+
+```xml
+<activity
+      android:name=".MyActivity"
+      android:windowSoftInputMode="adjustResize">
+</activity>
+```
+
+2. Call `WindowCompat.setDecorFitsSystemWindows()` with `false` in the `onCreate` method of the activity .
+
+```kotlin
+override fun onCreate(savedInstanceState: Bundle?) {
+    super.onCreate(savedInstanceState)
+
+    WindowCompat.setDecorFitsSystemWindows(window, false)
+}
+```
+
+Detail: [Lay out your app within window insets](https://developer.android.com/develop/ui/views/layout/insets)
+
+### iOS
+
+1. (option) If you are using `WindowInsetsController`, use `WindowInsetsUIViewController` instead of `ComposeUIViewController`.
+
+```kotlin
+fun MainUIViewController(): UIViewController {
+    return WindowInsetsUIViewController {
+        MyApp()
+    }
+}
+```
+
 ## How to use
+### WindowInsets
 This works much like Android's WindowInsets.
 Please note that the package name is different.
 
 ```kotlin
 import androidx.compose.foundation.layout.windowInsetsPadding
 import androidx.compose.foundation.layout.WindowInsets
+import androidx.compose.runtime.Composable
 import androidx.compose.ui.Modifier
 import com.moriatsushi.insetsx.systemBars
 import com.moriatsushi.insetsx.systemBarsPadding
 
-val modifier1 = Modifier
-    .windowInsetsPadding(WindowInsets.systemBars)
+@Composable
+fun Sample() {
+    val modifier1 = Modifier
+        .windowInsetsPadding(WindowInsets.safeDrawing)
 
-val modifier2 = Modifier
-    .systemBarsPadding()
+    val modifier2 = Modifier
+        .safeDrawingPadding()
+}
 ```
 
-## APIs
-
 API|android|ios
 :--|:--|:--
-WindowInsets.systemBars|status bar + navigation bar|SafeArea
-WindowInsets.navigationBars|navigation bar|bottom of SafeArea
-WindowInsets.statusBars|status bar|top and horizontal of SafeArea
+WindowInsets.safeArea|system bars + display cutouts|SafeArea
+WindowInsets.systemBars|status bar + navigation bar|home indicator + status bar
+WindowInsets.navigationBars|navigation bar|home indicator
+WindowInsets.statusBars|status bar|status bar
 WindowInsets.ime *1|software keyboard|software keyboard
 WindowInsets.safeDrawing *1|system bars + software keyboard|SafeArea + software keyboard
-Modifier.systemBarsPadding()|status bar + navigation bar|SafeArea
-Modifier.navigationBarsPadding()|navigation bar|bottom of SafeArea
-Modifier.statusBarsPadding()|status bar|top and horizontal of SafeArea
+(Modifier)||
+Modifier.safeAreaPadding()|system bars + display cutouts|SafeArea
+Modifier.systemBarsPadding()|status bar + navigation bar|home indicator + status bar
+Modifier.navigationBarsPadding()|navigation bar|home indicator
+Modifier.statusBarsPadding()|status bar|status bar
 Modifier.imePadding() *1|software keyboard|software keyboard
 Modifier.safeDrawingPadding() *1|system bars + software keyboard|SafeArea + software keyboard
 
 *1 is experimental
+
+### WindowInsetsController
+`WindowInsetsController` can be used to change colors of system bars.
+
+```kotlin
+@Composable
+fun Sample() {
+    val windowInsetsController = rememberWindowInsetsController()
+    LaunchedEffect(Unit) {
+        // The status bars icon + content will change to a light color
+        windowInsetsController?.setStatusBarContentColor(dark = false)
+        // The navigation bars icons will change to a light color (android only)
+        windowInsetsController?.setNavigationBarsContentColor(dark = false)
+    }
+}
+```
+
+You can also hide WindowInsets.
+
+```kotlin
+@Composable
+fun Sample() {
+    val windowInsetsController = rememberWindowInsetsController()
+    LaunchedEffect(Unit) {
+        // Hide the status bars
+        windowInsetsController?.setIsStatusBarsVisible(false)
+        // Hide the navigation bars
+        windowInsetsController?.setIsNavigationBarsVisible(false)
+        // Change an options for behavior when system bars are hidden
+        windowInsetsController?.setSystemBarsBehavior(SystemBarsBehavior.Immersive)
+    }
+}
+```

gradle.properties

@@ -22,7 +22,7 @@ org.jetbrains.compose.experimental.uikit.enabled=true
 SONATYPE_HOST=S01
 RELEASE_SIGNING_ENABLED=true
 GROUP=com.moriatsushi.insetsx
-VERSION_NAME=0.1.0-alpha04
+VERSION_NAME=0.1.0-alpha05
 
 POM_NAME=InsetsX
 POM_DESCRIPTION=WindowInsets utility for compose multiplatform