Skip to content

deonmenezes/mobile-app-skill / skills/navigation-3

navigation-3

Verified

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.

FileKindSize
SKILL.mdskill md6.5 KB
references/android/guide/navigation/navigation-3/index.mdmarkdown3.5 KB
references/android/guide/navigation/navigation-3/migration-guide.mdmarkdown26.5 KB
references/android/guide/navigation/navigation-3/recipes/animations.mdmarkdown6.4 KB
references/android/guide/navigation/navigation-3/recipes/basic.mdmarkdown3.5 KB
references/android/guide/navigation/navigation-3/recipes/basicdsl.mdmarkdown3.5 KB
references/android/guide/navigation/navigation-3/recipes/basicsaveable.mdmarkdown3.5 KB
references/android/guide/navigation/navigation-3/recipes/bottomsheet.mdmarkdown7.7 KB
references/android/guide/navigation/navigation-3/recipes/common-ui.mdmarkdown8.5 KB
references/android/guide/navigation/navigation-3/recipes/conditional-transitions.mdmarkdown8.4 KB
references/android/guide/navigation/navigation-3/recipes/conditional.mdmarkdown9.4 KB
references/android/guide/navigation/navigation-3/recipes/deeplinks-custommatcher.mdmarkdown7.1 KB
references/android/guide/navigation/navigation-3/recipes/deeplinks-staticuri.mdmarkdown5.5 KB
references/android/guide/navigation/navigation-3/recipes/deeplinks-syntheticbackstack.mdmarkdown7.7 KB
references/android/guide/navigation/navigation-3/recipes/deeplinks-uriarguments.mdmarkdown15.4 KB
references/android/guide/navigation/navigation-3/recipes/dialog.mdmarkdown4.4 KB
references/android/guide/navigation/navigation-3/recipes/lifecycle-owner.mdmarkdown8.2 KB
references/android/guide/navigation/navigation-3/recipes/material-listdetail.mdmarkdown6.4 KB
references/android/guide/navigation/navigation-3/recipes/material-supportingpane.mdmarkdown6.6 KB
references/android/guide/navigation/navigation-3/recipes/modular-hilt.mdmarkdown9.6 KB
references/android/guide/navigation/navigation-3/recipes/modular-koin.mdmarkdown10.3 KB
references/android/guide/navigation/navigation-3/recipes/multiple-backstacks.mdmarkdown16.8 KB
references/android/guide/navigation/navigation-3/recipes/passingarguments.mdmarkdown16.0 KB
references/android/guide/navigation/navigation-3/recipes/results-event.mdmarkdown9.8 KB
references/android/guide/navigation/navigation-3/recipes/results-state.mdmarkdown9.6 KB
references/android/guide/navigation/navigation-3/recipes/scenes-listdetail.mdmarkdown15.9 KB
references/android/guide/navigation/navigation-3/recipes/scenes-twopane.mdmarkdown9.1 KB
references/android/guide/navigation/type-safe-destinations.mdmarkdown4.1 KB

references/android/guide/navigation/navigation-3/recipes/basicdsl.md

View on GitHub
# Basic DSL Recipe

This recipe shows a basic example of how to use the Navigation 3 API with two screens, using the `entryProvider` DSL and a persistent back stack.

## How it works

This example is similar to the basic recipe, but with a few key differences:

1. **Persistent Back Stack** : It uses `rememberNavBackStack(RouteA)` to create and remember the back stack. This makes the back stack persistent across configuration changes (e.g., screen rotation). To use `rememberNavBackStack`, the navigation keys must be serializable, which is why `RouteA` and `RouteB` are annotated with `@Serializable` and implement the `NavKey` interface.

2. **`entryProvider` DSL** : Instead of a `when` statement, this example uses the `entryProvider` DSL to define the content for each route. The `entry<RouteType>` function is used to associate a route type with its composable content.

The navigation logic remains the same: to navigate from `RouteA` to `RouteB`, we add a `RouteB` instance to the back stack.
[![](https://developer.android.com/static/images/picto-icons/code.svg) Explore View the full recipe on GitHub.](https://github.com/android/nav3-recipes/tree/main/app/src/main/java/com/example/nav3recipes/basicdsl)

```
/*
 * Copyright 2025 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.example.nav3recipes.basicdsl

import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.compose.material3.Button
import androidx.compose.material3.Text
import androidx.lifecycle.compose.dropUnlessResumed
import androidx.navigation3.runtime.NavKey
import androidx.navigation3.runtime.entryProvider
import androidx.navigation3.runtime.rememberNavBackStack
import androidx.navigation3.ui.NavDisplay
import com.example.nav3recipes.content.ContentBlue
import com.example.nav3recipes.content.ContentGreen
import com.example.nav3recipes.ui.setEdgeToEdgeConfig
import kotlinx.serialization.Serializable

@Serializable
private data object RouteA : NavKey

@Serializable
private data class RouteB(val id: String) : NavKey

class BasicDslActivity : ComponentActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        setEdgeToEdgeConfig()
        super.onCreate(savedInstanceState)
        setContent {
            val backStack = rememberNavBackStack(RouteA)

            NavDisplay(
                backStack = backStack,
                onBack = { backStack.removeLastOrNull() },
                entryProvider = entryProvider {
                    entry<RouteA> {
                        ContentGreen("Welcome to Nav3") {
                            Button(onClick = dropUnlessResumed {
                                backStack.add(RouteB("123"))
                            }) {
                                Text("Click to navigate")
                            }
                        }
                    }
                    entry<RouteB> { key ->
                        ContentBlue("Route id: ${key.id} ")
                    }
                }
            )
        }
    }
}
```
slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack."Stars: 198kUpdated Claude CodeCodexVerifiedInstall
ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read.Stars: 194kUpdated Claude CodeCodexVerifiedInstall
ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report.Stars: 194kUpdated Claude CodeCodexVerifiedInstall
ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt.Stars: 194kUpdated Claude CodeCodexVerifiedInstall