react-native-screens 4.7.0-beta.3 → 4.7.0

package/android/src/fabric/java/com/swmansion/rnscreens/FabricEnabledHeaderSubviewViewGroup.kt

@@ -7,12 +7,18 @@ import com.facebook.react.bridge.WritableMap
 import com.facebook.react.bridge.WritableNativeMap
 import com.facebook.react.uimanager.PixelUtil
 import com.facebook.react.uimanager.StateWrapper
+import kotlin.math.abs
 
 abstract class FabricEnabledHeaderSubviewViewGroup(
     context: Context?,
 ) : ViewGroup(context) {
     private var mStateWrapper: StateWrapper? = null
 
+    private var lastWidth = 0f
+    private var lastHeight = 0f
+    private var lastOffsetX = 0f
+    private var lastOffsetY = 0f
+
     fun setStateWrapper(wrapper: StateWrapper?) {
         mStateWrapper = wrapper
     }
@@ -38,6 +44,21 @@ abstract class FabricEnabledHeaderSubviewViewGroup(
         val offsetXDip: Float = PixelUtil.toDIPFromPixel(offsetX.toFloat())
         val offsetYDip: Float = PixelUtil.toDIPFromPixel(offsetY.toFloat())
 
+        // Check incoming state values. If they're already the correct value, return early to prevent
+        // infinite UpdateState/SetState loop.
+        if (abs(lastWidth - realWidth) < DELTA &&
+            abs(lastHeight - realHeight) < DELTA &&
+            abs(lastOffsetX - offsetXDip) < DELTA &&
+            abs(lastOffsetY - offsetYDip) < DELTA
+        ) {
+            return
+        }
+
+        lastWidth = realWidth
+        lastHeight = realHeight
+        lastOffsetX = offsetXDip
+        lastOffsetY = offsetYDip
+
         val map: WritableMap =
             WritableNativeMap().apply {
                 putDouble("frameWidth", realWidth.toDouble())
@@ -48,4 +69,8 @@ abstract class FabricEnabledHeaderSubviewViewGroup(
 
         mStateWrapper?.updateState(map)
     }
+
+    companion object {
+        private const val DELTA = 0.9f
+    }
 }

package/android/src/main/java/com/swmansion/rnscreens/ScreenStackFragment.kt

@@ -45,8 +45,9 @@ import com.swmansion.rnscreens.bottomsheet.useSingleDetent
 import com.swmansion.rnscreens.bottomsheet.useThreeDetents
 import com.swmansion.rnscreens.bottomsheet.useTwoDetents
 import com.swmansion.rnscreens.bottomsheet.usesFormSheetPresentation
+import com.swmansion.rnscreens.events.ScreenAnimationDelegate
 import com.swmansion.rnscreens.events.ScreenDismissedEvent
-import com.swmansion.rnscreens.events.ScreenEventDelegate
+import com.swmansion.rnscreens.events.ScreenEventEmitter
 import com.swmansion.rnscreens.ext.recycle
 import com.swmansion.rnscreens.transition.ExternalBoundaryValuesEvaluator
 import com.swmansion.rnscreens.utils.DeviceUtils
@@ -366,7 +367,14 @@ class ScreenStackFragment :
                 }
             animatorSet.play(alphaAnimator).with(slideAnimator)
         }
-        animatorSet.addListener(ScreenEventDelegate(this))
+        animatorSet.addListener(
+            ScreenAnimationDelegate(
+                this,
+                ScreenEventEmitter(this.screen),
+                if (enter) ScreenAnimationDelegate.AnimationType.ENTER
+                else ScreenAnimationDelegate.AnimationType.EXIT
+            )
+        )
         return animatorSet
     }
 

package/android/src/main/java/com/swmansion/rnscreens/events/ScreenAnimationDelegate.kt

