Generated banner for Navigation 3
Generated logo for Navigation 3

Navigation 3

Android (Google)OfficialCreated by Google LLCDistributed by Android (Google)

  • Skill
  • Tool integration
  • Software development
  • Apache-2.0
  • No issues found

From the author

Learn how to install and migrate to Jetpack Navigation 3, and how to implement features and patterns such as deep links, multiple backstacks, scenes (dialogs, bottom sheets, list-detail, two-pane, supporting pane), conditional navigation (such as logged-in navigation versus anonymous), returning results from flows, integration with Hilt, ViewModel, Kotlin, and view interoperability.
— the description by Google LLC

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill provides developers with the necessary documentation, migration steps, and code recipes to adopt Jetpack Navigation 3. It covers the core concepts of the library, including back stack management, adaptive layouts using Scenes, deep link handling, and integration with Hilt, ViewModel, and Material 3 Adaptive components. The resource is designed to help developers transition from Navigation 2 or implement new navigation flows with a focus on type-safe, Compose-first architecture.

What it does

  • Provides a step-by-step migration path from Navigation 2 to Navigation 3.
  • Explains how to define destinations, manage back stacks, and use NavDisplay.
  • Offers code recipes for common patterns like bottom sheets, dialogs, and adaptive layouts.
  • Demonstrates how to handle deep links, animations, and conditional navigation.
  • Shows integration with dependency injection frameworks like Hilt and Koin.
  • Details how to pass arguments to ViewModels and return results between screens.

When to use it

  • When you need to migrate an existing Android app from Navigation 2 to Navigation 3.
  • When building a new Android application using Jetpack Compose.
  • When implementing complex navigation patterns like multiple back stacks or adaptive list-detail views.
  • When you need to handle deep links or conditional navigation flows in a type-safe manner.

Advantages

  • Full control over the back stack and navigation state.
  • Native support for adaptive layouts and multi-pane displays.
  • Strongly typed navigation routes.
  • Simplified integration with Jetpack Compose and ViewModel.
  • Extensive library of code recipes for common UI and architectural patterns.

Usage examples

“How do I migrate my existing Android app from Navigation 2 to Navigation 3?”
The agent will guide you through the migration steps, including updating dependencies, replacing NavController with the new state management classes, and switching from NavHost to NavDisplay.
“Show me how to implement a list-detail layout using Navigation 3.”
The agent will provide the relevant code recipe for implementing adaptive list-detail scenes using the Navigation 3 Scenes API.
“How can I handle conditional navigation for an authentication flow?”
The agent will explain how to switch navigation flows based on conditions, such as checking user login status, using the conditional navigation recipe.
“How do I pass arguments to a ViewModel in Navigation 3?”
The agent will demonstrate how to pass navigation arguments to a ViewModel constructed using the viewModel() function.

Install

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/android/navigation-3/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip navigation-3.zip -d .agents/skills

Documentation by Google LLC


Migration guide

  • Navigation 2 to Navigation 3 migration guide: Step-by-step guide to migrate an Android application from Navigation 2 to Navigation 3, covering dependency updates, route changes, state management, and UI component replacements.

Requirements

Developer documentation

  • Navigation 3. Search documentation for more information on basics, saving and managing navigation state, modularizing navigation code, creating custom layouts using Scenes, animating between destinations, or applying logic or wrappers to destinations.

Recipes

Code examples showcasing common patterns.

Basic API usage
Common UI
  • Common UI: Demonstrates how to implement a common navigation UI pattern with a bottom navigation bar and multiple back stacks, where each tab in the navigation bar has its own navigation history.

Scenes
Use built-in Scenes
  • Dialog: Shows how to create a Dialog.

Create custom Scenes
  • BottomSheet: Shows how to create a BottomSheet destination.

  • List-Detail Scene: Demonstrates how to implement adaptive list-detail layouts using the Navigation 3 Scenes API.

  • Two pane Scene: Demonstrates how to implement adaptive two-pane layouts using the Navigation 3 Scenes API.

