react-native-keyboard-controller 1.13.4 → 1.14.0

package/android/src/main/java/com/reactnativekeyboardcontroller/views/overlay/OverKeyboardViewGroup.kt

@@ -0,0 +1,185 @@
+package com.reactnativekeyboardcontroller.views.overlay
+
+import android.annotation.SuppressLint
+import android.content.Context
+import android.graphics.PixelFormat
+import android.view.MotionEvent
+import android.view.View
+import android.view.WindowManager
+import com.facebook.react.bridge.UiThreadUtil
+import com.facebook.react.config.ReactFeatureFlags
+import com.facebook.react.uimanager.JSPointerDispatcher
+import com.facebook.react.uimanager.JSTouchDispatcher
+import com.facebook.react.uimanager.RootView
+import com.facebook.react.uimanager.ThemedReactContext
+import com.facebook.react.uimanager.UIManagerHelper
+import com.facebook.react.uimanager.events.EventDispatcher
+import com.facebook.react.views.view.ReactViewGroup
+
+@SuppressLint("ViewConstructor")
+class OverKeyboardHostView(
+  private val reactContext: ThemedReactContext,
+) : ReactViewGroup(reactContext) {
+  private val dispatcher = UIManagerHelper.getEventDispatcherForReactTag(reactContext, this.id)
+  private var windowManager: WindowManager = reactContext.getSystemService(Context.WINDOW_SERVICE) as WindowManager
+  private var hostView: OverKeyboardRootViewGroup = OverKeyboardRootViewGroup(reactContext)
+
+  init {
+    hostView.eventDispatcher = dispatcher
+  }
+
+  // region life cycles
+  override fun onDetachedFromWindow() {
+    super.onDetachedFromWindow()
+
+    hide()
+  }
+
+  override fun addView(
+    child: View?,
+    index: Int,
+  ) {
+    UiThreadUtil.assertOnUiThread()
+    hostView.addView(child, index)
+  }
+
+  override fun getChildCount(): Int = hostView.childCount
+
+  override fun getChildAt(index: Int): View? = hostView.getChildAt(index)
+
+  override fun removeView(child: View?) {
+    UiThreadUtil.assertOnUiThread()
+
+    if (child != null) {
+      hostView.removeView(child)
+    }
+  }
+
+  override fun removeViewAt(index: Int) {
+    UiThreadUtil.assertOnUiThread()
+    val child = getChildAt(index)
+    hostView.removeView(child)
+  }
+
+  override fun onLayout(
+    changed: Boolean,
+    l: Int,
+    t: Int,
+    r: Int,
+    b: Int,
+  ) {
+    // Do nothing as we are laid out by UIManager
+  }
+  // endregion
+
+  fun show() {
+    val layoutParams =
+      WindowManager.LayoutParams(
+        WindowManager.LayoutParams.MATCH_PARENT,
+        WindowManager.LayoutParams.MATCH_PARENT,
+        // This type ensures it floats over other application windows but under system windows
+        WindowManager.LayoutParams.TYPE_APPLICATION_PANEL,
+        // Ensures touches outside the view pass through to other windows
+        WindowManager.LayoutParams.FLAG_NOT_FOCUSABLE or WindowManager.LayoutParams.FLAG_LAYOUT_NO_LIMITS,
+        PixelFormat.TRANSLUCENT,
+      )
+
+    windowManager.addView(hostView, layoutParams)
+  }
+
+  fun hide() {
+    if (hostView.isAttached) {
+      windowManager.removeView(hostView)
+    }
+  }
+}
+
+@SuppressLint("ViewConstructor")
+class OverKeyboardRootViewGroup(
+  private val reactContext: ThemedReactContext,
+) : ReactViewGroup(reactContext),
+  RootView {
+  private val jsTouchDispatcher: JSTouchDispatcher = JSTouchDispatcher(this)
+  private var jsPointerDispatcher: JSPointerDispatcher? = null
+  internal var eventDispatcher: EventDispatcher? = null
+  internal var isAttached = false
+
+  init {
+    if (ReactFeatureFlags.dispatchPointerEvents) {
+      jsPointerDispatcher = JSPointerDispatcher(this)
+    }
+  }
+
+  // region life cycles
+  override fun onAttachedToWindow() {
+    super.onAttachedToWindow()
+    isAttached = true
+  }
+
+  override fun onDetachedFromWindow() {
+    super.onDetachedFromWindow()
+    isAttached = false
+  }
+  // endregion
+
+  // region Touch events handling
+  override fun onInterceptTouchEvent(event: MotionEvent): Boolean {
+    eventDispatcher?.let { eventDispatcher ->
+      jsTouchDispatcher.handleTouchEvent(event, eventDispatcher)
+      jsPointerDispatcher?.handleMotionEvent(event, eventDispatcher, true)
+    }
+    return super.onInterceptTouchEvent(event)
+  }
+
+  @SuppressLint("ClickableViewAccessibility")
+  override fun onTouchEvent(event: MotionEvent): Boolean {
+    eventDispatcher?.let { eventDispatcher ->
+      jsTouchDispatcher.handleTouchEvent(event, eventDispatcher)
+      jsPointerDispatcher?.handleMotionEvent(event, eventDispatcher, false)
+    }
+    super.onTouchEvent(event)
+    // In case when there is no children interested in handling touch event, we return true from
+    // the root view in order to receive subsequent events related to that gesture
+    return true
+  }
+
+  override fun onInterceptHoverEvent(event: MotionEvent): Boolean {
+    eventDispatcher?.let { jsPointerDispatcher?.handleMotionEvent(event, it, true) }
+    return super.onHoverEvent(event)
+  }
+
+  override fun onHoverEvent(event: MotionEvent): Boolean {
+    eventDispatcher?.let { jsPointerDispatcher?.handleMotionEvent(event, it, false) }
+    return super.onHoverEvent(event)
+  }
+
+  override fun requestDisallowInterceptTouchEvent(disallowIntercept: Boolean) {
+    // No-op - override in order to still receive events to onInterceptTouchEvent
+    // even when some other view disallow that
+  }
+  // endregion
+
+  // region RootView methods
+  override fun onChildStartedNativeGesture(
+    childView: View,
+    ev: MotionEvent,
+  ) {
+    eventDispatcher?.let { eventDispatcher ->
+      jsTouchDispatcher.onChildStartedNativeGesture(ev, eventDispatcher)
+      jsPointerDispatcher?.onChildStartedNativeGesture(childView, ev, eventDispatcher)
+    }
+  }
+
+  override fun onChildEndedNativeGesture(
+    childView: View,
+    ev: MotionEvent,
+  ) {
+    eventDispatcher?.let { jsTouchDispatcher.onChildEndedNativeGesture(ev, it) }
+    jsPointerDispatcher?.onChildEndedNativeGesture()
+  }
+
+  override fun handleException(t: Throwable) {
+    reactContext.reactApplicationContext.handleException(RuntimeException(t))
+  }
+  // endregion
+}