@@ -0,0 +1,88 @@
+package com.swmansion.rnscreens.events
+
+import android.animation.Animator
+import android.util.Log
+import com.swmansion.rnscreens.ScreenStackFragmentWrapper
+
+// The goal is to make this universal delegate for handling animation progress related logic.
+// At this moment this class works only with form sheet presentation.
+class ScreenAnimationDelegate(
+    private val wrapper: ScreenStackFragmentWrapper,
+    private val eventEmitter: ScreenEventEmitter?,
+    private val animationType: AnimationType,
+) : Animator.AnimatorListener {
+    enum class AnimationType {
+        ENTER,
+        EXIT
+    }
+
+    private var currentState: LifecycleState = LifecycleState.INITIALIZED
+
+    private fun progressState() {
+        currentState =
+            when (currentState) {
+                LifecycleState.INITIALIZED -> LifecycleState.START_DISPATCHED
+                LifecycleState.START_DISPATCHED -> LifecycleState.END_DISPATCHED
+                LifecycleState.END_DISPATCHED -> LifecycleState.END_DISPATCHED
+            }
+    }
+
+    override fun onAnimationStart(animation: Animator) {
+        if (currentState === LifecycleState.INITIALIZED) {
+            progressState()
+
+            // These callbacks do not work as expected from this call site, TODO: investigate it.
+            // To fix it quickly we emit required events manually
+//            wrapper.onViewAnimationStart()
+
+            when (animationType) {
+                AnimationType.ENTER -> eventEmitter?.dispatchOnWillAppear()
+                AnimationType.EXIT -> eventEmitter?.dispatchOnWillDisappear()
+            }
+
+            val isExitAnimation = animationType === AnimationType.EXIT
+            eventEmitter?.dispatchTransitionProgress(
+                0.0f,
+                isExitAnimation,
+                isExitAnimation,
+            )
+        }
+    }
+
+    override fun onAnimationEnd(animation: Animator) {
+        if (currentState === LifecycleState.START_DISPATCHED) {
+            progressState()
+            animation.removeListener(this)
+
+//            wrapper.onViewAnimationEnd()
+
+            when (animationType) {
+                AnimationType.ENTER -> eventEmitter?.dispatchOnAppear()
+                AnimationType.EXIT -> eventEmitter?.dispatchOnDisappear()
+            }
+
+            val isExitAnimation = animationType === AnimationType.EXIT
+            eventEmitter?.dispatchTransitionProgress(
+                1.0f,
+                isExitAnimation,
+                isExitAnimation,
+            )
+
+            wrapper.screen.endRemovalTransition()
+        }
+    }
+
+    override fun onAnimationCancel(animation: Animator) = Unit
+
+    override fun onAnimationRepeat(animation: Animator) = Unit
+
+    private enum class LifecycleState {
+        INITIALIZED,
+        START_DISPATCHED,
+        END_DISPATCHED,
+    }
+
+    companion object {
+        const val TAG = "ScreenEventDelegate"
+    }
+}

package/android/src/main/java/com/swmansion/rnscreens/events/ScreenEventEmitter.kt

@@ -0,0 +1,36 @@
+package com.swmansion.rnscreens.events
+
+import com.facebook.react.uimanager.UIManagerHelper
+import com.swmansion.rnscreens.Screen
+import com.swmansion.rnscreens.ScreenFragment
+
+// TODO: Consider taking weak ref here or accepting screen as argument in every method
+// to avoid reference cycle.
+class ScreenEventEmitter(val screen: Screen) {
+    val reactEventDispatcher
+        get() = screen.reactEventDispatcher
+
+    val reactSurfaceId
+        get() = UIManagerHelper.getSurfaceId(screen)
+
+    fun dispatchOnWillAppear() =
+        reactEventDispatcher?.dispatchEvent(ScreenWillAppearEvent(reactSurfaceId, screen.id))
+
+    fun dispatchOnAppear() =
+        reactEventDispatcher?.dispatchEvent(ScreenAppearEvent(reactSurfaceId, screen.id))
+
+    fun dispatchOnWillDisappear() =
+        reactEventDispatcher?.dispatchEvent(ScreenWillDisappearEvent(reactSurfaceId, screen.id))
+
+    fun dispatchOnDisappear() =
+        reactEventDispatcher?.dispatchEvent(ScreenDisappearEvent(reactSurfaceId, screen.id))
+
+    fun dispatchOnDismissed() =
+        reactEventDispatcher?.dispatchEvent(ScreenDismissedEvent(reactSurfaceId, screen.id))
+
+    fun dispatchTransitionProgress(progress: Float, isExitAnimation: Boolean, isGoingForward: Boolean) {
+        val sanitizedProgress = progress.coerceIn(0.0f, 1.0f)
+        val coalescingKey = ScreenFragment.getCoalescingKey(sanitizedProgress)
+        reactEventDispatcher?.dispatchEvent(ScreenTransitionProgressEvent(reactSurfaceId, screen.id, sanitizedProgress, isExitAnimation, isGoingForward, coalescingKey))
+    }
+}