Material Adaptive
  • Material List-Detail: Demonstrates how to implement an adaptive list-detail layout using Material 3 Adaptive.

  • Material Supporting Pane: Demonstrates how to implement an adaptive supporting pane layout using Material 3 Adaptive.

Animations
  • Animations: Shows how to override the default animations for all destinations and a single destination.

  • Conditional Transitions: Shows how to implement conditional transition animations.

Common back stack behavior
  • Multiple back stacks: Shows how to create multiple top level routes, each with its own back stack. Top level routes are displayed in a navigation bar allowing users to switch between them. State is retained for each top level route, and the navigation state persists config changes and process death.

Conditional navigation
  • Conditional navigation: Switch to a different navigation flow when a condition is met. For example, for authentication or first-time user onboarding.

Lifecycle
Architecture
Working with ViewModel
Passing navigation arguments
  • Basic ViewModel : Navigation arguments are passed to a ViewModel constructed using viewModel()

Returning results

Files

references/android/guide/navigation/navigation-3/recipes/deeplinks-syntheticbackstack.md

This recipe demonstrates how to apply the principles of navigation in the context of deep links by managing a synthetic backStack and Task stacks.

Recipe Structure

This recipe simulates a real-world scenario where "App A" deep links into "App B".

"App A" is simulated by the module syntheticbackstack, which contains the SyntheticBackStackDeepLinkActivity that allows you to create a deeplink intent and trigger that in either the existing Task, or in a new Task.

"App B" is simulated by the module syntheticbackstackapp, which contains the SyntheticBackStackAppActivity that you deeplink into. That module shows you how to build a synthetic backStack and how to manage the Task stack properly in order to support both Back and Up buttons.

How to Use

Ensure both the main app and syntheticbackstackapp are installed on the emulator or connected device. Ensure that the installed syntheticbackstackapp supports the "www.nav3deeplink.com" link.

On the recipe's landing page, choose the filters and click the button to deep link. It should bring you to the Activity of syntheticbackstackapp.

How it Works

The recipe follows the deep link guideline summarized here.

To see behavior of Existing Task:

  1. Open deep link using current task

  2. On the device, swipe up to see all recent apps

  3. Notice that the new Activity is opened within the Nav3Recipes app

  4. Click back button to go back to the original Activity

  5. Repeat step 1

  6. Click the up button to go to parent screen

  7. On the device, swipe up to see all recent apps

  8. Notice that the new Activity is now opened within the Nav3SyntheticBackStack app

To see behavior of New Task:

  1. Open deep link using new task

  2. On the device, swipe up to see all recent apps

  3. Notice that the new Activity is opened within the Nav3SyntheticBackStack app

  4. Click Up or Back button to go to parent screen

Core implementation

The core helper functions for navigateUp and building synthetic backStack can be found here

Further Read

Check out the deep link guide for a comprehensive guide on Deep linking principles and how to apply them in Navigation 3. Image: untitled Explore View the full recipe on GitHub.

package com.example.nav3recipes.deeplink.handlerequests.syntheticbackstack

import android.content.Intent
import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.core.net.toUri
import androidx.lifecycle.compose.dropUnlessResumed
import com.example.nav3recipes.common.deeplink.EntryScreen
import com.example.nav3recipes.common.deeplink.LIST_FIRST_NAMES
import com.example.nav3recipes.common.deeplink.LIST_LOCATIONS
import com.example.nav3recipes.common.deeplink.MenuDropDown
import com.example.nav3recipes.common.deeplink.PaddedButton
import com.example.nav3recipes.common.deeplink.TextContent
import com.example.nav3recipes.ui.setEdgeToEdgeConfig

internal const val ADVANCED_PATH_BASE = "https://www.nav3deeplink.com"

