Open a stack of screens by a deeplink

navigation/navigation-common/api/desktop/navigation-common.api

@@ -156,6 +156,8 @@ public class androidx/navigation/NavDestination {
 	public final fun addDeepLink (Landroidx/navigation/NavDeepLink;)V
 	public final fun addDeepLink (Ljava/lang/String;)V
 	public final fun addInDefaultArgs (Landroidx/core/bundle/Bundle;)Landroidx/core/bundle/Bundle;
+	public final fun buildDeepLinkDestinations (Landroidx/navigation/NavDestination;)Ljava/util/List;
+	public static synthetic fun buildDeepLinkDestinations$default (Landroidx/navigation/NavDestination;Landroidx/navigation/NavDestination;ILjava/lang/Object;)Ljava/util/List;
 	public fun equals (Ljava/lang/Object;)Z
 	public final fun getArguments ()Ljava/util/Map;
 	public fun getDisplayName ()Ljava/lang/String;

navigation/navigation-common/src/jbMain/kotlin/androidx/navigation/NavDestination.jb.kt

@@ -210,6 +210,31 @@ public actual open class NavDestination actual constructor(
         return bestMatch
     }
 
+    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+    public fun buildDeepLinkDestinations(previousDestination: NavDestination? = null): List<NavDestination> {
+        val hierarchy = ArrayDeque<NavDestination>()
+        var current: NavDestination? = this
+        do {
+            val parent = current!!.parent
+            if (
+            // If the current destination is a sibling of the previous, just add it straightaway
+                previousDestination?.parent != null &&
+                previousDestination.parent!!.findNode(current.id) === current
+            ) {
+                hierarchy.addFirst(current)
+                break
+            }
+            if (parent == null || parent.startDestinationId != current.id) {
+                hierarchy.addFirst(current)
+            }
+            if (parent == previousDestination) {
+                break
+            }
+            current = parent
+        } while (current != null)
+        return hierarchy.toList()
+    }
+
     @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
     public actual fun hasRoute(route: String, arguments: Bundle?): Boolean {
         // this matches based on routePattern

navigation/navigation-compose/src/commonTest/kotlin/androidx/navigation/compose/NavGraphBuilderTest.kt

@@ -18,14 +18,17 @@ package androidx.navigation.compose
 
 import androidx.compose.ui.test.ExperimentalTestApi
 import androidx.core.bundle.Bundle
+import androidx.core.uri.UriUtils
 import androidx.kruth.assertThat
 import androidx.kruth.assertWithMessage
+import androidx.navigation.NavDeepLinkRequest
 import androidx.navigation.NavGraph
 import androidx.navigation.NavGraph.Companion.findStartDestination
 import androidx.navigation.NavType
 import androidx.navigation.contains
 import androidx.navigation.get
 import androidx.navigation.navArgument
+import androidx.navigation.navDeepLink
 import androidx.navigation.navigation
 import androidx.navigation.serialization.generateHashCode
 import androidx.navigation.testing.TestNavHostController
@@ -41,6 +44,61 @@ import kotlinx.serialization.serializer
 @ExperimentalCoroutinesApi
 class NavGraphBuilderTest {
 
+    @Test
+    fun testDeepLink() = runComposeUiTestOnUiThread {
+        lateinit var navController: TestNavHostController
+        val uriString = "https://www.example.com"
+        val deeplink = NavDeepLinkRequest.Builder.fromUri(UriUtils.parse(uriString)).build()
+        setContentWithLifecycleOwner {
+            navController = TestNavHostController()
+            navController.navigatorProvider.addNavigator(ComposeNavigator())
+
+            NavHost(navController, startDestination = firstRoute) {
+                composable(firstRoute) {}
+                composable(
+                    secondRoute,
+                    deepLinks = listOf(navDeepLink { uriPattern = uriString })
+                ) {}
+            }
+        }
+
+        runOnUiThread {
+            navController.navigate(UriUtils.parse(uriString))
+            assertThat(navController.currentBackStackEntry!!.destination.hasDeepLink(deeplink))
+                .isTrue()
+        }
+    }
+
+    @Test
+    fun testNestedNavigationDeepLink() = runComposeUiTestOnUiThread {
+        lateinit var navController: TestNavHostController
+        val uriString = "https://www.example.com"
+        val deeplink = NavDeepLinkRequest.Builder.fromUri(UriUtils.parse(uriString)).build()
+        setContentWithLifecycleOwner {
+            navController = TestNavHostController()
+            navController.navigatorProvider.addNavigator(ComposeNavigator())
+
+            NavHost(navController, startDestination = firstRoute) {
+                composable(firstRoute) {}
+                navigation(
+                    startDestination = thirdRoute,
+                    route = secondRoute,
+                    deepLinks = listOf(navDeepLink { uriPattern = uriString })
+                ) {
+                    composable(thirdRoute) {}
+                }
+            }
+        }
+
+        runOnUiThread {
+            navController.navigate(UriUtils.parse(uriString))
+            assertThat(
+                navController.getBackStackEntry(secondRoute).destination.hasDeepLink(deeplink)
+            )
+                .isTrue()
+        }
+    }
+
     @Test
     fun testCurrentBackStackEntryNavigate() = runComposeUiTestOnUiThread {
         lateinit var navController: TestNavHostController

navigation/navigation-runtime/api/desktop/navigation-runtime.api

@@ -5,6 +5,7 @@ public class androidx/navigation/NavController {
 	public final fun clearBackStack (I)Z
 	public final fun clearBackStack (Ljava/lang/Object;)Z
 	public final fun clearBackStack (Ljava/lang/String;)Z
+	public static final fun enableDeepLinkSaveState (Z)V
 	public final fun findDestination (I)Landroidx/navigation/NavDestination;
 	public final fun findDestination (Ljava/lang/String;)Landroidx/navigation/NavDestination;
 	public final fun findDestinationComprehensive (Landroidx/navigation/NavDestination;IZ)Landroidx/navigation/NavDestination;
@@ -18,7 +19,10 @@ public class androidx/navigation/NavController {
 	public fun getNavigatorProvider ()Landroidx/navigation/NavigatorProvider;
 	public fun getPreviousBackStackEntry ()Landroidx/navigation/NavBackStackEntry;
 	public final fun getVisibleEntries ()Lkotlinx/coroutines/flow/StateFlow;
-	public final fun handleDeepLink (Landroidx/core/uri/Uri;)Z
+	public final fun handleDeepLink (Landroidx/navigation/NavDeepLinkRequest;)Z
+	public fun navigate (Landroidx/core/uri/Uri;)V
+	public fun navigate (Landroidx/core/uri/Uri;Landroidx/navigation/NavOptions;)V
+	public fun navigate (Landroidx/core/uri/Uri;Landroidx/navigation/NavOptions;Landroidx/navigation/Navigator$Extras;)V
 	public fun navigate (Landroidx/navigation/NavDeepLinkRequest;)V
 	public fun navigate (Landroidx/navigation/NavDeepLinkRequest;Landroidx/navigation/NavOptions;)V
 	public fun navigate (Landroidx/navigation/NavDeepLinkRequest;Landroidx/navigation/NavOptions;Landroidx/navigation/Navigator$Extras;)V
@@ -53,6 +57,7 @@ public class androidx/navigation/NavController {
 }
 
 public final class androidx/navigation/NavController$Companion {
+	public final fun enableDeepLinkSaveState (Z)V
 }
 
 public abstract interface class androidx/navigation/NavController$OnDestinationChangedListener {
@@ -68,6 +73,9 @@ public final class androidx/navigation/NavControllerKt {
 	public static synthetic fun createGraph$default (Landroidx/navigation/NavController;Lkotlin/reflect/KClass;Lkotlin/reflect/KClass;Ljava/util/Map;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)Landroidx/navigation/NavGraph;
 }
 
+public abstract interface annotation class androidx/navigation/NavDeepLinkSaveStateControl : java/lang/annotation/Annotation {
+}
+
 public abstract interface class androidx/navigation/NavHost {
 	public abstract fun getNavController ()Landroidx/navigation/NavController;
 }

navigation/navigation-runtime/src/androidMain/kotlin/androidx/navigation/NavController.android.kt

@@ -1820,7 +1820,7 @@ public actual open class NavController(
      * @see NavController.navigate
      */
     @MainThread
-    public open fun navigate(deepLink: Uri) {
+    public actual open fun navigate(deepLink: Uri) {
         navigate(NavDeepLinkRequest(deepLink, null, null))
     }
 
@@ -1835,7 +1835,7 @@ public actual open class NavController(
      * @see NavController.navigate
      */
     @MainThread
-    public open fun navigate(deepLink: Uri, navOptions: NavOptions?) {
+    public actual open fun navigate(deepLink: Uri, navOptions: NavOptions?) {
         navigate(NavDeepLinkRequest(deepLink, null, null), navOptions, null)
     }
 
@@ -1851,7 +1851,7 @@ public actual open class NavController(
      * @see NavController.navigate
      */
     @MainThread
-    public open fun navigate(
+    public actual open fun navigate(
         deepLink: Uri,
         navOptions: NavOptions?,
         navigatorExtras: Navigator.Extras?
@@ -2745,7 +2745,7 @@ public actual open class NavController(
             return iterator.asSequence().firstOrNull { entry -> entry.destination !is NavGraph }
         }
 
-    public companion object {
+    public actual companion object {
         private const val TAG = "NavController"
         private const val KEY_NAVIGATOR_STATE = "android-support-nav:controller:navigatorState"
         private const val KEY_NAVIGATOR_STATE_NAMES =
@@ -2786,7 +2786,7 @@ public actual open class NavController(
          */
         @JvmStatic
         @NavDeepLinkSaveStateControl
-        public fun enableDeepLinkSaveState(saveState: Boolean) {
+        public actual fun enableDeepLinkSaveState(saveState: Boolean) {
             deepLinkSaveState = saveState
         }
     }

navigation/navigation-runtime/src/commonMain/kotlin/androidx/navigation/NavController.kt

@@ -20,9 +20,11 @@ import androidx.annotation.CallSuper
 import androidx.annotation.MainThread
 import androidx.annotation.RestrictTo
 import androidx.core.bundle.Bundle
+import androidx.core.uri.Uri
 import androidx.lifecycle.LifecycleOwner
 import androidx.lifecycle.ViewModelStore
 import kotlin.jvm.JvmOverloads
+import kotlin.jvm.JvmStatic
 import kotlin.reflect.KClass
 import kotlin.reflect.KType
 import kotlinx.coroutines.flow.Flow
@@ -375,6 +377,49 @@ public expect open class NavController {
         navigatorExtras: Navigator.Extras? = null
     )
 
+    /**
+     * Navigate to a destination via the given deep link [Uri]. [NavDestination.hasDeepLink] should
+     * be called on [the navigation graph][graph] prior to calling this method to check if the deep
+     * link is valid. If an invalid deep link is given, an [IllegalArgumentException] will be
+     * thrown.
+     *
+     * @param deepLink deepLink to the destination reachable from the current NavGraph
+     * @see NavController.navigate
+     */
+    @MainThread
+    public open fun navigate(deepLink: Uri)
+
+    /**
+     * Navigate to a destination via the given deep link [Uri]. [NavDestination.hasDeepLink] should
+     * be called on [the navigation graph][graph] prior to calling this method to check if the deep
+     * link is valid. If an invalid deep link is given, an [IllegalArgumentException] will be
+     * thrown.
+     *
+     * @param deepLink deepLink to the destination reachable from the current NavGraph
+     * @param navOptions special options for this navigation operation
+     * @see NavController.navigate
+     */
+    @MainThread
+    public open fun navigate(deepLink: Uri, navOptions: NavOptions?)
+
+    /**
+     * Navigate to a destination via the given deep link [Uri]. [NavDestination.hasDeepLink] should
+     * be called on [the navigation graph][graph] prior to calling this method to check if the deep
+     * link is valid. If an invalid deep link is given, an [IllegalArgumentException] will be
+     * thrown.
+     *
+     * @param deepLink deepLink to the destination reachable from the current NavGraph
+     * @param navOptions special options for this navigation operation
+     * @param navigatorExtras extras to pass to the Navigator
+     * @see NavController.navigate
+     */
+    @MainThread
+    public open fun navigate(
+        deepLink: Uri,
+        navOptions: NavOptions?,
+        navigatorExtras: Navigator.Extras?
+    )
+
     /**
      * Navigate to a destination via the given [NavDeepLinkRequest]. [NavDestination.hasDeepLink]
      * should be called on [the navigation graph][graph] prior to calling this method to check if
@@ -516,6 +561,20 @@ public expect open class NavController {
      * than two visible entries
      */
     public open val previousBackStackEntry: NavBackStackEntry?
+
+    companion object {
+        /**
+         * By default, [handleDeepLink] will automatically add calls to
+         * [NavOptions.Builder.setPopUpTo] with a `saveState` of `true` when the deep link takes you
+         * to another graph (e.g., a different navigation graph than the one your start destination
+         * is in).
+         *
+         * You can disable this behavior by passing `false` for [saveState].
+         */
+        @JvmStatic
+        @NavDeepLinkSaveStateControl
+        public fun enableDeepLinkSaveState(saveState: Boolean)
+    }
 }
 
 /**