Create a deep link for a destination

In Android, a deep link is a link that takes you directly to a specific destination within an app.

You can support two different types of deep links in your app: explicit and implicit. How you implement deep links varies depending on which graph type—XML or programmatic—your app uses.

Create an explicit deep link

An explicit deep link is a single instance of a deep link that uses a PendingIntent to take users to a specific location within your app. You might surface an explicit deep link as part of a notification or an app widget, for example.

When a user opens your app via an explicit deep link, the task back stack is cleared and replaced with the deep link destination. When nesting graphs, the start destination from each level of nesting—that is, the start destination from each <navigation> element in the hierarchy—is also added to the stack. This means that when a user presses the Back button from a deep link destination, they navigate back up the navigation stack just as though they entered your app from its entry point.

Programmatic graphs

If your navigation graph is defined programmatically (as is typical in Navigation Compose or the Kotlin DSL), we recommend using TaskStackBuilder to create the deep link PendingIntent.

val id = "exampleId"
val context = LocalContext.current
val deepLinkIntent = Intent(
    Intent.ACTION_VIEW,
    "https://www.example.com/profile/$id".toUri(),
    context,
    MyActivity::class.java
)

val pendingIntent: PendingIntent? = TaskStackBuilder.create(context).run {
    addNextIntentWithParentStack(deepLinkIntent)
    getPendingIntent(0, PendingIntent.FLAG_UPDATE_CURRENT)
}

XML graphs

You can use the NavDeepLinkBuilder class to construct a PendingIntent, as shown in the example below. Note that if the provided context is not an Activity, the constructor uses PackageManager.getLaunchIntentForPackage() as the default activity to launch, if available.

Kotlin

val pendingIntent = NavDeepLinkBuilder(context)
    .setGraph(R.navigation.nav_graph)
    .setDestination(R.id.android)
    .setArguments(args)
    .createPendingIntent()

Java

PendingIntent pendingIntent = new NavDeepLinkBuilder(context)
    .setGraph(R.navigation.nav_graph)
    .setDestination(R.id.android)
    .setArguments(args)
    .createPendingIntent();

By default, NavDeepLinkBuilder launches your explicit deep link into the default launch Activity that is declared in your app's manifest. If your NavHost is in another activity, you must specify its component name when creating the deep link builder:

Kotlin

val pendingIntent = NavDeepLinkBuilder(context)
    .setGraph(R.navigation.nav_graph)
    .setDestination(R.id.android)
    .setArguments(args)
    .setComponentName(DestinationActivity::class.java)
    .createPendingIntent()

Java

PendingIntent pendingIntent = new NavDeepLinkBuilder(context)
        .setGraph(R.navigation.nav_graph)
        .setDestination(R.id.android)
        .setArguments(args)
        .setComponentName(DestinationActivity.class)
        .createPendingIntent();

If you have a ComponentName, you can pass it directly to the builder:

Kotlin

val componentName = ...

val pendingIntent = NavDeepLinkBuilder(context)
    .setGraph(R.navigation.nav_graph)
    .setDestination(R.id.android)
    .setArguments(args)
    .setComponentName(componentName)
    .createPendingIntent()

Java

ComponentName componentName = ...;

PendingIntent pendingIntent = new NavDeepLinkBuilder(context)
        .setGraph(R.navigation.nav_graph)
        .setDestination(R.id.android)
        .setArguments(args)
        .setComponentName(componentName)
        .createPendingIntent();

If you have an existing NavController, you can also create a deep link by using NavController.createDeepLink().

Create an implicit deep link

An implicit deep link refers to a specific destination in an app. When the deep link is invoked—for example, when a user clicks a link—Android can then open your app to the corresponding destination.

Deep links can be matched by URI, intent actions, and MIME types. You can specify multiple match types for a single deep link, but note that URI argument matching is prioritized first, followed by action, and then MIME type.

Programmatic graphs

If you define your navigation graph programmatically (using Navigation Compose or the Kotlin DSL), you define deep links in code.

Compose

In Navigation Compose, you can define deep links as part of the composable() destination builder using the deepLinks parameter. It accepts a list of NavDeepLink objects, which you can create using the navDeepLink() function:

@Serializable
data class Profile(val id: String)

val uri = "https://www.example.com"

composable<Profile>(
  deepLinks = listOf(
    navDeepLink<Profile>(basePath = "$uri/profile")
  )
) { backStackEntry ->
  val profile: Profile = backStackEntry.toRoute()
  ProfileScreen(id = profile.id)
}

Kotlin DSL

When using the Kotlin DSL, you can define deep links using the deepLink() builder function within the destination block:

@Serializable
data class Profile(val id: String)

val uri = "https://www.example.com"

fragment<ProfileFragment, Profile> {
    deepLink<Profile>(basePath = "$uri/profile")
}

Add intent filters for programmatic graphs