/**
 * The recipe entry point that allows users to create a deep link and make a request with it.
 *
 * **HOW THIS RECIPE WORKS** This recipe simulates a real-world scenario where "App A" deep links
 * into "App B".
 *
 * "App A" is simulated by this current module `syntheticbackstack`, which
 * contains the [SyntheticBackStackDeepLinkActivity] that allows you to create a deeplink intent and
 * trigger that in either the existing Task, or in a new Task.
 *
 * "App B" is simulated by the module `syntheticbackstackapp`, which contains
 * the SyntheticBackStackAppActivity that you deeplink into. That module shows you how to build a synthetic backStack
 * and how to manage the Task stack properly in order to support both Back and Up buttons.
 *
 * See the [README](README.md) file of current module for more info on advanced deep linking.
 */
class SyntheticBackStackDeepLinkActivity: ComponentActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        setEdgeToEdgeConfig()
        super.onCreate(savedInstanceState)

        setContent {
            EntryScreen("Sandbox - Build Your Deeplink Intent") {
                val initFirstName = MENU_OPTIONS_FIRST_NAME.values.first().first()
                val initLocation = MENU_OPTIONS_LOCATION.values.last().first()
                val initTaskStack = MENU_OPTIONS_TASK_STACK.values.first().first()
                var firstName by remember { mutableStateOf(initFirstName) }
                var location by remember { mutableStateOf(initLocation) }
                var taskStack by remember { mutableStateOf(initTaskStack) }

                // select first name
                MenuDropDown(
                    menuOptions = MENU_OPTIONS_FIRST_NAME,
                ) { _, selected ->
                    firstName = selected
                }

                // select first name
                MenuDropDown(
                    menuOptions = MENU_OPTIONS_LOCATION,
                ) { _, selected ->
                    location = selected
                }

                // select current task stack or build new task stack
                MenuDropDown(
                    menuOptions = MENU_OPTIONS_TASK_STACK,
                ) { _, selected ->
                    taskStack = selected
                }

                // build final deeplink URL and Intent
                val finalUrl = "${ADVANCED_PATH_BASE}/user/$firstName/$location"

                // display Intent info
                val flagString = if (taskStack == TAG_NEW_TASK) {
                    "Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_CLEAR_TASK"
                } else "<none>"
                val intentString = """
                    | Final Intent:
                    | data = "$finalUrl"
                    | action = Intent.ACTION_VIEW
                    | flags = $flagString
                """.trimMargin()

                TextContent(intentString)

                // deeplink to target
                PaddedButton("Deeplink Away!", onClick = dropUnlessResumed {
                    val intent = Intent().apply {
                        data = finalUrl.toUri()
                        action = Intent.ACTION_VIEW
                        if (taskStack == TAG_NEW_TASK) {
                            flags = Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_CLEAR_TASK
                        }
                    }

                    startActivity(intent)
                })
            }
        }
    }
}

private const val TAG_FIRST_NAME = "firstName"
private const val TAG_LOCATION = "location"
private const val TAG_TASK_STACK = "Task stack"
private const val TAG_CURRENT_TASK = "Use Current Task Stack"
private const val TAG_NEW_TASK = "Start New Task Stack"

private val MENU_OPTIONS_FIRST_NAME = mapOf(
    TAG_FIRST_NAME to LIST_FIRST_NAMES
)

private val MENU_OPTIONS_LOCATION = mapOf(
    TAG_LOCATION to LIST_LOCATIONS
)

private val MENU_OPTIONS_TASK_STACK = mapOf(
    TAG_TASK_STACK to listOf(TAG_CURRENT_TASK, TAG_NEW_TASK),
)

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Security

No issues found by our static scan· No issues found

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
Google LLC
Publisher
Android (Google) (Official)
Distributed by
Android (Google)
Source
android/skills · navigation/navigation-3 · commit bf68e2d
Licence
Apache License 2.0 (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE.txt)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Google LLC or Android (Google).

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download navigation-3.zip