navigation3

API Reference
androidx.navigation3.runtime
androidx.navigation3.ui

Navigation 3 is a new navigation library designed to work with Compose.

Latest Update	Stable Release	Release Candidate	Beta Release	Alpha Release
October 22, 2025	-	-	1.0.0-beta01	-

Declaring dependencies

To add a dependency on navigation3, you must add the Google Maven repository to your project. Read Google's Maven repository for more information.

Add the dependencies for the artifacts you need in the build.gradle file for your app or module:

Groovy

dependencies {
    implementation "androidx.navigation3:navigation3-runtime:1.0.0-beta01"
    implementation "androidx.navigation3:navigation3-ui:1.0.0-beta01"
}

Kotlin

dependencies {
    implementation("androidx.navigation3:navigation3-runtime:1.0.0-beta01")
    implementation("androidx.navigation3:navigation3-ui:1.0.0-beta01")
}

For more information about dependencies, see Add build dependencies.

Feedback

Your feedback helps make Jetpack better. Let us know if you discover new issues or have ideas for improving this library. Please take a look at the existing issues in this library before you create a new one. You can add your vote to an existing issue by clicking the star button.

Create a new issue

See the Issue Tracker documentation for more information.

There are no release notes for this artifact.

Version 1.0

Version 1.0.0-beta01

October 22, 2025

androidx.navigation3:navigation3-*:1.0.0-beta01 is released. Version 1.0.0-beta01 contains these commits.

API Changes

SceneStrategyScope now only has a no argument public constructor, suitable for testing your SceneStrategy and the returned Scene in isolation. For more complex use cases, please use rememberSceneState(). (I8440c, b/451679047)

Bug Fixes

Fixed infinite loop when chaining SceneStrategy with then. (Iba3f0, b/450323470)
Fixed screen flicker when swapping the backStack passed to NavDisplay and using animations. (Ief7b5, b/450967248)

Version 1.0.0-alpha11

October 08, 2025

androidx.navigation3:navigation3-*:1.0.0-alpha11 is released. Version 1.0.0-alpha11 contains these commits.

API Changes

The calculateScene method on SceneStrategy is no longer @Composable. Instead, consider moving this work to the construction of your SceneStrategy method (i.e., in a rememberMySceneStrategy() method) that fully allows you to define the lifetime of any rememberSaveable values or key remember statements off of the correct values. (If1733, b/448709506)
The onBack parameter for SceneStrategy.calculateScene has been moved into the new receiver scope of SceneStrategyScope to make it more clear that this is an optional parameter and provide an extension point for future Navigation3 features. (I3aea3, b/448460407)
The onBack lambda passed into NavDisplay and to your SceneStrategy no longer provides a count: Int parameter to indicate when multiple entries should be popped. Instead, the () -> Unit lambda will now be called multiple times in a row in the rare case where your Scene requests popping multiple entries. (Idedb5, b/446989346)
Remove the NavEntryWrapper class and replace its functionality with a final NavEntry class with a new secondary constructor that takes a NavEntry with new content. This will allow continued support for wrapping an entry with new content. (I7da2a, b/444447130)
The navEntryDecorator function which creates and returns a NavEntryDecorator has been removed and replaced by the NavEntryDecorator class which is now made public and open for subclassing. (If81f8, b/444447434, b/447381176)
SavedStateNavEntryDecorator has been renamed to SaveableStateHolderNavEntryDecorator since it decorates entries with a SaveableStateHolder. The decorator has also been refactored from a function to a class since it is functionally a factory for NavEntryDecorator. (Ie6013, b/447381176)
Custom displays using SceneState as an alternative to using NavDisplay no longer are required to use the LocalEntriesToRenderInCurrentScene composition local, which is now internal. (Ic40ef, b/414668196)
Removed SceneSetupNavEntryDecorator and rememberSceneSetupNavEntryDecorator() from the public API surface. This functionality now is included by default without requiring you to manually include it. (Ieae42, b/444479133)
NavEntry, DialogScene, SinglePaneScene, and SceneState now all implement equals. (I96121)
Scene interface has a new metadata field to attach scene-specific metadata for NavDisplay. This allows a Scene to override the metadata on the NavDisplay, for instance with transitions. (I1fd96, b/443955625)
Simplify rememberNavBackStack signature by removing the redundant generic type parameter. The function now accepts vararg elements: NavKey. (I03e45)
The default animations for NavDisplay are now part of the common API which allows them to be called from all platforms. (I71af9, b/447147159)
Rename EntryProviderBuilder to EntryProviderScope to accurately reflect that the class is a Kotlin DSL providing a scope to build NavEntries. (Ia7465)

Bug Fixes

rememberNavBackStack() now enforces polymorphic serialization for NavKey and requires a custom SavedStateConfiguration that is configured to ensure correct state restoration. KDoc have been updated to reflect the requirement that all NavKey subtypes must be registered in the provided SerializersModule. (I6de37,I782f2, b/446664383)

