fix: react-native-navigation integration (#149)

## 📜 Description

Fixed an integration with `react-native-navigation` without hacks.

## 💡 Motivation and Context

To overcome the initial problem I've decided to re-create callback
between `onAttachedToWindow`/`onDetachFromWindow` lifecycles. It
improves the situation, but at some point of time you still may
inconsistent values returned by hook and actual keyboard position.

For me it seems like if the `WindowInsetsAnimationCompat.Callback` is
attached to any parent view of the current screen (i. e. `decorView`,
`rootView`, etc.), then it can be broken after some navigation cycles.

This solution was inspired by
Omelyan/RNNKeyboardController-Test@d5ee7ea.
If we send events through overlay, then it's never broken. I had a look
on a view hierarchy and realised, that overlays are not attached to
parent views or to navigation tree:

<img width="672" alt="image"
src="https://github.com/kirillzyusko/react-native-keyboard-controller/assets/22820318/629002ec-7b41-479e-83b0-6122e75c5827">

I got an inspiration from this idea and decided to replicate this
mechanism in native code. I've decided to attach a view as a child to
`@id/action_bar_root` and setup callback on this view. In this case this
view will not be a parent of navigation tree and will not be inside of
navigation tree:

<img width="675" alt="image"
src="https://github.com/kirillzyusko/react-native-keyboard-controller/assets/22820318/18fc5714-6260-4b8f-b66a-7cee7ff3bc29">

However such approach didn't work out - it seems like if current view
has `onAttachedToWindow`/`onDetachedFromWindow` calls, then Keyboard
insets detection in the end will be broken on API < 30.

I've tried to remove this `eventView` in `onDetachedFromWindow` and
re-create it again in `onAttachedToWindow` - and such combination worked
out.

Fixes
#130

## 📢 Changelog

### Android
- setup callbacks in `onAttachedToWindow`;
- add `eventView` as a child of `@id/action_bar_root` view (in
`onAttachedToWindow`);
- attach a callback to `eventView` rather than
`EdgeToEdgeReactViewGroup` (but still send events through
`EdgeToEdgeReactViewGroup` id)
- added `removeSelf` to `ViewGroup` extensions;
- remove `eventView` in `onDetachedFromWindow`;
- change `inputMode` only if new mode is not equal to current one;

### Docs
- update `README.md`;

## 🤔 How Has This Been Tested?

Tested on Pixel 6 Pro (API 28), emulator.

## 📸 Screenshots (if appropriate):


https://github.com/kirillzyusko/react-native-keyboard-controller/assets/22820318/923fe0b6-cdb3-4bca-92e2-44a2c7fe678d

## 📝 Checklist

- [x] CI successfully passed

Author: kirillzyusko

README.md

@@ -13,6 +13,7 @@ Keyboard manager which works in identical way on both iOS and Android.
 - module for changing soft input mode on Android 🤔
 - reanimated support 🚀
 - interactive keyboard dismissing 👆📱
+- works with any navigation library 🧭
 - and more is coming... Stay tuned! 😊
 
 ## Installation

android/src/main/java/com/reactnativekeyboardcontroller/extensions/ViewGroup.kt

@@ -0,0 +1,10 @@
+package com.reactnativekeyboardcontroller.extensions
+
+import android.view.ViewGroup
+
+fun ViewGroup?.removeSelf() {
+  this ?: return
+  val parent = parent as? ViewGroup ?: return
+
+  parent.removeView(this)
+}

android/src/main/java/com/reactnativekeyboardcontroller/modules/KeyboardControllerModuleImpl.kt

@@ -5,12 +5,7 @@ import com.facebook.react.bridge.ReactApplicationContext
 import com.facebook.react.bridge.UiThreadUtil
 
 class KeyboardControllerModuleImpl(private val mReactContext: ReactApplicationContext) {
-  private val mDefaultMode: Int = mReactContext
-    .currentActivity
-    ?.window
-    ?.attributes
-    ?.softInputMode
-    ?: WindowManager.LayoutParams.SOFT_INPUT_STATE_UNSPECIFIED
+  private val mDefaultMode: Int = getCurrentMode()
 
   fun setInputMode(mode: Int) {
     setSoftInputMode(mode)
@@ -22,10 +17,21 @@ class KeyboardControllerModuleImpl(private val mReactContext: ReactApplicationCo
 
   private fun setSoftInputMode(mode: Int) {
     UiThreadUtil.runOnUiThread {
-      mReactContext.currentActivity?.window?.setSoftInputMode(mode)
+      if (getCurrentMode() != mode) {
+        mReactContext.currentActivity?.window?.setSoftInputMode(mode)
+      }
     }
   }
 
+  private fun getCurrentMode(): Int {
+    return mReactContext
+      .currentActivity
+      ?.window
+      ?.attributes
+      ?.softInputMode
+      ?: WindowManager.LayoutParams.SOFT_INPUT_STATE_UNSPECIFIED
+  }
+
   companion object {
     const val NAME = "KeyboardController"
   }

android/src/main/java/com/reactnativekeyboardcontroller/views/EdgeToEdgeReactViewGroup.kt

@@ -13,6 +13,7 @@ import androidx.core.view.WindowInsetsCompat
 import com.facebook.react.uimanager.ThemedReactContext
 import com.facebook.react.views.view.ReactViewGroup
 import com.reactnativekeyboardcontroller.KeyboardAnimationCallback
+import com.reactnativekeyboardcontroller.extensions.removeSelf
 import com.reactnativekeyboardcontroller.extensions.requestApplyInsetsWhenAttached
 import com.reactnativekeyboardcontroller.extensions.rootView
 
@@ -22,36 +23,72 @@ private val TAG = EdgeToEdgeReactViewGroup::class.qualifiedName
 class EdgeToEdgeReactViewGroup(private val reactContext: ThemedReactContext) : ReactViewGroup(reactContext) {
   private var isStatusBarTranslucent = false
   private var isNavigationBarTranslucent = false
+  private var eventView: ReactViewGroup? = null
 
-  init {
-    val activity = reactContext.currentActivity
+  // region View lifecycles
+  override fun onAttachedToWindow() {
+    super.onAttachedToWindow()
 
-    if (activity != null) {
-      val callback = KeyboardAnimationCallback(
-        view = this,
-        persistentInsetTypes = WindowInsetsCompat.Type.systemBars(),
-        deferredInsetTypes = WindowInsetsCompat.Type.ime(),
-        // We explicitly allow dispatch to continue down to binding.messageHolder's
-        // child views, so that step 2.5 below receives the call
-        dispatchMode = WindowInsetsAnimationCompat.Callback.DISPATCH_MODE_CONTINUE_ON_SUBTREE,
-        context = reactContext,
-      )
-      ViewCompat.setWindowInsetsAnimationCallback(this, callback)
-      ViewCompat.setOnApplyWindowInsetsListener(this, callback)
-      this.requestApplyInsetsWhenAttached()
-    } else {
+    val activity = reactContext.currentActivity
+    if (activity == null) {
       Log.w(TAG, "Can not setup keyboard animation listener, since `currentActivity` is null")
+      return
+    }
+
+    Handler(Looper.getMainLooper()).post(this::setupWindowInsets)
+    WindowCompat.setDecorFitsSystemWindows(
+      activity.window,
+      false,
+    )
+
+    eventView = ReactViewGroup(context)
+    val root = this.getContentView()
+    root?.addView(eventView)
+
+    val callback = KeyboardAnimationCallback(
+      view = this,
+      persistentInsetTypes = WindowInsetsCompat.Type.systemBars(),
+      deferredInsetTypes = WindowInsetsCompat.Type.ime(),
+      dispatchMode = WindowInsetsAnimationCompat.Callback.DISPATCH_MODE_CONTINUE_ON_SUBTREE,
+      context = reactContext,
+    )
+
+    eventView?.let {
+      ViewCompat.setWindowInsetsAnimationCallback(it, callback)
+      ViewCompat.setOnApplyWindowInsetsListener(it, callback)
+      it.requestApplyInsetsWhenAttached()
     }
   }
 
+  override fun onDetachedFromWindow() {
+    super.onDetachedFromWindow()
+
+    eventView.removeSelf()
+  }
+  // endregion
+
+  // region Props setters
+  fun setStatusBarTranslucent(isStatusBarTranslucent: Boolean) {
+    this.isStatusBarTranslucent = isStatusBarTranslucent
+  }
+
+  fun setNavigationBarTranslucent(isNavigationBarTranslucent: Boolean) {
+    this.isNavigationBarTranslucent = isNavigationBarTranslucent
+  }
+  // endregion
+
+  // region Private functions/class helpers
+  private fun getContentView(): FitWindowsLinearLayout? {
+    return reactContext.currentActivity?.window?.decorView?.rootView?.findViewById(
+      androidx.appcompat.R.id.action_bar_root,
+    )
+  }
+
   private fun setupWindowInsets() {
     val rootView = reactContext.rootView
     if (rootView != null) {
       ViewCompat.setOnApplyWindowInsetsListener(rootView) { v, insets ->
-        val content =
-          reactContext.rootView?.findViewById<FitWindowsLinearLayout>(
-            androidx.appcompat.R.id.action_bar_root,
-          )
+        val content = getContentView()
         val params = FrameLayout.LayoutParams(
           FrameLayout.LayoutParams.MATCH_PARENT,
           FrameLayout.LayoutParams.MATCH_PARENT,
@@ -80,24 +117,5 @@ class EdgeToEdgeReactViewGroup(private val reactContext: ThemedReactContext) : R
       }
     }
   }
-
-  override fun onAttachedToWindow() {
-    super.onAttachedToWindow()
-
-    Handler(Looper.getMainLooper()).post(this::setupWindowInsets)
-    reactContext.currentActivity?.let {
-      WindowCompat.setDecorFitsSystemWindows(
-        it.window,
-        false,
-      )
-    }
-  }
-
-  fun setStatusBarTranslucent(isStatusBarTranslucent: Boolean) {
-    this.isStatusBarTranslucent = isStatusBarTranslucent
-  }
-
-  fun setNavigationBarTranslucent(isNavigationBarTranslucent: Boolean) {
-    this.isNavigationBarTranslucent = isNavigationBarTranslucent
-  }
+  // endregion
 }