package/android/src/paper/java/com/reactnativekeyboardcontroller/KeyboardControllerModule.kt

@@ -5,7 +5,9 @@ import com.facebook.react.bridge.ReactContextBaseJavaModule
 import com.facebook.react.bridge.ReactMethod
 import com.reactnativekeyboardcontroller.modules.KeyboardControllerModuleImpl
 
-class KeyboardControllerModule(mReactContext: ReactApplicationContext) : ReactContextBaseJavaModule(mReactContext) {
+class KeyboardControllerModule(
+  mReactContext: ReactApplicationContext,
+) : ReactContextBaseJavaModule(mReactContext) {
   private val module = KeyboardControllerModuleImpl(mReactContext)
 
   override fun getName(): String = KeyboardControllerModuleImpl.NAME

package/android/src/paper/java/com/reactnativekeyboardcontroller/KeyboardControllerViewManager.kt

@@ -7,31 +7,40 @@ import com.facebook.react.views.view.ReactViewManager
 import com.reactnativekeyboardcontroller.managers.KeyboardControllerViewManagerImpl
 import com.reactnativekeyboardcontroller.views.EdgeToEdgeReactViewGroup
 
-class KeyboardControllerViewManager(mReactContext: ReactApplicationContext) : ReactViewManager() {
+class KeyboardControllerViewManager(
+  mReactContext: ReactApplicationContext,
+) : ReactViewManager() {
   private val manager = KeyboardControllerViewManagerImpl(mReactContext)
 
   override fun getName(): String = KeyboardControllerViewManagerImpl.NAME
 
-  override fun createViewInstance(reactContext: ThemedReactContext): EdgeToEdgeReactViewGroup {
-    return manager.createViewInstance(reactContext)
-  }
+  override fun createViewInstance(reactContext: ThemedReactContext): EdgeToEdgeReactViewGroup =
+    manager.createViewInstance(reactContext)
 
   @ReactProp(name = "enabled")
-  fun setEnabled(view: EdgeToEdgeReactViewGroup, enabled: Boolean) {
+  fun setEnabled(
+    view: EdgeToEdgeReactViewGroup,
+    enabled: Boolean,
+  ) {
     manager.setEnabled(view, enabled)
   }
 
   @ReactProp(name = "statusBarTranslucent")
-  fun setStatusBarTranslucent(view: EdgeToEdgeReactViewGroup, isStatusBarTranslucent: Boolean) {
+  fun setStatusBarTranslucent(
+    view: EdgeToEdgeReactViewGroup,
+    isStatusBarTranslucent: Boolean,
+  ) {
     manager.setStatusBarTranslucent(view, isStatusBarTranslucent)
   }
 
   @ReactProp(name = "navigationBarTranslucent")
-  fun setNavigationBarTranslucent(view: EdgeToEdgeReactViewGroup, isNavigationBarTranslucent: Boolean) {
+  fun setNavigationBarTranslucent(
+    view: EdgeToEdgeReactViewGroup,
+    isNavigationBarTranslucent: Boolean,
+  ) {
     manager.setNavigationBarTranslucent(view, isNavigationBarTranslucent)
   }
 
-  override fun getExportedCustomDirectEventTypeConstants(): MutableMap<String, Any> {
-    return manager.getExportedCustomDirectEventTypeConstants()
-  }
+  override fun getExportedCustomDirectEventTypeConstants(): MutableMap<String, Any> =
+    manager.getExportedCustomDirectEventTypeConstants()
 }

package/android/src/paper/java/com/reactnativekeyboardcontroller/KeyboardGestureAreaViewManager.kt

@@ -7,32 +7,45 @@ import com.facebook.react.views.view.ReactViewManager
 import com.reactnativekeyboardcontroller.managers.KeyboardGestureAreaViewManagerImpl
 import com.reactnativekeyboardcontroller.views.KeyboardGestureAreaReactViewGroup
 
-class KeyboardGestureAreaViewManager(mReactContext: ReactApplicationContext) : ReactViewManager() {
+class KeyboardGestureAreaViewManager(
+  mReactContext: ReactApplicationContext,
+) : ReactViewManager() {
   private val manager = KeyboardGestureAreaViewManagerImpl(mReactContext)
 
   override fun getName(): String = KeyboardGestureAreaViewManagerImpl.NAME
 
-  override fun createViewInstance(reactContext: ThemedReactContext): KeyboardGestureAreaReactViewGroup {
-    return manager.createViewInstance(reactContext)
-  }
+  override fun createViewInstance(reactContext: ThemedReactContext): KeyboardGestureAreaReactViewGroup =
+    manager.createViewInstance(reactContext)
 
   @ReactProp(name = "offset")
-  fun setInterpolator(view: KeyboardGestureAreaReactViewGroup, offset: Double) {
+  fun setInterpolator(
+    view: KeyboardGestureAreaReactViewGroup,
+    offset: Double,
+  ) {
     manager.setOffset(view, offset)
   }
 
   @ReactProp(name = "interpolator")
-  fun setInterpolator(view: KeyboardGestureAreaReactViewGroup, interpolator: String) {
+  fun setInterpolator(
+    view: KeyboardGestureAreaReactViewGroup,
+    interpolator: String,
+  ) {
     manager.setInterpolator(view, interpolator)
   }
 
   @ReactProp(name = "showOnSwipeUp")
-  fun setScrollKeyboardOnScreenWhenNotVisible(view: KeyboardGestureAreaReactViewGroup, value: Boolean) {
+  fun setScrollKeyboardOnScreenWhenNotVisible(
+    view: KeyboardGestureAreaReactViewGroup,
+    value: Boolean,
+  ) {
     manager.setScrollKeyboardOnScreenWhenNotVisible(view, value)
   }
 
   @ReactProp(name = "enableSwipeToDismiss")
-  fun setScrollKeyboardOffScreenWhenVisible(view: KeyboardGestureAreaReactViewGroup, value: Boolean) {
+  fun setScrollKeyboardOffScreenWhenVisible(
+    view: KeyboardGestureAreaReactViewGroup,
+    value: Boolean,
+  ) {
     manager.setScrollKeyboardOffScreenWhenVisible(view, value)
   }
 }

package/android/src/paper/java/com/reactnativekeyboardcontroller/OverKeyboardViewManager.kt

@@ -0,0 +1,33 @@
+package com.reactnativekeyboardcontroller
+
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.uimanager.LayoutShadowNode
+import com.facebook.react.uimanager.ThemedReactContext
+import com.facebook.react.uimanager.ViewGroupManager
+import com.facebook.react.uimanager.annotations.ReactProp
+import com.reactnativekeyboardcontroller.managers.OverKeyboardViewManagerImpl
+import com.reactnativekeyboardcontroller.views.overlay.OverKeyboardHostShadowNode
+import com.reactnativekeyboardcontroller.views.overlay.OverKeyboardHostView
+
+class OverKeyboardViewManager(
+  mReactContext: ReactApplicationContext,
+) : ViewGroupManager<OverKeyboardHostView>() {
+  private val manager = OverKeyboardViewManagerImpl(mReactContext)
+
+  override fun getName(): String = OverKeyboardViewManagerImpl.NAME
+
+  override fun createViewInstance(reactContext: ThemedReactContext): OverKeyboardHostView =
+    manager.createViewInstance(reactContext)
+
+  override fun createShadowNodeInstance(): LayoutShadowNode = OverKeyboardHostShadowNode()
+
+  override fun getShadowNodeClass(): Class<out LayoutShadowNode> = OverKeyboardHostShadowNode::class.java
+
+  @ReactProp(name = "visible")
+  fun setVisible(
+    view: OverKeyboardHostView,
+    value: Boolean,
+  ) {
+    manager.setVisible(view, value)
+  }
+}

package/android/src/paper/java/com/reactnativekeyboardcontroller/StatusBarManagerCompatModule.kt

@@ -7,8 +7,9 @@ import com.facebook.react.bridge.ReactContextBaseJavaModule
 import com.facebook.react.bridge.ReactMethod
 import com.reactnativekeyboardcontroller.modules.StatusBarManagerCompatModuleImpl
 
-class StatusBarManagerCompatModule(mReactContext: ReactApplicationContext) :
-  ReactContextBaseJavaModule(mReactContext) {
+class StatusBarManagerCompatModule(
+  mReactContext: ReactApplicationContext,
+) : ReactContextBaseJavaModule(mReactContext) {
   private val module = StatusBarManagerCompatModuleImpl(mReactContext)
 
   override fun getName(): String = StatusBarManagerCompatModuleImpl.NAME
@@ -20,7 +21,10 @@ class StatusBarManagerCompatModule(mReactContext: ReactApplicationContext) :
 
   @ReactMethod
   @RequiresApi(Build.VERSION_CODES.LOLLIPOP)
-  private fun setColor(color: Int, animated: Boolean) {
+  private fun setColor(
+    color: Int,
+    animated: Boolean,
+  ) {
     module.setColor(color, animated)
   }
 

package/android/src/test/java/com/reactnativekeyboardcontroller/traversal/ViewHierarchyNavigatorTest.kt

@@ -36,8 +36,16 @@ class ViewHierarchyNavigatorTest {
 
     editText1 = EditText(context).apply { id = 1 }
     editText2 = EditText(context).apply { id = 2 }
-    editText3 = EditText(context).apply { id = 3; isEnabled = false }
-    editText4 = EditText(context).apply { id = 4; isEnabled = false }
+    editText3 =
+      EditText(context).apply {
+        id = 3
+        isEnabled = false
+      }
+    editText4 =
+      EditText(context).apply {
+        id = 4
+        isEnabled = false
+      }
     editText5 = EditText(context).apply { id = 5 }
     editText6 = EditText(context).apply { id = 6 }
     editText7 = EditText(context).apply { id = 7 }
@@ -48,25 +56,26 @@ class ViewHierarchyNavigatorTest {
     editText12 = EditText(context).apply { id = 12 }
     editText13 = EditText(context).apply { id = 13 }
 
-    layout = LinearLayout(context).apply {
-      addView(editText1)
-      addView(editText2)
-      addView(editText3)
-      addView(editText4)
-      addView(
-        LinearLayout(context).apply {
-          addView(editText5)
-          addView(editText6)
-          addView(editText7)
-        },
-      )
-      addView(editText8)
-      addView(editText9)
-      addView(editText10)
-      addView(editText11)
-      addView(editText12)
-      addView(editText13)
-    }
+    layout =
+      LinearLayout(context).apply {
+        addView(editText1)
+        addView(editText2)
+        addView(editText3)
+        addView(editText4)
+        addView(
+          LinearLayout(context).apply {
+            addView(editText5)
+            addView(editText6)
+            addView(editText7)
+          },
+        )
+        addView(editText8)
+        addView(editText9)
+        addView(editText10)
+        addView(editText11)
+        addView(editText12)
+        addView(editText13)
+      }
   }
 
   @Test

package/ios/KeyboardController-Bridging-Header.h

@@ -1,3 +1,4 @@
+#import <React/RCTTouchHandler.h>
 #import <React/RCTUIManager.h>
 #import <React/RCTUITextView.h>
 #import <React/RCTViewManager.h>

package/ios/extensions/UIResponder.swift

@@ -56,10 +56,7 @@ public extension Optional where Wrapped: UIResponder {
          !(currentView is UITextView),
          scrollView.frame.width >= scrollView.contentSize.width,
          scrollView.isScrollEnabled
-      // it was fixed in swiftlint https://github.com/realm/SwiftLint/issues/3756 but a new release is not available yet
-      // swiftlint:disable all
       {
-        // swiftlint:enable all
         return scrollView.reactViewTag
       }
 

package/ios/extensions/UIWindow.swift

@@ -0,0 +1,48 @@
+//
+//  UIWindow.swift
+//  react-native-keyboard-controller
+//
+//  Created by Kiryl Ziusko on 12/09/2024.
+//
+
+import Foundation
+import ObjectiveC
+import UIKit
+
+@objc
+public extension UIWindow {
+  static let sharedKeyboardWindowObserver = KeyboardWindowObserver()
+
+  class KeyboardWindowObserver: NSObject {
+    private weak var keyboardWindow: UIWindow?
+
+    override init() {
+      super.init()
+      NotificationCenter.default.addObserver(
+        self,
+        selector: #selector(windowDidBecomeVisible(_:)),
+        name: UIWindow.didBecomeVisibleNotification,
+        object: nil
+      )
+    }
+
+    @objc private func windowDidBecomeVisible(_ notification: Notification) {
+      guard let window = notification.object as? UIWindow else { return }
+
+      // Check if the window is of UIRemoteKeyboardWindow class
+      let type = String(describing: window)
+      if type.range(of: "UIRemoteKeyboardWindow") != nil {
+        keyboardWindow = window
+      }
+    }
+
+    func getTopWindow() -> UIWindow? {
+      // Return the keyboard window if it's available, otherwise return the last window
+      return keyboardWindow ?? UIApplication.shared.windows.last
+    }
+  }
+
+  static var topWindow: UIWindow? {
+    return sharedKeyboardWindowObserver.getTopWindow()
+  }
+}

package/ios/views/OverKeyboardViewManager.h

@@ -0,0 +1,29 @@
+//
+//  OverKeyboardViewManager.h
+//  KeyboardController
+//
+//  Created by Kiryl Ziusko on 17.09.24.
+//  Copyright © 2024 Facebook. All rights reserved.
+//
+#ifdef RCT_NEW_ARCH_ENABLED
+#import <React/RCTViewComponentView.h>
+#else
+#import <React/RCTBridge.h>
+#endif
+#import <React/RCTViewManager.h>
+#import <UIKit/UIKit.h>
+
+@interface OverKeyboardViewManager : RCTViewManager
+@end
+
+@interface OverKeyboardView :
+#ifdef RCT_NEW_ARCH_ENABLED
+    RCTViewComponentView
+#else
+    UIView
+
+- (instancetype)initWithBridge:(RCTBridge *)bridge;
+
+#endif
+@property (nonatomic, assign) BOOL visible;
+@end