package/common/cpp/react/renderer/components/rnscreens/RNSScreenStackHeaderConfigComponentDescriptor.h

@@ -35,8 +35,7 @@ class RNSScreenStackHeaderConfigComponentDescriptor final
     auto stateData = state->getData();
 
     if (stateData.frameSize.width != 0 && stateData.frameSize.height != 0) {
-      layoutableShadowNode.setSize(
-          {stateData.frameSize.width, stateData.frameSize.height});
+      layoutableShadowNode.setSize(stateData.frameSize);
 #ifdef ANDROID
       layoutableShadowNode.setPadding({
           stateData.paddingStart,

package/common/cpp/react/renderer/components/rnscreens/RNSScreenStackHeaderSubviewComponentDescriptor.h

@@ -8,6 +8,7 @@
 #include <react/renderer/components/rnscreens/utils/RectUtil.h>
 #include <react/renderer/core/ConcreteComponentDescriptor.h>
 #include "RNSScreenStackHeaderSubviewShadowNode.h"
+#include "utils/RectUtil.h"
 
 namespace facebook::react {
 
@@ -32,12 +33,11 @@ class RNSScreenStackHeaderSubviewComponentDescriptor final
 
     auto state = std::static_pointer_cast<
         const RNSScreenStackHeaderSubviewShadowNode::ConcreteState>(
-        shadowNode.getState());
+        shadowNode.getMostRecentState());
     auto stateData = state->getData();
 
-    if (stateData.frameSize.width != 0 && stateData.frameSize.height != 0) {
-      layoutableShadowNode.setSize(
-          Size{stateData.frameSize.width, stateData.frameSize.height});
+    if (!isSizeEmpty(stateData.frameSize)) {
+      layoutableShadowNode.setSize(stateData.frameSize);
     }
 
     ConcreteComponentDescriptor::adopt(shadowNode);

package/common/cpp/react/renderer/components/rnscreens/RNSScreenStackHeaderSubviewState.h

@@ -44,7 +44,7 @@ class JSI_EXPORT RNSScreenStackHeaderSubviewState final {
 
 #endif // ANDROID
 
-  const Size frameSize{};
+  const Size frameSize{-1.f, -1.f};
   Point contentOffset{};
 
 #pragma mark - Getters

package/common/cpp/react/renderer/components/rnscreens/utils/RectUtil.h

@@ -33,4 +33,11 @@ inline constexpr bool checkFrameSizesEqualWithEps(
       equalWithRespectToEps(first.height, second.height, eps);
 }
 
+/**
+ * @return false if any component value is less than 0
+ */
+inline constexpr bool isSizeEmpty(const react::Size &size) {
+  return size.width < 0 || size.height < 0;
+}
+
 } // namespace rnscreens

package/ios/RNSScreenContentWrapper.mm

@@ -73,15 +73,30 @@ namespace react = facebook::react;
 
 - (void)attachToAncestorScreenView
 {
-  if (![self.reactSuperview isKindOfClass:RNSScreenView.class]) {
-    RCTLogError(@"Expected reactSuperview to be a RNSScreenView. Found %@", self.reactSuperview);
+  RNSScreen *_Nullable screen =
+      static_cast<RNSScreen *_Nullable>([[self findFirstScreenViewAncestor] reactViewController]);
+  if (screen == nil) {
+    RCTLogError(@"Failed to find parent screen controller from %@.", self);
     return;
   }
-
-  RNSScreen *screen = (RNSScreen *)[self.reactSuperview reactViewController];
   [self attachToAncestorScreenViewStartingFrom:screen];
 }
 
+- (nullable RNSScreenView *)findFirstScreenViewAncestor
+{
+  UIView *currentView = self;
+
+  // In standard scenario this should do only a single iteration.
+  // Haven't got repro, but we got reports that there are scenarios
+  // when there are intermediate views between screen view & the content wrapper.
+  // https://github.com/software-mansion/react-native-screens/pull/2683
+  do {
+    currentView = currentView.reactSuperview;
+  } while (currentView != nil && ![currentView isKindOfClass:RNSScreenView.class]);
+
+  return static_cast<RNSScreenView *_Nullable>(currentView);
+}
+
 #ifdef RCT_NEW_ARCH_ENABLED
 
 #pragma mark - RCTComponentViewProtocol

package/lib/typescript/types.d.ts

@@ -235,7 +235,7 @@ export interface ScreenProps extends ViewProps {
      * while **Android is limited to three**.
      *
      * There is also possibility to specify `fitToContents` literal, which intents to set the sheet height
-     * to the height of its contents.
+     * to the height of its contents. On iOS `fitToContents` currently also includes small padding accounting for bottom inset.
      *
      * Please note that the array **must** be sorted in ascending order. This invariant is verified only in developement mode,
      * where violation results in error.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-screens",
-  "version": "4.7.0-beta.3",
+  "version": "4.7.0",
   "description": "Native navigation primitives for your React Native app.",
   "scripts": {
     "submodules": "git submodule update --init --recursive && (cd react-navigation && yarn && yarn build && cd ../)",

package/src/types.tsx

@@ -303,7 +303,7 @@ export interface ScreenProps extends ViewProps {
    * while **Android is limited to three**.
    *
    * There is also possibility to specify `fitToContents` literal, which intents to set the sheet height
-   * to the height of its contents.
+   * to the height of its contents. On iOS `fitToContents` currently also includes small padding accounting for bottom inset.
    *
    * Please note that the array **must** be sorted in ascending order. This invariant is verified only in developement mode,
    * where violation results in error.

package/android/src/main/java/com/swmansion/rnscreens/events/ScreenEventDelegate.kt

@@ -1,48 +0,0 @@
-package com.swmansion.rnscreens.events
-
-import android.animation.Animator
-import com.swmansion.rnscreens.ScreenFragmentWrapper
-
-class ScreenEventDelegate(
-    private val wrapper: ScreenFragmentWrapper,
-) : Animator.AnimatorListener {
-    private var currentState: LifecycleState = LifecycleState.INITIALIZED
-
-    private fun progressState() {
-        currentState =
-            when (currentState) {
-                LifecycleState.INITIALIZED -> LifecycleState.START_DISPATCHED
-                LifecycleState.START_DISPATCHED -> LifecycleState.END_DISPATCHED
-                LifecycleState.END_DISPATCHED -> LifecycleState.END_DISPATCHED
-            }
-    }
-
-    override fun onAnimationStart(animation: Animator) {
-        if (currentState === LifecycleState.INITIALIZED) {
-            progressState()
-            wrapper.onViewAnimationStart()
-        }
-    }
-
-    override fun onAnimationEnd(animation: Animator) {
-        if (currentState === LifecycleState.START_DISPATCHED) {
-            progressState()
-            animation.removeListener(this)
-            wrapper.onViewAnimationEnd()
-        }
-    }
-
-    override fun onAnimationCancel(animation: Animator) = Unit
-
-    override fun onAnimationRepeat(animation: Animator) = Unit
-
-    private enum class LifecycleState {
-        INITIALIZED,
-        START_DISPATCHED,
-        END_DISPATCHED,
-    }
-
-    companion object {
-        const val TAG = "ScreenEventDelegate"
-    }
-}