Version 1.0.0-alpha10

September 24, 2025

androidx.navigation3:navigation3-*:1.0.0-alpha10 is released. Version 1.0.0-alpha10 contains these commits.

API Changes

Add new NavDisplay overload that takes a list of NavEntry<T> that has been decorated by rememberDecoratedNavEntries. (I4025b, b/441940314)
Moved DialogScene to a new package. (Ia5840)
Remove public API DecorateNavEntry. Instead use rememberDecoratedNavEntries to wrap a NavEntry with a list of decorators. (Id8c09)
Navigation3 UI now provides new default transitionSpec properties. (Ibcabd)
Added a new SceneState object to help manage scenes. This also provides a new NavDisplay overload that takes the SceneState and the NavigationEventState. (Idfb46, b/444479133)
NavDisplay now allows you to customize the transitions based on what Scene you are going to and from by looking at the Transition's currentState and targetState. (I906cc, b/443872322)
NavigationEventInfo is now an abstract class instead of an interface. Update all custom implementations to inherit from the class (e..g, data class MyInfo : NavigationEventInfo()). (I1e59c, b/444734264)
The navigationevent-compose handler APIs are updated. NavigationEventHandler and NavigationBackHandler (and variants) now support a new overload that accepts a hoisted NavigationEventStates. The simple overloads (taking currentInfo) are preserved and now use this new state model internally. (Ic3251, b/444734264)
All of the Scene APIs have been moved out of navigation3-ui to navigation3-runtime. This means they are now available on all platforms supported by navigation3-runtime. (I431d0, b/444449993)
Added new rememberDecoratedNavEntries overload that takes a list of NavEntry to decorate. The input entries can be already decorated with other entry decorators. (I5a034, b/444230270)
Remove navigation3 wildcard type parameters (I02540)
Improved the handling of generics for the entryProvider DSL. If you were previously importing androidx.navigation3.runtime.entry, this is no longer required. (I299fc)
Restrict the reflection-based NavBackStackSerializer overload to Android. This prevents implicit runtime serialization failures on non-Android platforms by enforcing the use of the explicit SavedStateConfiguration overload in multiplatform code. (I73313, b/420443609)
Make NavigationEvent's swipeEdge an @IntDef (Icee54, b/443950342)
Restrict NavBackStack serialization to Android. This prevents runtime failures on non-Android platforms. For multiplatform state saving, use the rememberNavBackStack overload with an explicit SavedStateConfiguration. (I1e418, b/420443609)

Bug Fixes

Fix crash during predictive back when nested NavDisplay has a single child entry. (I2cdc0, b/441933162)

Version 1.0.0-alpha09

September 10, 2025

androidx.navigation3:navigation3-*:1.0.0-alpha09 is released. Version 1.0.0-alpha09 contains these commits.

API Changes

The DecoratedNavEntryProvider has been replaced with rememberDecoratedNavEntries that creates and return NavEntries decorated with the list of provided decorators (I0fe1c, b/441328236)
NavBackStack is now generic over the NavKey type. This allows apps and libraries to define custom key types for their back stacks, rather than being restricted to NavKey. (I4d190,Iad2f4, b/420443609)
NavBackStack is now @kotlinx.serialization.Serializable, making it possible to save and restore navigation state across process death and configuration changes without extra boilerplate. (I2c3cf, b/420443609)
RememberNavBackStack has been moved to commonMain to ensure it is provided on all platform targets. (Id69e7, b/420443609)

Bug Fixes

NavDisplay now correctly moves each individual NavEntry to the correct Lifecycle.State. (I30aac, b/440145700)
Fixed an issue where NavDisplay would ignore any nested NavigationEventDispatcherOwner set via the NavigationEvent library's LocalNavigationEventDispatcherOwner. (I6224a)

Dependency Changes

Navigation3 now depends on NavigationEvent Alpha08.

Version 1.0.0-alpha08

August 27, 2025

androidx.navigation3:navigation3-*:1.0.0-alpha08 is released. Version 1.0.0-alpha08 contains these commits.

New Features

Added new Kotlin MultiPlatform (KMP) targets to Navigation3 Runtime artifacts. Navigation3 Runtime now supports the following platforms in total: JVM (Android and Desktop), Native (Linux, iOS, watchOS, macOS, MinGW), and Web (JavaScript, WasmJS). (I55078, b/424410398, b/419294028, b/419046226). Note: This does not provide KMP targets for Navigation3 UI artifact. On other platforms, you will need to implement your own custom NavDisplay. If you would like to see it supported, please vote on the Jetbrains issue here and track the progress for additional support there.
The NavDisplayInfo object is now public and can be used to retrieve the list of visible entries from the NavDisplay. (Ibc91f)

API Changes

