Deprecate "onBackstackChange" in favor of recommended methods

It can be easily misused.
olshevski · Aug 22, 2022 · c7c6791 · c7c6791
1 parent 5c604e9
commit c7c6791
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 5 deletions.
diff --git a/docs/nav-controller.md b/docs/nav-controller.md
@@ -117,5 +117,3 @@ fun NavController<BottomNavigationDestination>.moveLastEntryToStart() {
 ## NavBackstack
 
 You may access current backstack entries and the last [NavAction](/compose-navigation-reimagined/animations/#navaction) through `backstack` property of NavController. This property is backed up by [MutableState](https://developer.android.com/reference/kotlin/androidx/compose/runtime/MutableState) and any changes to it will notify composition.
-
-If you want to listen for backstack changes outside of composition you may set `onBackstackChange` listener of NavController.
diff --git a/reimagined/src/main/kotlin/dev/olshevski/navigation/reimagined/NavController.kt b/reimagined/src/main/kotlin/dev/olshevski/navigation/reimagined/NavController.kt
@@ -93,9 +93,6 @@ class NavController<T> internal constructor(
     /**
      * The current backstack. This property is backed up by [MutableState] and any changes to it
      * will notify composition.
-     *
-     * If you want to listen for changes outside of composition, you may set [onBackstackChange]
-     * listener.
      */
     val backstack get() = _backstack
 
@@ -104,6 +101,7 @@ class NavController<T> internal constructor(
      * to [setNewBackstack].
      */
     @Suppress("MemberVisibilityCanBePrivate")
+    @Deprecated("Use recommended Compose methods to listen for 'backstack' changes, e.g. snapshotFlow, derivedStateOf, etc.")
     var onBackstackChange: ((backstack: NavBackstack<T>) -> Unit)? = null
 
     /**