react-native-screens 3.8.0 → 3.10.2

package/README.md

@@ -1,6 +1,5 @@
 <img src="https://user-images.githubusercontent.com/16062886/117443651-c13d9500-af38-11eb-888d-b6a0b580760c.png" width="100%" alt="React Native Screens by Software Mansion" >
 
-
 This project aims to expose native navigation container components to React Native. It is not designed to be used as a standalone library but rather as a dependency of a [full-featured navigation library](https://github.com/react-navigation/react-navigation).
 
 ## Supported platforms
@@ -36,6 +35,26 @@ protected void onCreate(Bundle savedInstanceState) {
 
 For people that must handle cases like this, there is [a more detailed discussion of the difficulties in a series of related comments](https://github.com/software-mansion/react-native-screens/issues/17#issuecomment-424704633).
 
+<details>
+<summary>Need to use a custom Kotlin version?</summary>
+<br>
+
+Since `v3.6.0` `react-native-screens` has been rewritten with Kotlin. Kotlin version used in this library defaults to `1.4.10`.
+
+If you need to use a different Kotlin version, set `kotlinVersion` ext property in your project's `android/build.gradle` and the library will use this version accordingly:
+
+```
+buildscript {
+    ext {
+        ...
+        kotlinVersion = "1.4.10"
+    }
+}
+```
+
+**Disclaimer**: `react-native-screens` requires Kotlin `1.3.50` or higher.
+</details>
+
 ### Windows
 
 Installation on Windows should be completely handled with auto-linking when using React Native Windows 0.63+. For earlier versions, you must [manually link](https://microsoft.github.io/react-native-windows/docs/native-modules-using) the native module.
@@ -69,6 +88,24 @@ Just make sure that the version of [react-navigation](https://github.com/react-n
 
 You are all set 🎉 – when screens are enabled in your application code react-navigation will automatically use them instead of relying on plain React Native Views.
 
+### Experimental support for `react-freeze`
+
+> You have to use React Native 0.64 or higher, react-navigation 5.x or 6.x and react-native-screens >= v3.9.0
+
+Since `v3.9.0`, `react-native-screens` comes with experimental support for [`react-freeze`](https://github.com/software-mansion-labs/react-freeze). It uses the React `Suspense` mechanism to prevent parts of the React component tree from rendering, while keeping its state untouched.
+
+To benefit from this feature, enable it in your entry file (e.g. `App.js`) with this snippet:
+
+```js
+import { enableFreeze } from 'react-native-screens';
+
+enableFreeze(true);
+```
+
+Want to know more? Check out [react-freeze README](https://github.com/software-mansion-labs/react-freeze#readme)
+
+Found a bug? File an issue [here](https://github.com/software-mansion/react-native-screens/issues) or directly in [react-freeze repository](https://github.com/software-mansion-labs/react-freeze/issues).
+
 ### Disabling `react-native-screens`
 
 If, for whatever reason, you'd like to disable native screens support and use plain React Native Views add the following code in your entry file (e.g. `App.js`):
@@ -84,9 +121,10 @@ You can also disable the usage of native screens per navigator with [`detachInac
 ### Using `createNativeStackNavigator` with React Navigation
 
 To take advantage of the native stack navigator primitive for React Navigation that leverages `UINavigationController` on iOS and `Fragment` on Android, please refer:
+
 - for React Navigation >= v6 to the [Native Stack Navigator part of React Navigation documentation](https://reactnavigation.org/docs/native-stack-navigator)
-- for React Navigation v5 to the [README in react-native-screens/native-stack](https://github.com/software-mansion/react-native-screens/tree/master/native-stack) 
-- for older versions to the [README in react-native-screens/createNativeStackNavigator](https://github.com/software-mansion/react-native-screens/tree/master/createNativeStackNavigator) 
+- for React Navigation v5 to the [README in react-native-screens/native-stack](https://github.com/software-mansion/react-native-screens/tree/master/native-stack)
+- for older versions to the [README in react-native-screens/createNativeStackNavigator](https://github.com/software-mansion/react-native-screens/tree/master/createNativeStackNavigator)
 
 ## Interop with [react-native-navigation](https://github.com/wix/react-native-navigation)
 
@@ -101,6 +139,26 @@ This library should work out of the box with all existing react-native libraries
 If you are building a navigation library you may want to use `react-native-screens` to have control over which parts of the React component tree are attached to the native view hierarchy.
 To do that, `react-native-screens` provides you with the components documented [here](https://github.com/kmagiera/react-native-screens/tree/master/guides/GUIDE_FOR_LIBRARY_AUTHORS.md).
 
+## Common problems
+
+### Problems with header on iOS
+
+- [Focused search bar causes new screens to have incorrect header](https://github.com/software-mansion/react-native-screens/issues/996)
+- [Scrollable content gets cut off by the header with a search bar](https://github.com/software-mansion/react-native-screens/issues/1120)
+- [RefreshControl does not work properly with NativeStackNavigator and largeTitle](https://github.com/software-mansion/react-native-screens/issues/395)
+
+#### Solution
+
+Use `ScrollView` with prop `contentInsetAdjustmentBehavior=“automatic”` as a main container of the screen and set `headerTranslucent: true` in screen options.
+
+### Other problems
+
+| Problem                                                                                                                                      | Solution                                                                                                    |
+| -------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
+| [SVG component becomes transparent when goBack](https://github.com/software-mansion/react-native-screens/issues/773)                         | [related PRs](https://github.com/software-mansion/react-native-screens/issues/773#issuecomment-783469792)           |
+| [Memory leak while moving from one screen to another in the same stack](https://github.com/software-mansion/react-native-screens/issues/843) | [explanation](https://github.com/software-mansion/react-native-screens/issues/843#issuecomment-832034119)   |
+| [LargeHeader stays small after pop/goBack/swipe gesture on iOS 14+](https://github.com/software-mansion/react-native-screens/issues/649)     | [potential fix](https://github.com/software-mansion/react-native-screens/issues/649#issuecomment-712199895) |
+
 ## Contributing
 
 There are many ways to contribute to this project. See [CONTRIBUTING](https://github.com/kmagiera/react-native-screens/tree/master/guides/CONTRIBUTING.md) guide for more information. Thank you for your interest in contributing!

package/android/build.gradle

@@ -4,7 +4,6 @@ buildscript {
     }
     repositories {
         google()
-        jcenter()
         mavenCentral()
     }
     dependencies {
@@ -50,7 +49,6 @@ repositories {
     mavenCentral()
     mavenLocal()
     google()
-    jcenter()
 }
 
 dependencies {

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

@@ -0,0 +1,71 @@
+package com.swmansion.rnscreens
+
+import android.content.Context
+import androidx.activity.OnBackPressedCallback
+import androidx.appcompat.widget.SearchView
+import androidx.fragment.app.Fragment
+
+class CustomSearchView(context: Context, fragment: Fragment) : SearchView(context) {
+    /*
+        CustomSearchView uses some variables from SearchView. They are listed below with links to documentation
+        isIconified - https://developer.android.com/reference/android/widget/SearchView#setIconified(boolean)
+        maxWidth - https://developer.android.com/reference/android/widget/SearchView#setMaxWidth(int)
+        setOnSearchClickListener - https://developer.android.com/reference/android/widget/SearchView#setOnSearchClickListener(android.view.View.OnClickListener)
+        setOnCloseListener - https://developer.android.com/reference/android/widget/SearchView#setOnCloseListener(android.widget.SearchView.OnCloseListener)
+    */
+    private var mCustomOnCloseListener: OnCloseListener? = null
+    private var mCustomOnSearchClickedListener: OnClickListener? = null
+
+    private var mOnBackPressedCallback: OnBackPressedCallback =
+        object : OnBackPressedCallback(true) {
+            override fun handleOnBackPressed() {
+                isIconified = true
+            }
+        }
+    private val backPressOverrider = FragmentBackPressOverrider(fragment, mOnBackPressedCallback)
+    var overrideBackAction: Boolean
+        set(value) {
+            backPressOverrider.overrideBackAction = value
+        }
+        get() = backPressOverrider.overrideBackAction
+
+    fun focus() {
+        isIconified = false
+        requestFocusFromTouch()
+    }
+
+    override fun setOnCloseListener(listener: OnCloseListener?) {
+        mCustomOnCloseListener = listener
+    }
+
+    override fun setOnSearchClickListener(listener: OnClickListener?) {
+        mCustomOnSearchClickedListener = listener
+    }
+
+    override fun onAttachedToWindow() {
+        super.onAttachedToWindow()
+        if (!isIconified) {
+            backPressOverrider.maybeAddBackCallback()
+        }
+    }
+
+    override fun onDetachedFromWindow() {
+        super.onDetachedFromWindow()
+        backPressOverrider.removeBackCallbackIfAdded()
+    }
+
+    init {
+        super.setOnSearchClickListener { v ->
+            mCustomOnSearchClickedListener?.onClick(v)
+            backPressOverrider.maybeAddBackCallback()
+        }
+
+        super.setOnCloseListener {
+            val result = mCustomOnCloseListener?.onClose() ?: false
+            backPressOverrider.removeBackCallbackIfAdded()
+            result
+        }
+
+        maxWidth = Integer.MAX_VALUE
+    }
+}

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

@@ -0,0 +1,7 @@
+package com.swmansion.rnscreens
+
+import android.content.Context
+import androidx.appcompat.widget.Toolbar
+
+// This class is used to store config closer to search bar
+open class CustomToolbar(context: Context, val config: ScreenStackHeaderConfig) : Toolbar(context)

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

@@ -0,0 +1,29 @@
+package com.swmansion.rnscreens
+
+import androidx.activity.OnBackPressedCallback
+import androidx.fragment.app.Fragment
+
+class FragmentBackPressOverrider(
+    private val fragment: Fragment,
+    private val mOnBackPressedCallback: OnBackPressedCallback
+) {
+    private var mIsBackCallbackAdded: Boolean = false
+    var overrideBackAction: Boolean = true
+
+    fun maybeAddBackCallback() {
+        if (!mIsBackCallbackAdded && overrideBackAction) {
+            fragment.activity?.onBackPressedDispatcher?.addCallback(
+                fragment,
+                mOnBackPressedCallback
+            )
+            mIsBackCallbackAdded = true
+        }
+    }
+
+    fun removeBackCallbackIfAdded() {
+        if (mIsBackCallbackAdded) {
+            mOnBackPressedCallback.remove()
+            mIsBackCallbackAdded = false
+        }
+    }
+}

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

@@ -15,6 +15,7 @@ class RNScreensPackage : ReactPackage {
             ScreenViewManager(),
             ScreenStackViewManager(),
             ScreenStackHeaderConfigViewManager(),
-            ScreenStackHeaderSubviewManager()
+            ScreenStackHeaderSubviewManager(),
+            SearchBarManager()
         )
 }

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

@@ -1,18 +1,13 @@
 package com.swmansion.rnscreens
 
 import android.annotation.SuppressLint
-import android.content.Context
 import android.content.pm.ActivityInfo
 import android.graphics.Paint
-import android.os.Build
 import android.os.Parcelable
 import android.util.SparseArray
-import android.view.View
 import android.view.ViewGroup
 import android.view.WindowManager
-import android.view.inputmethod.InputMethodManager
 import android.webkit.WebView
-import android.widget.TextView
 import com.facebook.react.bridge.GuardedRunnable
 import com.facebook.react.bridge.ReactContext
 import com.facebook.react.uimanager.UIManagerModule
@@ -87,28 +82,6 @@ class Screen constructor(context: ReactContext?) : ViewGroup(context) {
         }
     }
 
-    override fun onAttachedToWindow() {
-        super.onAttachedToWindow()
-        // This method implements a workaround for RN's autoFocus functionality. Because of the way
-        // autoFocus is implemented it sometimes gets triggered before native text view is mounted. As
-        // a result Android ignores calls for opening soft keyboard and here we trigger it manually
-        // again after the screen is attached.
-        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
-            var view = focusedChild
-            if (view != null) {
-                while (view is ViewGroup) {
-                    view = view.focusedChild
-                }
-                if (view is TextView) {
-                    val textView = view
-                    if (textView.showSoftInputOnFocus) {
-                        textView.addOnAttachStateChangeListener(sShowSoftKeyboardOnAttach)
-                    }
-                }
-            }
-        }
-    }
-
     val headerConfig: ScreenStackHeaderConfig?
         get() {
             val child = getChildAt(0)
@@ -183,6 +156,13 @@ class Screen constructor(context: ReactContext?) : ViewGroup(context) {
         fragment?.let { ScreenWindowTraits.setOrientation(this, it.tryGetActivity()) }
     }
 
+    // Accepts one of 4 accessibility flags
+    // developer.android.com/reference/android/view/View#attr_android:importantForAccessibility
+    fun changeAccessibilityMode(mode: Int) {
+        this.importantForAccessibility = mode
+        this.headerConfig?.toolbar?.importantForAccessibility = mode
+    }
+
     var statusBarStyle: String?
         get() = mStatusBarStyle
         set(statusBarStyle) {
@@ -254,18 +234,4 @@ class Screen constructor(context: ReactContext?) : ViewGroup(context) {
     enum class WindowTraits {
         ORIENTATION, COLOR, STYLE, TRANSLUCENT, HIDDEN, ANIMATED
     }
-
-    companion object {
-        private val sShowSoftKeyboardOnAttach: OnAttachStateChangeListener =
-            object : OnAttachStateChangeListener {
-                override fun onViewAttachedToWindow(view: View) {
-                    val inputMethodManager =
-                        view.context.getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
-                    inputMethodManager.showSoftInput(view, 0)
-                    view.removeOnAttachStateChangeListener(this)
-                }
-
-                override fun onViewDetachedFromWindow(view: View) {}
-            }
-    }
 }

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

@@ -11,6 +11,7 @@ import androidx.fragment.app.FragmentActivity
 import androidx.fragment.app.FragmentManager
 import androidx.fragment.app.FragmentTransaction
 import com.facebook.react.ReactRootView
+import com.facebook.react.bridge.ReactContext
 import com.facebook.react.modules.core.ChoreographerCompat
 import com.facebook.react.modules.core.ReactChoreographer
 import com.swmansion.rnscreens.Screen.ActivityState
@@ -176,16 +177,12 @@ open class ScreenContainer<T : ScreenFragment>(context: Context?) : ViewGroup(co
         return transaction
     }
 
-    private fun attachScreen(screenFragment: ScreenFragment) {
-        createTransaction().add(id, screenFragment).commitNowAllowingStateLoss()
+    private fun attachScreen(transaction: FragmentTransaction, screenFragment: ScreenFragment) {
+        transaction.add(id, screenFragment)
     }
 
-    private fun moveToFront(screenFragment: ScreenFragment) {
-        createTransaction().remove(screenFragment).add(id, screenFragment).commitNowAllowingStateLoss()
-    }
-
-    private fun detachScreen(screenFragment: ScreenFragment) {
-        createTransaction().remove(screenFragment).commitNowAllowingStateLoss()
+    private fun detachScreen(transaction: FragmentTransaction, screenFragment: ScreenFragment) {
+        transaction.remove(screenFragment)
     }
 
     private fun getActivityState(screenFragment: ScreenFragment): ActivityState? {
@@ -276,10 +273,18 @@ open class ScreenContainer<T : ScreenFragment>(context: Context?) : ViewGroup(co
         // The exception to this rule is `updateImmediately` which is triggered by actions
         // not connected to React view hierarchy changes, but rather internal events
         mNeedUpdate = true
+        (context as? ReactContext)?.runOnUiQueueThread {
+            // We schedule the update here because LayoutAnimations of `react-native-reanimated`
+            // sometimes attach/detach screens after the layout block of `ScreensShadowNode` has
+            // already run, and we want to update the container then too. In the other cases,
+            // this code will do nothing since it will run after the UIBlock when `mNeedUpdate`
+            // will already be false.
+            performUpdates()
+        }
     }
 
     protected fun performUpdatesNow() {
-        // we want to update the immediately when the fragment manager is set or native back button
+        // we want to update immediately when the fragment manager is set or native back button
         // dismiss is dispatched or Screen's activityState changes since it is not connected to React
         // view hierarchy changes and will not trigger `onBeforeLayout` method of `ScreensShadowNode`
         mNeedUpdate = true
@@ -287,7 +292,7 @@ open class ScreenContainer<T : ScreenFragment>(context: Context?) : ViewGroup(co
     }
 
     fun performUpdates() {
-        if (!mNeedUpdate || !mIsAttached || mFragmentManager == null) {
+        if (!mNeedUpdate || !mIsAttached || mFragmentManager == null || mFragmentManager?.isDestroyed == true) {
             return
         }
         mNeedUpdate = false
@@ -296,43 +301,53 @@ open class ScreenContainer<T : ScreenFragment>(context: Context?) : ViewGroup(co
     }
 
     open fun onUpdate() {
-        // detach screens that are no longer active
-        val orphaned: MutableSet<Fragment> = HashSet(requireNotNull(mFragmentManager, { "mFragmentManager is null when performing update in ScreenContainer" }).fragments)
-        for (screenFragment in mScreenFragments) {
-            if (getActivityState(screenFragment) === ActivityState.INACTIVE &&
-                screenFragment.isAdded
-            ) {
-                detachScreen(screenFragment)
+        createTransaction().let {
+            // detach screens that are no longer active
+            val orphaned: MutableSet<Fragment> = HashSet(requireNotNull(mFragmentManager, { "mFragmentManager is null when performing update in ScreenContainer" }).fragments)
+            for (screenFragment in mScreenFragments) {
+                if (getActivityState(screenFragment) === ActivityState.INACTIVE &&
+                    screenFragment.isAdded
+                ) {
+                    detachScreen(it, screenFragment)
+                }
+                orphaned.remove(screenFragment)
             }
-            orphaned.remove(screenFragment)
-        }
-        if (orphaned.isNotEmpty()) {
-            val orphanedAry = orphaned.toTypedArray()
-            for (fragment in orphanedAry) {
-                if (fragment is ScreenFragment) {
-                    if (fragment.screen.container == null) {
-                        detachScreen(fragment)
+            if (orphaned.isNotEmpty()) {
+                val orphanedAry = orphaned.toTypedArray()
+                for (fragment in orphanedAry) {
+                    if (fragment is ScreenFragment) {
+                        if (fragment.screen.container == null) {
+                            detachScreen(it, fragment)
+                        }
                     }
                 }
             }
-        }
-        var transitioning = true
-        if (topScreen != null) {
+
             // if there is an "onTop" screen it means the transition has ended
-            transitioning = false
-        }
+            val transitioning = topScreen == null
 
-        // attach newly activated screens
-        var addedBefore = false
-        for (screenFragment in mScreenFragments) {
-            val activityState = getActivityState(screenFragment)
-            if (activityState !== ActivityState.INACTIVE && !screenFragment.isAdded) {
-                addedBefore = true
-                attachScreen(screenFragment)
-            } else if (activityState !== ActivityState.INACTIVE && addedBefore) {
-                moveToFront(screenFragment)
+            // attach newly activated screens
+            var addedBefore = false
+            val pendingFront: ArrayList<T> = ArrayList()
+
+            for (screenFragment in mScreenFragments) {
+                val activityState = getActivityState(screenFragment)
+                if (activityState !== ActivityState.INACTIVE && !screenFragment.isAdded) {
+                    addedBefore = true
+                    attachScreen(it, screenFragment)
+                } else if (activityState !== ActivityState.INACTIVE && addedBefore) {
+                    // we detach the screen and then reattach it later to make it appear on front
+                    detachScreen(it, screenFragment)
+                    pendingFront.add(screenFragment)
+                }
+                screenFragment.screen.setTransitioning(transitioning)
+            }
+
+            for (screenFragment in pendingFront) {
+                attachScreen(it, screenFragment)
             }
-            screenFragment.screen.setTransitioning(transitioning)
+
+            it.commitNowAllowingStateLoss()
         }
     }
 

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

@@ -2,6 +2,7 @@ package com.swmansion.rnscreens
 
 import android.annotation.SuppressLint
 import android.app.Activity
+import android.content.Context
 import android.os.Bundle
 import android.view.LayoutInflater
 import android.view.View
@@ -61,7 +62,7 @@ open class ScreenFragment : Fragment {
         container: ViewGroup?,
         savedInstanceState: Bundle?
     ): View? {
-        val wrapper = context?.let { FrameLayout(it) }
+        val wrapper = context?.let { ScreensFrameLayout(it) }
 
         val params = FrameLayout.LayoutParams(
             ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT
@@ -71,6 +72,23 @@ open class ScreenFragment : Fragment {
         return wrapper
     }
 
+    private class ScreensFrameLayout(
+        context: Context,
+    ) : FrameLayout(context) {
+        /**
+         * This method implements a workaround for RN's autoFocus functionality. Because of the way
+         * autoFocus is implemented it dismisses soft keyboard in fragment transition
+         * due to change of visibility of the view at the start of the transition. Here we override the
+         * call to `clearFocus` when the visibility of view is `INVISIBLE` since `clearFocus` triggers the
+         * hiding of the keyboard in `ReactEditText.java`.
+         */
+        override fun clearFocus() {
+            if (visibility != INVISIBLE) {
+                super.clearFocus()
+            }
+        }
+    }
+
     open fun onContainerUpdate() {
         updateWindowTraits()
     }

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

@@ -120,11 +120,11 @@ class ScreenStack(context: Context?) : ScreenContainer<ScreenStackFragment>(cont
                 // if the previous top screen does not exist anymore and the new top was not on the stack
                 // before, probably replace or reset was called, so we play the "close animation".
                 // Otherwise it's open animation
-                shouldUseOpenAnimation = (
-                    mScreenFragments.contains(mTopScreen) ||
-                        newTop.screen.replaceAnimation !== Screen.ReplaceAnimation.POP
-                    )
-                stackAnimation = newTop.screen.stackAnimation
+                val containsTopScreen = mTopScreen?.let { mScreenFragments.contains(it) } == true
+                val isPushReplace = newTop.screen.replaceAnimation === Screen.ReplaceAnimation.PUSH
+                shouldUseOpenAnimation = containsTopScreen || isPushReplace
+                // if the replace animation is `push`, the new top screen provides the animation, otherwise the previous one
+                stackAnimation = if (shouldUseOpenAnimation) newTop.screen.stackAnimation else mTopScreen?.screen?.stackAnimation
             } else if (mTopScreen == null && newTop != null) {
                 // mTopScreen was not present before so newTop is the first screen added to a stack
                 // and we don't want the animation when it is entering, but we want to send the
@@ -238,10 +238,35 @@ class ScreenStack(context: Context?) : ScreenContainer<ScreenStackFragment>(cont
             mTopScreen = newTop
             mStack.clear()
             mStack.addAll(mScreenFragments)
+
+            turnOffA11yUnderTransparentScreen(visibleBottom)
+
             it.commitNowAllowingStateLoss()
         }
     }
 
+    // only top visible screen should be accessible
+    private fun turnOffA11yUnderTransparentScreen(visibleBottom: ScreenStackFragment?) {
+        if (mScreenFragments.size > 1 && visibleBottom != null) {
+            mTopScreen?.let {
+                if (isTransparent(it)) {
+                    val screenFragmentsBeneathTop = mScreenFragments.slice(0 until mScreenFragments.size - 1).asReversed()
+                    // go from the top of the stack excluding the top screen
+                    for (screenFragment in screenFragmentsBeneathTop) {
+                        screenFragment.screen.changeAccessibilityMode(IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS)
+
+                        // don't change a11y below non-transparent screens
+                        if (screenFragment == visibleBottom) {
+                            break
+                        }
+                    }
+                }
+            }
+        }
+
+        topScreen?.changeAccessibilityMode(IMPORTANT_FOR_ACCESSIBILITY_AUTO)
+    }
+
     override fun notifyContainerUpdate() {
         for (screen in mStack) {
             screen.onContainerUpdate()