Added a new NavBackStackSerializer to be used in conjunction with rememberNavBackStack to perform state restoration. rememberNavBackStack() now also takes a SavedStateConfiguration that can be used to provide your own configuration. (I2f4d2, I4cd58, b/420443609)

Bug Fixes

Fixed an issue where navigating would cause incorrect Lifecycle events to fire. (I8bf6d, b/425901162, b/434109022)

Known Issues

There was a bug introduced by I8bf6d that caused Lifecycles to be based on scenes instead of individual entries, which broke Lifecycle for any cases where the key provided to the NavEntry is not a String or your NavEntry has not overridden the contentKey and set it equal to the key (note that doing this enforces that your key can be saved into a Bundle). This has been fixed for the next release. (b/440145700)

Version 1.0.0-alpha07

August 13, 2025

androidx.navigation3:navigation3-*:1.0.0-alpha07 is released. Version 1.0.0-alpha07 contains these commits.

MinSdk Update

The default minSdk for the AndroidX has been moved from API 21 to API 23 (Ibdfca, b/380448311, b/435705964, b/435705223)

API Changes

SavedStateNavEntryDecorator now uses the SaveableStateRegistry built into SaveableStateProvider to save and restore states. (If8d9a)
The predictivePopTransitionSpec is now provided the swipe edge as a parameter, allowing you to customize the transition based on what edge the user started the Predictive Back gesture from. (I753a8)

Bug Fixes

Fixed an issue that would cause custom scenes to be infinitely recalculated because the most recent scene was not being remembered. (I7ba84, b/418153031)

Dependency update

Navigation3 now depends on Navigation Event 1.0.0-alpha06.

Version 1.0.0-alpha06

July 30, 2025

androidx.navigation3:navigation3-*:1.0.0-alpha06 is released. Version 1.0.0-alpha06 contains these commits.

Dependency Update

Navigation3 now depends on Navigation Event 1.0.0-alpha05.

Version 1.0.0-alpha05

July 2, 2025

androidx.navigation3:navigation3-*:1.0.0-alpha05 is released. Version 1.0.0-alpha05 contains these commits.

Behavior Changes

The NavEntry's state is now strictly based on the current list of decorators passed to the NavDisplay. This means that decorators should be swapped along your back stacks in the case of multiple back stacks in order to preserve the state of the NavEntries on the back stack. Otherwise, the states will be cleared as if the entries were popped (instead of a swap). (I7a759, b/428033667)

Version 1.0.0-alpha04

June 18, 2025

androidx.navigation3:navigation3-*:1.0.0-alpha04 is released. Version 1.0.0-alpha04 contains these commits.

API Changes

NavEntry.content is now private. To invoke NavEntry content, call the new NavEntry.Content() api which no longer requires a key parameter to invoke. (Icd0fd, b/420991203)
NavEntry.key is now a private field. The NavEntry and its relevant states should be identified by the new contentKey field which is generated from the new contentKeyFactory lambda and defaults to a saveable hash generated from NavEntry.key (I81a6c, b/422001357, b/420991203 I2d7d4, b/420991203, b/422841812)

Dependency Changes

Navigation3 now depends on the new androidx.navigationevent.compose artifact.

Version 1.0.0-alpha03

June 4, 2025

androidx.navigation3:navigation3-*:1.0.0-alpha03 is released. Version 1.0.0-alpha03 contains these commits.

Bug Fixes

Navigation3 will no longer clear decorator states for backStacks that have been swapped out and replaced with another backStack instance. (I28a42, b/415076044)

Version 1.0.0-alpha02

May 23, 2025

androidx.navigation3:navigation3-*:1.0.0-alpha02 is released. Version 1.0.0-alpha02 contains these commits.

Bug Fixes

Fixed an issue with the SavedStateNavEntryDecorator which caused collisions for different data classes with the same property values. (b/418070648, Iff4775)
Fixed a missing class issue that would cause crashes when running without declaring explicit dependencies. (b/419049149, I4b4ed)

Version 1.0.0-alpha01

May 20, 2025

androidx.navigation3:navigation3-*:1.0.0-alpha01 is released. Version 1.0.0-alpha01 contains these commits.

New Features

Navigation3 is a new navigation library built specifically to handle Jetpack Compose in-app navigation. The androidx.navigation3.runtime artifact provides the building blocks, while the androidx.navigation3.ui artifact provides the UI layer via the NavDisplay API. Developers can provide their own state directly to the NavDisplay composable function, which changes the content based on changes in the developer state.

@Serialiable object Home : NavKey
@Serialiable object Chat : NavKey

val backStack = rememberNavBackStack(Home)

NavDisplay(backStack, entryProvider = entryProvider {
  entry<Home> {
    Column {
      Text(“Home”)
      Button(onClick = { backStack.add(Chat) } ) {
        Text(“Go to Chat”)
      } 
    }
  }
  entry<Chat> { /* My Composable Content */ }
})

For more information, see the Navigation3 guide.