fix(Android, Stack): Constraint FormSheet height by top inset

android/src/main/java/com/swmansion/rnscreens/Screen.kt

@@ -87,11 +87,16 @@ class Screen(
     var sheetInitialDetentIndex: Int = 0
     var sheetClosesOnTouchOutside = true
     var sheetElevation: Float = 24F
+    var sheetShouldOverflowTopInset = false
 
     /**
-     * When using form sheet presentation we want to delay enter transition **on Paper** in order
+     * On Paper, when using form sheet presentation we want to delay enter transition in order
      * to wait for initial layout from React, otherwise the animator-based animation will look
-     * glitchy. *This is not needed on Fabric*.
+     * glitchy.
+     *
+     * On Fabric, the view layout is completed before window insets are applied.
+     * To ensure the BottomSheet correctly respects insets during its enter transition,
+     * we delay the transition until both layout and insets have been applied.
      */
     var shouldTriggerPostponedTransitionAfterLayout = false
 
@@ -212,7 +217,16 @@ class Screen(
         }
     }
 
-    private fun triggerPostponedEnterTransitionIfNeeded() {
+    // On Fabric, the view layout is completed before window insets are applied.
+    // To ensure the BottomSheet correctly respects insets during its enter transition,
+    // we delay the transition until both layout and insets have been applied.
+    internal fun requestTriggeringPostponedEnterTransition() {
+        if (BuildConfig.IS_NEW_ARCHITECTURE_ENABLED && !sheetShouldOverflowTopInset) {
+            shouldTriggerPostponedTransitionAfterLayout = true
+        }
+    }
+
+    internal fun triggerPostponedEnterTransitionIfNeeded() {
         if (shouldTriggerPostponedTransitionAfterLayout) {
             shouldTriggerPostponedTransitionAfterLayout = false
             // This will trigger enter transition only if one was requested by ScreenStack

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

@@ -27,6 +27,8 @@ import com.google.android.material.bottomsheet.BottomSheetBehavior
 import com.google.android.material.shape.CornerFamily
 import com.google.android.material.shape.MaterialShapeDrawable
 import com.google.android.material.shape.ShapeAppearanceModel
+import com.swmansion.rnscreens.bottomsheet.BottomSheetTransitionCoordinator
+import com.swmansion.rnscreens.bottomsheet.BottomSheetWindowInsetListenerChain
 import com.swmansion.rnscreens.bottomsheet.DimmingViewManager
 import com.swmansion.rnscreens.bottomsheet.SheetDelegate
 import com.swmansion.rnscreens.bottomsheet.usesFormSheetPresentation
@@ -55,6 +57,8 @@ class ScreenStackFragment :
     private var isToolbarShadowHidden = false
     private var isToolbarTranslucent = false
 
+    private lateinit var sheetTransitionCoordinator: BottomSheetTransitionCoordinator
+
     private var lastFocusedChild: View? = null
 
     var searchView: CustomSearchView? = null
@@ -73,6 +77,10 @@ class ScreenStackFragment :
 
     internal var sheetDelegate: SheetDelegate? = null
 
+    internal var bottomSheetWindowInsetListenerChain: BottomSheetWindowInsetListenerChain? = null
+
+    private var lastInsetsCompat: WindowInsetsCompat? = null
+
     @SuppressLint("ValidFragment")
     constructor(screenView: Screen) : super(screenView)
 
@@ -229,6 +237,13 @@ class ScreenStackFragment :
             dimmingDelegate.onViewHierarchyCreated(screen, coordinatorLayout)
             dimmingDelegate.onBehaviourAttached(screen, screen.sheetBehavior!!)
 
+            if (!screen.sheetShouldOverflowTopInset) {
+                sheetTransitionCoordinator = BottomSheetTransitionCoordinator()
+                attachInsetsAndLayoutListenersToBottomSheet(
+                    sheetTransitionCoordinator,
+                )
+            }
+
             // Pre-layout the content for the sake of enter transition.
 
             val container = screen.container!!
@@ -239,10 +254,12 @@ class ScreenStackFragment :
             coordinatorLayout.layout(0, 0, container.width, container.height)
 
             if (Build.VERSION.SDK_INT < Build.VERSION_CODES.R) {
-                ViewCompat.setOnApplyWindowInsetsListener(screen) { _, windowInsets ->
+                val bottomSheetWindowInsetListenerChain = requireBottomSheetWindowInsetsListenerChain()
+                bottomSheetWindowInsetListenerChain.addListener { _, windowInsets ->
                     sheetDelegate.handleKeyboardInsetsProgress(windowInsets)
                     windowInsets
                 }
+                ViewCompat.setOnApplyWindowInsetsListener(screen, bottomSheetWindowInsetListenerChain)
             }
 
             val insetsAnimationCallback =
@@ -457,6 +474,65 @@ class ScreenStackFragment :
         screenStack.dismiss(this)
     }
 
+    // Mark: Avoiding top inset by BottomSheet
+
+    private fun attachInsetsAndLayoutListenersToBottomSheet(sheetTransitionCoordinator: BottomSheetTransitionCoordinator) {
+        screen.container?.apply {
+            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
+                setOnApplyWindowInsetsListener { _, insets ->
+                    val insetsCompat = WindowInsetsCompat.toWindowInsetsCompat(insets, this)
+                    handleInsetsUpdateAndNotifyTransition(
+                        insetsCompat,
+                    )
+                    insets
+                }
+            } else {
+                val bottomSheetWindowInsetListenerChain = requireBottomSheetWindowInsetsListenerChain()
+                bottomSheetWindowInsetListenerChain.addListener { _, windowInsets ->
+                    handleInsetsUpdateAndNotifyTransition(
+                        windowInsets,
+                    )
+                    windowInsets
+                }
+            }
+        }
+
+        screen.container?.addOnLayoutChangeListener { _, _, _, _, _, _, _, _, _ ->
+            sheetTransitionCoordinator.onScreenContainerLayoutChanged(screen)
+        }
+    }
+
+    private fun handleInsetsUpdateAndNotifyTransition(insetsCompat: WindowInsetsCompat) {
+        if (lastInsetsCompat == insetsCompat) {
+            return
+        }
+        lastInsetsCompat = insetsCompat
+
+        // Reconfigure BottomSheetBehavior with the same state and updated maxHeight.
+        // When insets are available, we can factor them in to update the maximum height accordingly.
+        val sheetDelegate = requireSheetDelegate()
+        sheetDelegate.updateBottomSheetMetrics(screen.sheetBehavior!!)
+
+        screen.container?.let { container ->
+            // Needs to be highlighted that nothing changes at the container level.
+            // However, calling additional measure will trigger BottomSheetBehavior's `onMeasureChild` logic.
+            // This method ensures that the bottom sheet respects the maxHeight we update in `configureBottomSheetBehavior`.
+            coordinatorLayout.forceLayout()
+            coordinatorLayout.measure(
+                View.MeasureSpec.makeMeasureSpec(container.width, View.MeasureSpec.EXACTLY),
+                View.MeasureSpec.makeMeasureSpec(container.height, View.MeasureSpec.EXACTLY),
+            )
+            coordinatorLayout.layout(0, 0, container.width, container.height)
+        }
+
+        // Although the layout of the screen container and CoordinatorLayout hasn't changed,
+        // the BottomSheetBehavior has updated the maximum height.
+        // We manually trigger the callback to notify that the bottom sheet layout has been applied.
+        screen.onBottomSheetBehaviorDidLayout(true)
+
+        sheetTransitionCoordinator.onScreenContainerInsetsApplied(screen)
+    }
+
     private fun requireDimmingDelegate(forceCreation: Boolean = false): DimmingViewManager {
         if (dimmingDelegate == null || forceCreation) {
             dimmingDelegate?.invalidate(screen.sheetBehavior)
@@ -471,4 +547,11 @@ class ScreenStackFragment :
         }
         return sheetDelegate!!
     }
+
+    internal fun requireBottomSheetWindowInsetsListenerChain(): BottomSheetWindowInsetListenerChain {
+        if (bottomSheetWindowInsetListenerChain == null) {
+            bottomSheetWindowInsetListenerChain = BottomSheetWindowInsetListenerChain()
+        }
+        return bottomSheetWindowInsetListenerChain!!
+    }
 }

android/src/main/java/com/swmansion/rnscreens/ScreenViewManager.kt

@@ -269,6 +269,14 @@ open class ScreenViewManager :
         view?.sheetElevation = value.toFloat()
     }
 