Because programmatic navigation graphs are built at runtime, the Navigation component cannot automatically generate the matching <intent-filter> elements in your AndroidManifest.xml. Instead, you must manually add the appropriate <intent-filter> elements.

To enable the deep link in the preceding examples, add the following inside the corresponding <activity> element in your manifest:

<activity …>
  <intent-filter>
    ...
    <data android:scheme="https" android:host="www.example.com" />
  </intent-filter>
</activity>

XML graphs

To create an implicit deep link in an XML-based graph, you can define the <deepLink> element directly in the XML or use the Navigation Editor.

Here's an example deep link that contains a URI, an action, and a MIME type:

<fragment android:id="@+id/a"
          android:name="com.example.myapplication.FragmentA"
          tools:layout="@layout/a">
        <deepLink app:uri="www.example.com"
                app:action="proxy.php?url=https%3A%2F%2Fdeveloper.android.com%2Fguide%2Fnavigation%2Fdesign%2Fandroid.intent.action.MY_ACTION"
                app:mimeType="type/subtype"/>
</fragment>

You can also use the Navigation Editor to create an implicit deep link to a destination as follows:

  1. In the Design tab of the Navigation Editor, select the destination for the deep link.
  2. Click + in the Deep Links section of the Attributes panel.

  3. In the Add Deep Link dialog that appears, enter the info for your deep link.

    Note the following:

    • URIs without a scheme are assumed as either http or https. For example, www.google.com matches both http://www.google.com and https://www.google.com.
    • Path parameter placeholders in the form of {placeholder_name} match one or more characters. For example, http://www.example.com/users/{id} matches http://www.example.com/users/4. The Navigation component attempts to parse the placeholder values into appropriate types by matching placeholder names to the defined arguments that are defined for the deep link destination. If no argument with the same name is defined, a default String type is used for the argument value. You can use the .* wildcard to match 0 or more characters.
    • Query parameter placeholders can be used instead of or in conjunction with path parameters. For example, http://www.example.com/users/{id}?myarg={myarg} matches http://www.example.com/users/4?myarg=28.
    • Query parameter placeholders for variables defined with default or nullable values are not required to match. For example, http://www.example.com/users/{id}?arg1={arg1}&arg2={arg2} matches http://www.example.com/users/4?arg2=28 or http://www.example.com/users/4?arg1=7. This is not the case with path parameters. For example, http://www.example.com/users?arg1=7&arg2=28 does not match the above pattern because the required path parameter is not supplied.
    • Extraneous query parameters do not affect deep link URI matching. For example, http://www.example.com/users/{id} matches http://www.example.com/users/4?extraneousParam=7, even though extraneousParam is not defined in the URI pattern.

  4. (optional) Check Auto Verify to require Google to verify that you are the owner of the URI. For more information, see Verify Android App Links.

  5. Click Add. A link icon appears above the selected destination to indicate that destination has a deep link.

  6. Click the Code tab to toggle to the XML view. A nested <deepLink> element has been added to the destination:

    <deepLink app:uri="https://www.google.com" />

To enable implicit deep linking for XML-based graphs, you must also make additions to your app's manifest.xml file. Add a single <nav-graph> element to an activity that points to an existing navigation graph, as shown in the following example:

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.myapplication">

    <application ... >

        <activity name=".MainActivity" ...>
            ...

            <nav-graph android:value="@navigation/nav_graph" />

            ...

        </activity>
    </application>
</manifest>

When building your project, the Navigation component replaces the <nav-graph> element with generated <intent-filter> elements to match all of the deep links in the navigation graph.

Implicit deep links and the back stack

When triggering an implicit deep link, the state of the back stack depends on whether the implicit Intent was launched with the Intent.FLAG_ACTIVITY_NEW_TASK flag:

  • If the flag is set, the task back stack is cleared and replaced with the deep link destination. As with explicit deep linking, when nesting graphs, the start destination from each level of nesting—that is, the start destination from each <navigation> element in the hierarchy—is also added to the stack. This means that when a user presses the Back button from a deep link destination, they navigate back up the navigation stack just as though they entered your app from its entry point.
  • If the flag is not set, you remain on the task stack of the previous app where the implicit deep link was triggered. In this case, the Back button takes you back to the previous app, while the Up button starts your app's task on the hierarchical parent destination within your navigation graph.

Handle deep links

It is strongly recommended to always use the default launchMode of standard when using Navigation. When using standard launch mode, Navigation automatically handles deep links by calling handleDeepLink() to process any explicit or implicit deep links within the Intent. However, this does not happen automatically if the Activity is re-used when using an alternate launchMode such as singleTop. In this case, it is necessary to manually call handleDeepLink() in onNewIntent(), as shown in the following example:

Kotlin

override fun onNewIntent(intent: Intent?) {
    super.onNewIntent(intent)
    navController.handleDeepLink(intent)
}

Java

@Override
protected void onNewIntent(Intent intent) {
    super.onNewIntent(intent);
    navController.handleDeepLink(intent);
}