Navigation 3 - Code recipes

Jetpack Navigation 3 is a library for app navigation. This repository contains recipes for how to use its APIs to implement common navigation use cases. Each recipe introduces a single concept. Instead of making existing recipes more complex, there should be a new recipe for that particular concept.

Every Navigation 3 release will be an opportunity for patterns you see in recipes to "graduate" and become (optional) helpers in the library itself. Then we'll update the recipe to use that prebuilt helper, thus ensuring that the recipes continue to be a good way to approach these kinds of problems.

Recipes on the main branch use the latest (which may be an alpha or snapshot) version of Nav3. For recipes that use stable versions, check the releases page.

Recipes

These are the recipes and what they demonstrate.

Basic API usage

• Basic: Shows most basic API usage.
• Saveable back stack: As above, with a persistent back stack.
• Parcelable back stack: As above, but with a persistent back stack of Parcelable routes.
• Entry provider DSL: As above, using the entryProvider DSL.
• Lifecycle Owner: Shows how to observe and use LocalLifecycleOwner within entry content.

Deep links

Read the guide to deeplinking.

• Static Uri: Shows how to handle deep links with a static Uri using UriDeepLinkMatcher.
• Uri with Arguments: Shows how to handle deep link with uri arguments using UriDeepLinkMatcher.
• Synthetic BackStack: Shows how to deep link between apps with a synthetic back stack using DeepLinkMatcher.withBackStack and correct "Up" navigation behavior.
• Custom DeepLinkMatcher: Demonstrates how to create a custom DeepLinkMatcher to parse deep links from DeepLinkRequest extras.
• Uri with Non-Primitive Arguments: Demonstrates how to use a custom DeepLinkSerializer for URI deep link keys with non-primitive arguments.
• Composite DeepLink Filters: Demonstrates how to combine multiple DeepLinkMatcher.Filter instances using infix functions (and, or).
• DeepLinkKey: Demonstrates how to associate deep link URI patterns directly with navigation key definitions using a DeepLinkKey interface.

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: Shows how to create a custom, list-detail layout using a Scene and SceneStrategy (see video of UI behavior below).
• Two pane Scene: Shows how to create a custom, 2-pane layout.

Use Material Scenes

Examples showing how to use the layouts provided by the Compose Material3 Adaptive Navigation3 library

• List-Detail: Shows how to use a Material adaptive list-detail layout.
• Supporting Pane: Shows how to use a Material adaptive supporting pane layout.

Note: If you find a bug or have a feature request for Material3 Adaptive Scenes please file it here. Don't file an issue on this repository.

Scene Decorators

• Dialog Scene Decorator: Shows how to use a DialogSceneDecoratorStrategy to display a scene in a dialog.
• Responsive Navigation Scene Decorator: Demonstrates how to add UI elements such as top app bars and navigation bars or rails using the scene decorator API.

Animations

• Animations: Shows how to override the default animations for all destinations and a single destination.
• Conditional transitions: Demonstrates how to conditionally select slide transition directions based on pairs of initial and target navigation keys.

Common back stack behavior

• Common navigation UI: A common navigation toolbar where each item in the toolbar navigates to a top level destination.
• 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.

Architecture

• Hilt - Modularized navigation code: Demonstrates how to decouple navigation code into separate modules (uses Dagger/Hilt for DI).
• Koin - Modularized navigation code: Demonstrates how to decouple navigation code into separate modules (uses Koin for DI).
• Metro - Modularized navigation code: Demonstrates how to decouple navigation code into separate modules (uses Metro for DI).
• Dynamic feature navigation: Demonstrates how to integrate navigation code with Dynamic Feature Module.

Working with ViewModels

Passing navigation arguments

• Basic ViewModel: Navigation arguments are passed to a ViewModel constructed using viewModel()
• Hilt injected ViewModel: Navigation arguments are passed to a ViewModel constructed using hiltViewModel()
• Koin injected ViewModel: Navigation arguments are passed to a ViewModel constructed using koinViewModel()
• Metro injected ViewModel: Navigation arguments are passed to a ViewModel constructed using assistedMetroViewModel()

Sharing a ViewModel between screens

• Shared ViewModel: Demonstrates how to share a ViewModel between different screens (entries) in Navigation 3 using a custom NavEntryDecorator.

Retain

• Retain Values for Composables on the Back Stack: Demonstrates how to set up retain to persist values as their UI is hidden while on the back stack, and how to implement a custom NavEntryDecorator

Returning Results

• Returning Results as Events: Returning results as events to content in another NavEntry.
• Returning Results as State: Returning results as state stored in a CompositionLocal.
• Returning Results as Serializable State: Returning results as state that survives configuration changes and process death using Kotlin Serialization.

Interop

• Fragment and View Interop: Demonstrates how to use Fragment and Views in Navigation3.

Future recipes

The most upvoted recipe requests will be considered for implementation. Don't see your recipe? File a request for one here

Custom layout example

The following is a screen recording showing the navigation behavior of a custom, list-detail Scene.

Instructions

Clone this repository and open the root folder in Android Studio. Each recipe is contained in its own package with its own Activity.

Found an issue?

If the issue is directly related to this project, as in, it's reproducible without modifying this project's source code, then please file an issue on github. If you've found an issue with the Jetpack Navigation 3 library, please file an issue on the issue tracker.

Contributing

We'd love to accept your contributions. Please follow these instructions.

Compose Multiplatform Recipes

CMP recipes can be found here.

License

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

    https://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.