+    @ReactProp(name = "sheetShouldOverflowTopInset")
+    override fun setSheetShouldOverflowTopInset(
+        view: Screen?,
+        sheetShouldOverflowTopInset: Boolean,
+    ) {
+        view?.sheetShouldOverflowTopInset = sheetShouldOverflowTopInset
+    }
+
     // mark: iOS-only
     // these props are not available on Android, however we must override their setters
     override fun setFullScreenSwipeEnabled(

android/src/main/java/com/swmansion/rnscreens/bottomsheet/BottomSheetBehaviorExt.kt

@@ -3,6 +3,19 @@ package com.swmansion.rnscreens.bottomsheet
 import android.view.View
 import com.google.android.material.bottomsheet.BottomSheetBehavior
 
+internal fun <T : View> BottomSheetBehavior<T>.updateMetrics(
+    maxAllowedHeight: Int? = null,
+    expandedOffsetFromTop: Int? = null,
+): BottomSheetBehavior<T> {
+    maxAllowedHeight?.let {
+        this.maxHeight = maxAllowedHeight
+    }
+    expandedOffsetFromTop?.let {
+        this.expandedOffset = expandedOffsetFromTop
+    }
+    return this
+}
+
 internal fun <T : View> BottomSheetBehavior<T>.useSingleDetent(
     maxAllowedHeight: Int? = null,
     forceExpandedState: Boolean = true,
@@ -13,7 +26,7 @@ internal fun <T : View> BottomSheetBehavior<T>.useSingleDetent(
         this.state = BottomSheetBehavior.STATE_EXPANDED
     }
     maxAllowedHeight?.let {
-        maxHeight = maxAllowedHeight
+        this.maxHeight = maxAllowedHeight
     }
     return this
 }
@@ -23,11 +36,11 @@ internal fun <T : View> BottomSheetBehavior<T>.useTwoDetents(
     firstHeight: Int? = null,
     maxAllowedHeight: Int? = null,
 ): BottomSheetBehavior<T> {
-    skipCollapsed = false
-    isFitToContents = true
+    this.skipCollapsed = false
+    this.isFitToContents = true
     state?.let { this.state = state }
-    firstHeight?.let { peekHeight = firstHeight }
-    maxAllowedHeight?.let { maxHeight = maxAllowedHeight }
+    firstHeight?.let { this.peekHeight = firstHeight }
+    maxAllowedHeight?.let { this.maxHeight = maxAllowedHeight }
     return this
 }
 
@@ -38,12 +51,12 @@ internal fun <T : View> BottomSheetBehavior<T>.useThreeDetents(
     halfExpandedRatio: Float? = null,
     expandedOffsetFromTop: Int? = null,
 ): BottomSheetBehavior<T> {
-    skipCollapsed = false
-    isFitToContents = false
+    this.skipCollapsed = false
+    this.isFitToContents = false
     state?.let { this.state = state }
     firstHeight?.let { this.peekHeight = firstHeight }
     halfExpandedRatio?.let { this.halfExpandedRatio = halfExpandedRatio }
     expandedOffsetFromTop?.let { this.expandedOffset = expandedOffsetFromTop }
-    maxAllowedHeight?.let { maxHeight = maxAllowedHeight }
+    maxAllowedHeight?.let { this.maxHeight = maxAllowedHeight }
     return this
 }

android/src/main/java/com/swmansion/rnscreens/bottomsheet/BottomSheetTransitionCoordinator.kt

@@ -0,0 +1,25 @@
+package com.swmansion.rnscreens.bottomsheet
+
+import com.swmansion.rnscreens.Screen
+
+class BottomSheetTransitionCoordinator {
+    private var isLayoutComplete = false
+    private var areInsetsApplied = false
+
+    internal fun onScreenContainerLayoutChanged(screen: Screen) {
+        isLayoutComplete = true
+        triggerSheetEnterTransitionIfReady(screen)
+    }
+
+    internal fun onScreenContainerInsetsApplied(screen: Screen) {
+        areInsetsApplied = true
+        triggerSheetEnterTransitionIfReady(screen)
+    }
+
+    private fun triggerSheetEnterTransitionIfReady(screen: Screen) {
+        if (!isLayoutComplete || !areInsetsApplied) return
+
+        screen.requestTriggeringPostponedEnterTransition()
+        screen.triggerPostponedEnterTransitionIfNeeded()
+    }
+}

android/src/main/java/com/swmansion/rnscreens/bottomsheet/BottomSheetWindowInsetListenerChain.kt

@@ -0,0 +1,36 @@
+package com.swmansion.rnscreens.bottomsheet
+
+import android.view.View
+import androidx.core.view.OnApplyWindowInsetsListener
+import androidx.core.view.WindowInsetsCompat
+
+/**
+ * Aggregates and sequentially invokes many instances of OnApplyWindowInsetsListener
+ *
+ * In Android, only a single ViewCompat.setOnApplyWindowInsetsListener can be set on a view,
+ * which leads to listeners overwriting each other. This class solves the listener conflict
+ * by allowing different components to a common chain. As we do not consume or modify insets, the
+ * order is not important and the chain may work.
+ *
+ * In our case it's crucial, because we need to react on insets for both:
+ * - avoiding bottom/top insets by BottomSheet
+ * - keyboard handling
+ */
+class BottomSheetWindowInsetListenerChain : OnApplyWindowInsetsListener {
+    private val listeners = mutableListOf<OnApplyWindowInsetsListener>()
+
+    fun addListener(listener: OnApplyWindowInsetsListener) {
+        listeners.add(listener)
+    }
+
+    override fun onApplyWindowInsets(
+        v: View,
+        insets: WindowInsetsCompat,
+    ): WindowInsetsCompat {
+        for (listener in listeners) {
+            listener.onApplyWindowInsets(v, insets)
+        }
+
+        return insets
+    }
+}