react-native-screens 5.0.0-alpha.2 → 5.0.0-alpha.3

package/android/src/main/java/com/swmansion/rnscreens/modals/formsheet/native/presentation/FormSheetPresentationManager.kt

@@ -2,39 +2,76 @@ package com.swmansion.rnscreens.modals.formsheet.native.presentation
 
 import android.animation.Animator
 import android.animation.AnimatorListenerAdapter
+import android.util.Log
 import android.view.View
+import androidx.core.view.doOnPreDraw
 import com.google.android.material.bottomsheet.BottomSheetBehavior
 import com.swmansion.rnscreens.common.event.ViewAppearanceEventEmitter
-import com.swmansion.rnscreens.modals.dimmingview.DimmingViewManager
-import com.swmansion.rnscreens.modals.formsheet.native.core.FormSheetDialog
 
 internal class FormSheetPresentationManager(
-    private val dialog: FormSheetDialog,
-    private val bottomSheetView: View?,
-    private val dimmingManager: DimmingViewManager,
+    private val presentationFactory: () -> FormSheetPresentation,
+    private val dimmingManager: FormSheetDimmingManager,
     private val onNativeDismiss: () -> Unit,
+    private val onDismiss: () -> Unit,
 ) {
     internal var appearanceEventEmitter: ViewAppearanceEventEmitter? = null
 
+    internal var currentPresentation: FormSheetPresentation? = null
+        private set
+
+    private val bottomSheetView: View?
+        get() = currentPresentation?.bottomSheetView
+
     private var state = FormSheetPresentationState.DISMISSED
-    private var targetIsOpen = false
+    private var shouldBeOpen = false
+    private var shouldSkipExitAnimation = false
+
+    private var dismissalOrigin = FormSheetDismissalOrigin.UNSPECIFIED
 
     private val animatorFactory = FormSheetAnimatorFactory(dimmingManager)
     private var currentSheetAnimator: Animator? = null
 
-    internal fun setup() {
-        bottomSheetView?.let { view ->
-            dimmingManager.attachToBehavior(BottomSheetBehavior.from(view))
+    internal fun requestProgrammaticStateUpdate(shouldBeOpen: Boolean) {
+        if (shouldBeOpen) {
+            handlePresent()
+        } else {
+            handleProgrammaticDismiss()
+        }
+    }
+
+    private fun handlePresent() {
+        updatePresentationState(shouldBeOpen = true, origin = FormSheetDismissalOrigin.UNSPECIFIED)
+    }
+
+    private fun handleProgrammaticDismiss() {
+        updatePresentationState(shouldBeOpen = false, origin = FormSheetDismissalOrigin.PROGRAMMATIC_JS)
+    }
+
+    internal fun handleNativeDismiss() {
+        if (state == FormSheetPresentationState.DISMISSING || state == FormSheetPresentationState.DISMISSED) {
+            return
         }
+
+        updatePresentationState(shouldBeOpen = false, origin = FormSheetDismissalOrigin.USER)
     }
 
-    internal fun updatePresentationState(isOpen: Boolean) {
-        targetIsOpen = isOpen
+    private fun updatePresentationState(
+        shouldBeOpen: Boolean,
+        origin: FormSheetDismissalOrigin,
+    ) {
+        // The origin belongs to the request that transitioned the target to closed -
+        // a repeated close request must not override it. Once a dismissal is in flight,
+        // it keeps the origin that started it until the completion events are emitted.
+        val isRepeatCloseRequest = !shouldBeOpen && !this.shouldBeOpen
+        if (state != FormSheetPresentationState.DISMISSING && !isRepeatCloseRequest) {
+            dismissalOrigin = origin
+        }
+        this.shouldBeOpen = shouldBeOpen
         resolvePresentationState()
     }
 
     private fun resolvePresentationState() {
-        if (targetIsOpen) {
+        if (shouldBeOpen) {
             presentIfNeeded()
         } else {
             dismissIfNeeded()
@@ -47,13 +84,23 @@ internal class FormSheetPresentationManager(
         }
 
         state = FormSheetPresentationState.PRESENTING
+        val presentation = presentationFactory().also { currentPresentation = it }
+        presentation.sheetBehavior?.let(dimmingManager::attachToBehavior)
+
+        FormSheetStackRegistry.register(this)
         appearanceEventEmitter?.emitOnWillAppear()
-        dialog.setOnShowListener {
-            dialog.setOnShowListener(null)
-            dimmingManager.onDialogShow()
+        presentation.bottomSheetView?.let(::keepOffscreenUntilEnterAnimation)
+        presentation.dialog.setOnShowListener {
+            presentation.dialog.setOnShowListener(null)
+
+            // Every sheet dims the surface inside the window below, attaching an overlay to the sheet
+            // directly below in the stack, or to the DecorView when this sheet is the
+            // bottom-most one.
+            dimmingManager.attachDimming(FormSheetStackRegistry.sheetBelow(this)?.bottomSheetView)
+
             startEnterAnimation()
         }
-        dialog.show()
+        presentation.dialog.show()
     }
 
     private fun dismissIfNeeded() {
@@ -62,6 +109,12 @@ internal class FormSheetPresentationManager(
         }
 
         state = FormSheetPresentationState.DISMISSING
+        currentPresentation?.setKeyboardTrackingEnabled(false)
+        dismissSheetsAbove()
+        // Leaving the stack immediately is deliberate, if another sheet is presented during this exit animation,
+        // it must stack on a "stable" sheet - the one we don't intend to dismiss. This window is about to be
+        // torn down.
+        FormSheetStackRegistry.unregister(this)
         appearanceEventEmitter?.emitOnWillDisappear()
 
         val isSheetHidden =
@@ -74,10 +127,59 @@ internal class FormSheetPresentationManager(
             return
         }
 
+        if (shouldSkipExitAnimation) {
+            performInstantDismiss()
+            return
+        }
+
         startExitAnimation()
     }
 
+    // Dismissing a sheet from the middle of the stack should dismiss all sheets above it,
+    // mirroring the iOS presentation chain teardown. Sheets are dismissed top-down.
+    private fun dismissSheetsAbove() {
+        FormSheetStackRegistry.sheetsAbove(this).asReversed().forEach {
+            it.handleDismissFromCascade()
+        }
+    }
+
+    private fun handleDismissFromCascade() {
+        if (state == FormSheetPresentationState.DISMISSING || state == FormSheetPresentationState.DISMISSED) {
+            return
+        }
+
+        shouldSkipExitAnimation = true
+        updatePresentationState(false, FormSheetDismissalOrigin.USER)
+    }
+
+    private fun performInstantDismiss() {
+        currentSheetAnimator?.removeAllListeners()
+        currentSheetAnimator?.cancel()
+        currentSheetAnimator = null
+
+        performDismiss()
+    }
+
+    /**
+     * `Dialog.show()` **posts** the show message behind the sync barrier of the traversal scheduled while
+     * adding the decor to the window, so the Dialog always draws its first frame before `OnShowListener`
+     * (with our custom enter animation) runs. A freshly created sheet rests at `translationY = 0`, so that
+     * frame would show it at its final position and the enter animator would then snap it back
+     * off-screen.
+     *
+     * Applying the translation on the first pre-draw - after the layout, when the sheet height is
+     * already known, but before anything is drawn - keeps the sheet off-screen from the very first frame.
+     */
+    private fun keepOffscreenUntilEnterAnimation(view: View) {
+        view.doOnPreDraw {
+            if (currentSheetAnimator == null) {
+                view.translationY = view.height.toFloat()
+            }
+        }
+    }
+
     private fun startEnterAnimation() {
+        val bottomSheetView = bottomSheetView
         if (bottomSheetView == null) {
             onPresentationComplete()
             return
@@ -106,6 +208,7 @@ internal class FormSheetPresentationManager(
     }
 
     private fun startExitAnimation() {
+        val bottomSheetView = bottomSheetView
         if (bottomSheetView == null) {
             performDismiss()
             return
@@ -125,7 +228,6 @@ internal class FormSheetPresentationManager(
                             dimmingManager.isTransitionAnimationRunning = false
 
                             if (currentSheetAnimator == this@apply) currentSheetAnimator = null
-                            syncBehaviorStateAfterExitAnimationComplete(bottomSheetView)
                             performDismiss()
                         }
                     },
@@ -135,13 +237,17 @@ internal class FormSheetPresentationManager(
     }
 
     private fun performDismiss() {
-        dialog.dismiss()
+        shouldSkipExitAnimation = false
+        dimmingManager.detachDimming()
+        currentPresentation?.destroy()
+        currentPresentation = null
         onDismissComplete()
     }
 
     private fun onPresentationComplete() {
         if (state == FormSheetPresentationState.PRESENTING) {
             state = FormSheetPresentationState.PRESENTED
+            currentPresentation?.setKeyboardTrackingEnabled(true)
             appearanceEventEmitter?.emitOnDidAppear()
             // ensure state hasn't updated during presentation
             resolvePresentationState()
@@ -152,46 +258,32 @@ internal class FormSheetPresentationManager(
         if (state == FormSheetPresentationState.DISMISSING) {
             state = FormSheetPresentationState.DISMISSED
             appearanceEventEmitter?.emitOnDidDisappear()
+
+            when (dismissalOrigin) {
+                FormSheetDismissalOrigin.USER -> onNativeDismiss()
+                FormSheetDismissalOrigin.PROGRAMMATIC_JS -> onDismiss()
+                FormSheetDismissalOrigin.UNSPECIFIED ->
+                    Log.e(
+                        "[RNScreens]",
+                        "FormSheet dismissal completed without a recorded origin; no dismissal event emitted",
+                    )
+            }
+            dismissalOrigin = FormSheetDismissalOrigin.UNSPECIFIED
+
             // ensure state hasn't updated during dismissal
             resolvePresentationState()
         }
     }
 
-    internal fun handleNativeDismiss() {
-        if (state == FormSheetPresentationState.DISMISSING || state == FormSheetPresentationState.DISMISSED) {
-            return
-        }
-
-        onNativeDismiss()
-        updatePresentationState(isOpen = false)
-    }
-
-    /**
-     * Synchronizes the BottomSheetBehavior state with our custom exit animation.
-     *
-     * Since our custom ExitAnimator uses `translationY` for visual movement, the physical
-     * `top` of the view remains at the top of the screen. If we just call `state = STATE_HIDDEN`,
-     * Material will attempt to align the layout and enter `STATE_SETTLING`, leaving the state
-     * machine corrupted for the next open.
-     *
-     * To fix this, we manually push the physical `top` to the bottom of the screen.
-     * This makes the behavior skip the animation and synchronously switch to `STATE_HIDDEN`,
-     * properly cleaning up its internal state on dismissal.
-     */
-    private fun syncBehaviorStateAfterExitAnimationComplete(view: View) {
-        val behavior = BottomSheetBehavior.from(view)
-        val parent = view.parent as? View
-        val targetTop = parent?.height ?: view.height
-
-        view.offsetTopAndBottom(targetTop - view.top)
-        behavior.state = BottomSheetBehavior.STATE_HIDDEN
-    }
-
     internal fun destroy() {
+        FormSheetStackRegistry.unregister(this)
+        dimmingManager.detachDimming()
+
         currentSheetAnimator?.cancel()
         currentSheetAnimator = null
 
-        dialog.setOnShowListener(null)
+        currentPresentation?.destroy()
+        currentPresentation = null
 
         state = FormSheetPresentationState.DISMISSED
     }

package/android/src/main/java/com/swmansion/rnscreens/modals/formsheet/native/presentation/FormSheetPresentationState.kt

@@ -27,7 +27,7 @@ internal enum class FormSheetPresentationState {
     /**
      * The manager is actively preparing to show the sheet. `presentIfNeeded()` has been called.
      * During this state, `dialog.show()` is executed. The manager waits for the `onShowListener`
-     * to fire, requests DimmingView attachment from `dimmingManager` and runs starts entrance animation.
+     * to fire, attaches the dimming through `dimmingManager` and starts the entrance animation.
      * Once the enter animator finishes, the state moves to [PRESENTED].
      * **Transitional state** from [DISMISSED] to [PRESENTED].
      */

package/android/src/main/java/com/swmansion/rnscreens/modals/formsheet/native/presentation/FormSheetStackRegistry.kt

@@ -0,0 +1,28 @@
+package com.swmansion.rnscreens.modals.formsheet.native.presentation
+
+internal object FormSheetStackRegistry {
+    private val stack = mutableListOf<FormSheetPresentationManager>()
+
+    internal fun register(sheet: FormSheetPresentationManager) {
+        if (!stack.contains(sheet)) {
+            stack.add(sheet)
+        }
+    }
+
+    internal fun unregister(sheet: FormSheetPresentationManager) {
+        stack.remove(sheet)
+    }
+
+    internal fun sheetsAbove(sheet: FormSheetPresentationManager): List<FormSheetPresentationManager> {
+        val index = stack.indexOf(sheet)
+        if (index < 0) {
+            return emptyList()
+        }
+        return stack.drop(index + 1)
+    }
+
+    internal fun sheetBelow(sheet: FormSheetPresentationManager): FormSheetPresentationManager? {
+        val index = stack.indexOf(sheet)
+        return if (index > 0) stack[index - 1] else null
+    }
+}

package/android/src/main/java/com/swmansion/rnscreens/modals/formsheet/react/event/FormSheetDismissEvent.kt

@@ -0,0 +1,29 @@
+package com.swmansion.rnscreens.modals.formsheet.react.event
+
+import com.facebook.react.bridge.Arguments
+import com.facebook.react.bridge.WritableMap
+import com.facebook.react.uimanager.events.Event
+import com.swmansion.rnscreens.common.event.NamingAwareEventType
+
+class FormSheetDismissEvent(
+    surfaceId: Int,
+    viewId: Int,
+) : Event<FormSheetDismissEvent>(surfaceId, viewId),
+    NamingAwareEventType {
+    override fun getEventName(): String = EVENT_NAME
+
+    override fun getEventRegistrationName() = EVENT_REGISTRATION_NAME
+
+    override fun getEventData(): WritableMap? = Arguments.createMap()
+
+    override fun canCoalesce(): Boolean = false
+
+    companion object : NamingAwareEventType {
+        const val EVENT_NAME = "topDismiss"
+        const val EVENT_REGISTRATION_NAME = "onDismiss"
+
+        override fun getEventName() = EVENT_NAME
+
+        override fun getEventRegistrationName() = EVENT_REGISTRATION_NAME
+    }
+}

package/android/src/main/java/com/swmansion/rnscreens/modals/formsheet/react/host/FormSheetHostEventEmitter.kt

@@ -6,6 +6,7 @@ import com.swmansion.rnscreens.modals.formsheet.native.interfaces.FormSheetDialo
 import com.swmansion.rnscreens.modals.formsheet.react.event.FormSheetDetentChangedEvent
 import com.swmansion.rnscreens.modals.formsheet.react.event.FormSheetDidAppearEvent
 import com.swmansion.rnscreens.modals.formsheet.react.event.FormSheetDidDisappearEvent
+import com.swmansion.rnscreens.modals.formsheet.react.event.FormSheetDismissEvent
 import com.swmansion.rnscreens.modals.formsheet.react.event.FormSheetNativeDismissEvent
 import com.swmansion.rnscreens.modals.formsheet.react.event.FormSheetNativeDismissPreventedEvent
 import com.swmansion.rnscreens.modals.formsheet.react.event.FormSheetSyncFlushEvent
@@ -17,6 +18,12 @@ internal class FormSheetHostEventEmitter(
     viewTag: Int,
 ) : BaseEventEmitter(reactContext, viewTag),
     FormSheetDialogEventEmitter {
+    override fun emitOnDismissEvent() {
+        reactEventDispatcher.dispatchEvent(
+            FormSheetDismissEvent(surfaceId, viewTag),
+        )
+    }
+
     override fun emitOnNativeDismissEvent() {
         reactEventDispatcher.dispatchEvent(
             FormSheetNativeDismissEvent(surfaceId, viewTag),

package/android/src/main/java/com/swmansion/rnscreens/modals/formsheet/react/host/FormSheetHostViewManager.kt

@@ -14,6 +14,7 @@ import com.swmansion.rnscreens.helpers.makeEventRegistrationInfo
 import com.swmansion.rnscreens.modals.formsheet.react.event.FormSheetDetentChangedEvent
 import com.swmansion.rnscreens.modals.formsheet.react.event.FormSheetDidAppearEvent
 import com.swmansion.rnscreens.modals.formsheet.react.event.FormSheetDidDisappearEvent
+import com.swmansion.rnscreens.modals.formsheet.react.event.FormSheetDismissEvent
 import com.swmansion.rnscreens.modals.formsheet.react.event.FormSheetNativeDismissEvent
 import com.swmansion.rnscreens.modals.formsheet.react.event.FormSheetNativeDismissPreventedEvent
 import com.swmansion.rnscreens.modals.formsheet.react.event.FormSheetSyncFlushEvent
@@ -134,6 +135,7 @@ class FormSheetHostViewManager :
 
     override fun getExportedCustomDirectEventTypeConstants(): MutableMap<String, Any> =
         mutableMapOf(
+            makeEventRegistrationInfo(FormSheetDismissEvent),
             makeEventRegistrationInfo(FormSheetNativeDismissEvent),
             makeEventRegistrationInfo(FormSheetSyncFlushEvent),
             makeEventRegistrationInfo(FormSheetWillAppearEvent),