react-native-keyboard-controller 1.9.3 → 1.9.5

package/README.md

@@ -22,10 +22,10 @@ Keyboard manager which works in identical way on both iOS and Android.
 
 Install `react-native-keyboard-controller` package from npm:
 
-```sh
+```shell
 yarn add react-native-keyboard-controller
 # or
-# npm install react-native-keyboard-controller --save
+npm install react-native-keyboard-controller --save
 ```
 
 ## Documentation

package/android/build.gradle

@@ -43,6 +43,9 @@ android {
   def agpVersion = com.android.Version.ANDROID_GRADLE_PLUGIN_VERSION
   if (agpVersion.tokenize('.')[0].toInteger() >= 7) {
     namespace "com.reactnativekeyboardcontroller"
+    buildFeatures {
+      buildConfig true
+    }
   }
 
   compileSdkVersion getExtOrIntegerDefault('compileSdkVersion')

package/android/src/main/java/com/reactnativekeyboardcontroller/listeners/{FocusedInputLayoutObserver.kt → FocusedInputObserver.kt}

@@ -22,7 +22,7 @@ val noFocusedInputEvent = FocusedInputLayoutChangedEventData(
   target = -1,
 )
 
-class FocusedInputLayoutObserver(val view: ReactViewGroup, private val context: ThemedReactContext?) {
+class FocusedInputObserver(val view: ReactViewGroup, private val context: ThemedReactContext?) {
   // constructor variables
   private val surfaceId = UIManagerHelper.getSurfaceId(view)
 

package/android/src/main/java/com/reactnativekeyboardcontroller/listeners/KeyboardAnimationCallback.kt

@@ -41,6 +41,7 @@ class KeyboardAnimationCallback(
   private var isTransitioning = false
   private var duration = 0
   private var viewTagFocused = -1
+  private var animation: ValueAnimator? = null
 
   // listeners
   private val focusListener = OnGlobalFocusChangeListener { oldFocus, newFocus ->
@@ -83,7 +84,7 @@ class KeyboardAnimationCallback(
       }
     }
   }
-  private var layoutObserver: FocusedInputLayoutObserver? = null
+  private var layoutObserver: FocusedInputObserver? = null
 
   init {
     require(persistentInsetTypes and deferredInsetTypes == 0) {
@@ -91,7 +92,7 @@ class KeyboardAnimationCallback(
         " same WindowInsetsCompat.Type values"
     }
 
-    layoutObserver = FocusedInputLayoutObserver(view = view, context = context)
+    layoutObserver = FocusedInputObserver(view = view, context = context)
     view.viewTreeObserver.addOnGlobalFocusChangeListener(focusListener)
   }
 
@@ -104,10 +105,6 @@ class KeyboardAnimationCallback(
    * behavior should be consistent across all versions of platform. To level the difference we
    * have to implement `onApplyWindowInsets` listener and simulate onStart/onProgress/onEnd
    * events when keyboard changes its size.
-   * In the method below we fully recreate the logic that is implemented on old android versions:
-   * - we dispatch `keyboardWillShow` (onStart);
-   * - we dispatch change height/progress as animated values (onProgress);
-   * - we dispatch `keyboardDidShow` (onEnd).
    */
   override fun onApplyWindowInsets(v: View, insets: WindowInsetsCompat): WindowInsetsCompat {
     val keyboardHeight = getCurrentKeyboardHeight()
@@ -133,57 +130,9 @@ class KeyboardAnimationCallback(
     val isKeyboardSizeEqual = this.persistentKeyboardHeight == keyboardHeight
 
     if (isKeyboardFullyVisible && !isKeyboardSizeEqual && Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
+      Log.i(TAG, "onApplyWindowInsets: ${this.persistentKeyboardHeight} -> $keyboardHeight")
       layoutObserver?.syncUpLayout()
-      this.emitEvent("KeyboardController::keyboardWillShow", getEventParams(keyboardHeight))
-      context.dispatchEvent(
-        view.id,
-        KeyboardTransitionEvent(
-          surfaceId,
-          view.id,
-          "topKeyboardMoveStart",
-          keyboardHeight,
-          1.0,
-          DEFAULT_ANIMATION_TIME,
-          viewTagFocused,
-        ),
-      )
-
-      val animation =
-        ValueAnimator.ofFloat(this.persistentKeyboardHeight.toFloat(), keyboardHeight.toFloat())
-      animation.addUpdateListener { animator ->
-        val toValue = animator.animatedValue as Float
-        context.dispatchEvent(
-          view.id,
-          KeyboardTransitionEvent(
-            surfaceId,
-            view.id,
-            "topKeyboardMove",
-            toValue.toDouble(),
-            toValue.toDouble() / keyboardHeight,
-            DEFAULT_ANIMATION_TIME,
-            viewTagFocused,
-          ),
-        )
-      }
-      animation.doOnEnd {
-        this.emitEvent("KeyboardController::keyboardDidShow", getEventParams(keyboardHeight))
-        context.dispatchEvent(
-          view.id,
-          KeyboardTransitionEvent(
-            surfaceId,
-            view.id,
-            "topKeyboardMoveEnd",
-            keyboardHeight,
-            1.0,
-            DEFAULT_ANIMATION_TIME,
-            viewTagFocused,
-          ),
-        )
-      }
-      animation.setDuration(DEFAULT_ANIMATION_TIME.toLong()).startDelay = 0
-      animation.start()
-
-      this.persistentKeyboardHeight = keyboardHeight
+      this.onKeyboardResized(keyboardHeight)
     }
 
     return insets
@@ -320,6 +269,78 @@ class KeyboardAnimationCallback(
     layoutObserver?.destroy()
   }
 
+  /*
+   * In the method below we recreate the logic that used when keyboard appear/disappear:
+   * - we dispatch `keyboardWillShow` (onStart);
+   * - we dispatch change height/progress as animated values (onProgress);
+   * - we dispatch `keyboardDidShow` (onEnd).
+   */
+  private fun onKeyboardResized(keyboardHeight: Double) {
+    if (this.animation?.isRunning == true) {
+      Log.i(TAG, "onKeyboardResized -> cancelling animation that is in progress")
+      // if animation is in progress, then we are:
+      // - removing listeners (update, onEnd)
+      // - updating `persistentKeyboardHeight` to latest animated value
+      // - cancelling animation to free up CPU resources
+      this.animation?.removeAllListeners()
+      this.persistentKeyboardHeight = (this.animation?.animatedValue as Float).toDouble()
+      this.animation?.cancel()
+    }
+
+    this.emitEvent("KeyboardController::keyboardWillShow", getEventParams(keyboardHeight))
+    context.dispatchEvent(
+      view.id,
+      KeyboardTransitionEvent(
+        surfaceId,
+        view.id,
+        "topKeyboardMoveStart",
+        keyboardHeight,
+        1.0,
+        DEFAULT_ANIMATION_TIME,
+        viewTagFocused,
+      ),
+    )
+
+    val animation =
+      ValueAnimator.ofFloat(this.persistentKeyboardHeight.toFloat(), keyboardHeight.toFloat())
+    animation.addUpdateListener { animator ->
+      val toValue = animator.animatedValue as Float
+      context.dispatchEvent(
+        view.id,
+        KeyboardTransitionEvent(
+          surfaceId,
+          view.id,
+          "topKeyboardMove",
+          toValue.toDouble(),
+          toValue.toDouble() / keyboardHeight,
+          DEFAULT_ANIMATION_TIME,
+          viewTagFocused,
+        ),
+      )
+    }
+    animation.doOnEnd {
+      this.emitEvent("KeyboardController::keyboardDidShow", getEventParams(keyboardHeight))
+      context.dispatchEvent(
+        view.id,
+        KeyboardTransitionEvent(
+          surfaceId,
+          view.id,
+          "topKeyboardMoveEnd",
+          keyboardHeight,
+          1.0,
+          DEFAULT_ANIMATION_TIME,
+          viewTagFocused,
+        ),
+      )
+      this.animation = null
+    }
+    animation.setDuration(DEFAULT_ANIMATION_TIME.toLong()).startDelay = 0
+    animation.start()
+
+    this.animation = animation
+    this.persistentKeyboardHeight = keyboardHeight
+  }
+
   private fun isKeyboardVisible(): Boolean {
     val insets = ViewCompat.getRootWindowInsets(view)
 

package/ios/KeyboardController.xcodeproj/project.pbxproj

@@ -9,7 +9,7 @@
 /* Begin PBXBuildFile section */
 		0807071E2A34807B00C05A19 /* Extensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0807071D2A34807B00C05A19 /* Extensions.swift */; };
 		084AEEC62ACF49A8001A3069 /* FocusedInputLayoutChangedEvent.m in Sources */ = {isa = PBXBuildFile; fileRef = 084AEEC52ACF49A8001A3069 /* FocusedInputLayoutChangedEvent.m */; };
-		084AEEC82ACF4AB2001A3069 /* FocusedInputLayoutObserver.swift in Sources */ = {isa = PBXBuildFile; fileRef = 084AEEC72ACF4AB2001A3069 /* FocusedInputLayoutObserver.swift */; };
+		084AEEC82ACF4AB2001A3069 /* FocusedInputObserver.swift in Sources */ = {isa = PBXBuildFile; fileRef = 084AEEC72ACF4AB2001A3069 /* FocusedInputObserver.swift */; };
 		F333F8D428996B8D0015B05F /* KeyboardControllerView.mm in Sources */ = {isa = PBXBuildFile; fileRef = F333F8D228996B8D0015B05F /* KeyboardControllerView.mm */; };
 		F359D34F28133C26000B6AFE /* KeyboardControllerModule.mm in Sources */ = {isa = PBXBuildFile; fileRef = F359D34E28133C26000B6AFE /* KeyboardControllerModule.mm */; };
 		F3626A0728B3FE760021B2D9 /* KeyboardMovementObserver.swift in Sources */ = {isa = PBXBuildFile; fileRef = F3626A0628B3FE760021B2D9 /* KeyboardMovementObserver.swift */; };
@@ -33,7 +33,7 @@
 		0807071D2A34807B00C05A19 /* Extensions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Extensions.swift; sourceTree = "<group>"; };
 		084AEEC22ACF479A001A3069 /* FocusedInputLayoutChangedEvent.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = FocusedInputLayoutChangedEvent.h; sourceTree = "<group>"; };
 		084AEEC52ACF49A8001A3069 /* FocusedInputLayoutChangedEvent.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = FocusedInputLayoutChangedEvent.m; sourceTree = "<group>"; };
-		084AEEC72ACF4AB2001A3069 /* FocusedInputLayoutObserver.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FocusedInputLayoutObserver.swift; sourceTree = "<group>"; };
+		084AEEC72ACF4AB2001A3069 /* FocusedInputObserver.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FocusedInputObserver.swift; sourceTree = "<group>"; };
 		134814201AA4EA6300B7C361 /* libKeyboardController.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = libKeyboardController.a; sourceTree = BUILT_PRODUCTS_DIR; };
 		B3E7B5891CC2AC0600A0062D /* KeyboardControllerViewManager.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = KeyboardControllerViewManager.mm; sourceTree = "<group>"; };
 		F333F8D128996B1C0015B05F /* KeyboardControllerView.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = KeyboardControllerView.h; sourceTree = "<group>"; };
@@ -73,7 +73,7 @@
 			isa = PBXGroup;
 			children = (
 				F3626A0628B3FE760021B2D9 /* KeyboardMovementObserver.swift */,
-				084AEEC72ACF4AB2001A3069 /* FocusedInputLayoutObserver.swift */,
+				084AEEC72ACF4AB2001A3069 /* FocusedInputObserver.swift */,
 			);
 			path = observers;
 			sourceTree = "<group>";
@@ -172,7 +172,7 @@
 				F3626A0728B3FE760021B2D9 /* KeyboardMovementObserver.swift in Sources */,
 				0807071E2A34807B00C05A19 /* Extensions.swift in Sources */,
 				F359D34F28133C26000B6AFE /* KeyboardControllerModule.mm in Sources */,
-				084AEEC82ACF4AB2001A3069 /* FocusedInputLayoutObserver.swift in Sources */,
+				084AEEC82ACF4AB2001A3069 /* FocusedInputObserver.swift in Sources */,
 				F4FF95D7245B92E800C19C63 /* KeyboardControllerViewManager.swift in Sources */,
 				F333F8D428996B8D0015B05F /* KeyboardControllerView.mm in Sources */,
 				F3F50669289E653B003091D6 /* KeyboardMoveEvent.m in Sources */,

package/ios/observers/{FocusedInputLayoutObserver.swift → FocusedInputObserver.swift}

@@ -1,5 +1,5 @@
 //
-//  FocusedInputLayoutObserver.swift
+//  FocusedInputObserver.swift
 //  KeyboardController
 //
 //  Created by Kiryl Ziusko on 05/10/2023.
@@ -21,8 +21,8 @@ let noFocusedInputEvent: [String: Any] = [
   ],
 ]
 
-@objc(FocusedInputLayoutObserver)
-public class FocusedInputLayoutObserver: NSObject {
+@objc(FocusedInputObserver)
+public class FocusedInputObserver: NSObject {
   // class members
   var onEvent: (NSDictionary) -> Void
   // state variables

package/ios/views/KeyboardControllerView.mm

@@ -31,7 +31,7 @@ using namespace facebook::react;
 
 @implementation KeyboardControllerView {
   KeyboardMovementObserver *keyboardObserver;
-  FocusedInputLayoutObserver *inputObserver;
+  FocusedInputObserver *inputObserver;
 }
 
 + (ComponentDescriptorProvider)componentDescriptorProvider
@@ -45,7 +45,7 @@ using namespace facebook::react;
     static const auto defaultProps = std::make_shared<const KeyboardControllerViewProps>();
     _props = defaultProps;
 
-    inputObserver = [[FocusedInputLayoutObserver alloc] initWithHandler:^(NSDictionary *event) {
+    inputObserver = [[FocusedInputObserver alloc] initWithHandler:^(NSDictionary *event) {
       if (self->_eventEmitter) {
         int target = [event[@"target"] integerValue];
         double absoluteY = [event[@"layout"][@"absoluteY"] doubleValue];

package/ios/views/KeyboardControllerViewManager.swift

@@ -12,7 +12,7 @@ class KeyboardControllerViewManager: RCTViewManager {
 class KeyboardControllerView: UIView {
   // internal variables
   private var keyboardObserver: KeyboardMovementObserver?
-  private var inputObserver: FocusedInputLayoutObserver?
+  private var inputObserver: FocusedInputObserver?
   private var eventDispatcher: RCTEventDispatcherProtocol
   private var bridge: RCTBridge
   // react callbacks
@@ -35,7 +35,7 @@ class KeyboardControllerView: UIView {
     self.bridge = bridge
     eventDispatcher = bridge.eventDispatcher()
     super.init(frame: frame)
-    inputObserver = FocusedInputLayoutObserver(handler: onInput)
+    inputObserver = FocusedInputObserver(handler: onInput)
     keyboardObserver = KeyboardMovementObserver(handler: onEvent, onNotify: onNotify)
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-keyboard-controller",
-  "version": "1.9.3",
+  "version": "1.9.5",
   "description": "Keyboard manager which works in identical way on both iOS and Android",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",