Navigation
androidx.navigation
androidx.navigation.compose
androidx.navigation.dynamicfeatures
androidx.navigation.dynamicfeatures.fragment
androidx.navigation.dynamicfeatures.fragment.ui
androidx.navigation.fragment
androidx.navigation.fragment.compose
androidx.navigation.testing
androidx.navigation.ui
| Latest Update | Stable Release | Release Candidate | Beta Release | Alpha Release |
|---|---|---|---|---|
| September 24, 2025 | 2.9.5 | - | - | - |
Declaring dependencies
To add a dependency on Navigation, 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
plugins { // Kotlin serialization plugin for type safe routes and navigation arguments id 'org.jetbrains.kotlin.plugin.serialization' version '2.0.21' } dependencies { def nav_version = "2.9.5" // Jetpack Compose Integration implementation "androidx.navigation:navigation-compose:$nav_version" // Views/Fragments Integration implementation "androidx.navigation:navigation-fragment:$nav_version" implementation "androidx.navigation:navigation-ui:$nav_version" // Feature module support for Fragments implementation "androidx.navigation:navigation-dynamic-features-fragment:$nav_version" // Testing Navigation androidTestImplementation "androidx.navigation:navigation-testing:$nav_version" // JSON serialization library, works with the Kotlin serialization plugin. implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:1.7.3" }
Kotlin
plugins { // Kotlin serialization plugin for type safe routes and navigation arguments kotlin("plugin.serialization") version "2.0.21" } dependencies { val nav_version = "2.9.5" // Jetpack Compose integration implementation("androidx.navigation:navigation-compose:$nav_version") // Views/Fragments integration implementation("androidx.navigation:navigation-fragment:$nav_version") implementation("androidx.navigation:navigation-ui:$nav_version") // Feature module support for Fragments implementation("androidx.navigation:navigation-dynamic-features-fragment:$nav_version") // Testing Navigation androidTestImplementation("androidx.navigation:navigation-testing:$nav_version") // JSON serialization library, works with the Kotlin serialization plugin implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.7.3") }
Safe Args
To add Safe Args
to your project, include the following classpath in your top level build.gradle file:
Groovy
buildscript { repositories { google() } dependencies { def nav_version = "2.9.5" classpath "androidx.navigation:navigation-safe-args-gradle-plugin:$nav_version" } }
Kotlin
buildscript { repositories { google() } dependencies { val nav_version = "2.9.5" classpath("androidx.navigation:navigation-safe-args-gradle-plugin:$nav_version") } }
You must also apply one of two available plugins.
To generate Java language code suitable for Java or mixed Java and Kotlin modules, add
this line to your app or module's build.gradle file:
Groovy
plugins { id 'androidx.navigation.safeargs' }
Kotlin
plugins { id("androidx.navigation.safeargs") }
Alternatively, to generate Kotlin code suitable for Kotlin-only modules add:
Groovy
plugins { id 'androidx.navigation.safeargs.kotlin' }
Kotlin
plugins { id("androidx.navigation.safeargs.kotlin") }
You must have android.useAndroidX=true in your
gradle.properties file as per
Migrating to AndroidX.
For information on using Kotlin extensions, see the ktx documentation.
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.
See the Issue Tracker documentation for more information.
Version 2.9
Version 2.9.5
September 24, 2025
androidx.navigation:navigation-*:2.9.5 is released. Version 2.9.5 contains these commits.
Bug Fixes
- Navigation Safe Args can now handle AGP 9.0’s support for builtin kotlin. (I1d9d76)
Dependency Update
- The Navigation Safe Args Plugin now depends on Android Gradle Plugin version 8.4.2. (b/431847270, I5932a)
Version 2.9.4
September 10, 2025
androidx.navigation:navigation-*:2.9.4 is released. Version 2.9.4 contains these commits.
Bug Fixes
- Prevent crash when a predictive back event is delivered mid-frame after the handler was disabled in a
NavHosttransition. (I5667c, b/384186542)
Version 2.9.3
July 30, 2025
androidx.navigation:navigation-*:2.9.3 is released. Version 2.9.3 contains these commits.
Bug Fixes
- Fixed an error in
NavControllerthat caused aConcurrentModificationExceptionwhen usingOnDestinationChangedListeners. (If7406, b/417784831) - Fixed an error when using
navigate(uri, navOptions,navigationExtras)where the extras were being ignored. (I67fb7, b/430336813)
Version 2.9.2
July 16, 2025
androidx.navigation:navigation-*:2.9.2 is released. Version 2.9.2 contains these commits.
Bug Fixes
- Fixed an issue with the entry not resuming when the dialog above the entry is dismissed (Idb20e, b/418746335)
- Fixed
MissingFieldExceptionerror when testingSavedStateHandlewith type safe routes while using customNavTypes. (I2f843, b/421002511)
Version 2.9.1
July 2, 2025
androidx.navigation:navigation-*:2.9.1 is released. Version 2.9.1 contains these commits.
Bug Fixes
- Fixed an issue that caused
NavEntriesthat were instantiated using single top to never go beyond CREATED in theirLifecycle.State. (I043ba, b/421095236)
Version 2.9.0
May 7, 2025
androidx.navigation:navigation-*:2.9.0 is released. Version 2.9.0 contains these commits.
Important changes since 2.8.0
- Navigation Safe Args actions are now generated with the
@CheckResultannotation to ensure they are used.
SupportingPane Interface
- Custom Navigators can now mark their destinations as implementing the
SupportingPaneinterface which indicates to theNavControllerthat these destinations will be shown alongside other destinations. By using this interface, multiple destinations can beRESUMEDat the same time, for instance.
Compose Kotlin Multiplatform
- Navigation now offers a new common
NavController.handleDeepLink()function that takes aNavDeepLinkRequestinstead of anIntent. This allows platforms other than Android to properly handle deep links. Thanks Konstantin Tskhovrebov! - Navigation now offers
NavUri, a new common parser function that is a compatible API for Android’s URI on other platforms. This makes it possible to create a URI in a platform agnostic way. Thanks Konstantin Tskhovrebov!
Type Safe functions
- The type safe APIs that were previously only accessible via
reifiedmethods i.e.,composable<YourScreen>now have non-reified versions that directly take aKClassinstance. - Navigation type safety now supports value classes as a route or as the argument type of a route.
Version 2.9.0-rc01
April 23, 2025
androidx.navigation:navigation-*:2.9.0-rc01 is released. Version 2.9.0-rc01 contains these commits.
Bug Fixes
- Removed all non-android platform targets from Jetpack Navigation as those targets do not actually work. Stubs for different platforms are now provided instead.(I2877d)
Version 2.9.0-beta01
April 9, 2025
androidx.navigation:navigation-*:2.9.0-beta01 is released. Version 2.9.0-beta01 contains these commits.
API Changes
- The common API of
parseStringAsNavUrihas been changed to aNavUrifactory function that takes a String. (I4db6e, b/403616316)
Dependency Updates
- This library now targets Kotlin 2.0 language level and requires KGP 2.0.0 or newer. (Idb6b5)
Version 2.9.0-alpha09
March 26, 2025
androidx.navigation:navigation-*:2.9.0-alpha09 is released. Version 2.9.0-alpha09 contains these commits.
New Features
- The
navigation-testingmodule now supports on desktop, linux, macOS and iOS in addition to android. (I2b770, b/398265336) NavTypeis now supported on desktop, linux, macOS and iOS in addition to android. (I297d8)
Version 2.9.0-alpha08
March 12, 2025
androidx.navigation:navigation-*:2.9.0-alpha08 is released. Version 2.9.0-alpha08 contains these commits.
Bug Fixes
- From Navigation
2.8.9: Fixed a regression found in Navigation 2.8.8 that required a deep link to match all of the fields of a deep link request or intent exactly in order to be considered a match. This caused deep links that contained partial field matches and did not have others to no longer work. (Ie5e36, b/399826566)
External Contribution
- New common parser function to create a
NavUri. Thanks Konstantin Tskhovrebov! (If0a6a)
Version 2.9.0-alpha07
February 26, 2025
androidx.navigation:navigation-*:2.9.0-alpha07 is released. Version 2.9.0-alpha07 contains these commits.
Bug Fixes
- Fixed an issue where attempting to
saveStatewith non-inclusive pop would result in a null savedState that could cause a crash on restoration. (I9f3e8, b/395091644) - From Navigation 2.8.8:
NavDeepLinkmatching has been fixed where a deeplink and a deeplink request have to match exactly on uri, action, and mime. Matching is no longer allowed if only one or two fields match. (I3b029, b/395712033) - From Navigation 2.8.8: Fixed a bug where routes with wildcard paths do not match with an added deeplink (I7ea92, b/389970341)
External Contribution
- Extract a navigation-common, navigation-runtime, and navigation-compose APIs to the common platform. Thanks Konstantin Tskhovrebov! (I1e626, Ica76f, Idf479)
Known Issues
- Due to the work to address b/395712033, deeplinks are incorrectly required to have all of the same fields as the deeplink request and/or the
Intent. Deeplinks should only be required to match the fields that they have, and the non-included fields should be ignored. This has been fixed for a later release as part of b/399826566.
Version 2.9.0-alpha06
February 12, 2025
androidx.navigation:navigation-*:2.9.0-alpha06 is released. Version 2.9.0-alpha06 contains these commits.
New Features
- Navigation Safe Args actions are now generated with the
@CheckResultannotation to ensure they are used. (I14d4c, b/356323084)
Bug Fixes
- Fixed an error in
NavControllerwhere the backStack states were incorrectly attempted to be restored into an array when they were saved into a list. (Idfb9b) - From Navigation
2.8.7: Navigation Safe Args now provides support for composable destinations. (I35320, b/362791955)
Version 2.9.0-alpha05
January 29, 2025
androidx.navigation:navigation-*:2.9.0-alpha05 is released. Version 2.9.0-alpha05 contains these commits.
Bug Fixes
- Fix an issue that caused an unexpected scale animation when using Navigation Compose. (I480f4, b/353294030)
- From Navigation
2.8.6:NavDestinationlabels provided through XML will be parsed viaNavType.getto ensure customNavTypelogic is respected. (I7ec2f, b/388100796) - From Navigation
2.8.6: When navigating to activity withdataPattern,ActivityNavigatorwill now try to encode the arg value with the argument'sNavType. (I16376, b/383616432) - From Navigation
2.8.5: Fixed an issue that caused an unexpected scale animation when using Navigation Compose and calling navigate in the same frame that the current animation is ending. (I26cb1, b/353294030)
Version 2.9.0-alpha04
December 11, 2024
androidx.navigation:navigation-*:2.9.0-alpha04 is released. Version 2.9.0-alpha04 contains these commits.
New Features
- The type safe APIs that were previously only accessible via
reifiedmethods i.e.,composable<YourScreen>now have non-reified versions that directly take aKClassinstance.(Ia7eed, Id2879, Ibf244, I17d79, Id09d2, I54696, Ia47be, I93281, Ic1bf0, Iba4ee, If56a5, Icf969, I67644, I6f788, b/382094941, b/366291612, b/381938808)
The table below provides the reified and KClass APIs.
| reified | KClass |
|---|---|
composable<TestClass> { } |
composable(TestClass::class) { } |
navigation<NestedGraph>(startDestination = TestClass::class) |
navigation(route = NestedGraph::class, startDestination = TestClass::class) |
dialog<TestClass> {} |
dialog(TestClass::class) {} |
navDeepLink<TestClass>(baseUri) |
navDeepLink(TestClass::class, baseUri) |
NavDeepLink.Builder.setUriPattern<TestClass>(baseUri) |
NavDeepLink.Builder.setUriPattern(TestClass::class, baseUri) |
NavDestinationBuilder.deepLink<TestDeepLink>(baseUri) { } |
NavDestinationBuilder.deepLink(TestDeepLink::class, baseUri) { } |
navController.getBackStackEntry<TestClass>() |
navController.getBackStackEntry(TestClass::class) |
navController.popBackStack<TestClass>(true) |
navController.popBackStack(TestClass::class, true) |
navController.clearBackStack<TestClass>() |
navController.clearBackStack(TestClass::class) |
NavOptions.setPopUpTo<TestClass>() |
NavOptions.setPopUpTo(TestClass::class) |
navOptions { popUpTo<TestClass> {...} } |
navOptions { popUpTo(TestClass::class) {...} } |
NavGraph.setStartDestination<TestClass>() |
NavGraph.setStartDestination(TestClass::class) |
NavGraph.findNode<TestClass>() |
NavGraph.findNode(TestClass::class) |
backStackEntry.toRoute<TestClass>() |
backStackEntry.toRoute(TestClass::class) |
savedStateHandle.toRoute<TestClass>() |
savedStateHandle.toRoute(TestClass::class) |
API Changes
- The kotlin-specific
NavGraph.setStartDestinationoverload for type safety is hidden from Java sources. (Ic640c, b/364634035)
Bug Fixes
- From Navigation
2.8.5: Fixed an issue whereNavHostcould throw an exception inside of thePredictiveBackHandlerif the back stack is popped down to 1 entry and a system back are triggered in the same frame. (I1a429, b/375343407) - From Navigation
2.8.5: FixedNavDestinationNullPointerExceptionwhen updating a graph'sstartDestination. (I99421, b/361560785)
External Contribution
- From Navigation
2.8.5: Navigation type safety now supportsList<Enum>as an argument type of a route without requiring any customNavType. Thanks Csaba Kozák! (GH-725, b/375559962)
Version 2.9.0-alpha03
November 13, 2024
androidx.navigation:navigation-*:2.9.0-alpha03 is released. Version 2.9.0-alpha03 contains these commits.
New Features
- Navigation type safety now supports value classes as a route or as the argument type of a route. (I9344a, b/374347483)
Bug Fixes
- Fixed a
ConcurrentModificationExceptionthat could occur when aLifecycleObserverattached to aNavBackStackEntrytriggers a change to the back stack when the hostLifecycleOwnersuch as the containing Activity or Fragment changes its lifecycle state. (Ia9494)
Version 2.9.0-alpha02
October 30, 2024
androidx.navigation:navigation-*:2.9.0-alpha02 is released. Version 2.9.0-alpha02 contains these commits.
External Contribution
- New common
NavController.handleDeepLink(request: NavDeepLinkRequest)method. Thanks Konstantin Tskhovrebov! (I3e228)
Version 2.9.0-alpha01
October 16, 2024
androidx.navigation:navigation-*:2.9.0-alpha01 is released. Version 2.9.0-alpha01 contains these commits.
New Features
- Custom Navigators can now mark their destinations as implementing the
SupportingPaneinterface which indicates to theNavControllerthat these destinations will be shown alongside other destinations. By using this interface, multiple destinations can beRESUMEDat the same time, for instance. (Id5559) - From Navigation
2.8.3: Added new lint checks for thenavigation-common,navigation-runtime, andnavigation-composemodules to help identify any type-safe routes that are not correctly annotated with@Serializable. This check is applied to allNavGraphBuilderandNavDeepLinkBuilderextension functions. (I4a259, I95402, Ie601a, Id8c6e, I28bda, b/362725816) - From Navigation
2.8.3: Added new lint checks for thenavigation-common,navigation-runtime, andnavigation-composemodules to help identify any type-safe routes with Enum arguments that are not correctly annotated with@Keep. This check is applied to allNavGraphBuilderandNavDeepLinkBuilderextension functions. (I4a259, I95402, Ie601a, Id8c6e, I2b46f, b/358687142)
Behavior Changes
- Attempting to use a
NavControllerthat has been previouslyDESTROYEDwill now cause anIllegalStateException. (I520da, b/369616172)
Bug Fixes
- Update Enum class not found exception to suggest using
@Keepannotation in case the Enum class gets erased in minified builds. (I90e79, b/358137294)
Known Issues
- There is an issue with the new lint rules that were added in
Navigation 2.8.*that cause anObsolete custom lint checkerror when attempting to run lint with Android Gradle Plugin 8.4+. (b/368070326, b/371463741)
Version 2.8
Version 2.8.9
March 12, 2025
androidx.navigation:navigation-*:2.8.9 is released. Version 2.8.9 contains these commits.
Bug Fixes
- Fixed a regression found in Navigation 2.8.8 that required a deep link to match all of the fields of a deep link request or intent exactly in order to be considered a match. This caused deep links that contained partial field matches and did not have others to no longer work. (Ie5e36, b/399826566)
Version 2.8.8
February 26, 2025
androidx.navigation:navigation-*:2.8.8 is released. Version 2.8.8 contains these commits.
Bug Fixes
- Fixed a bug where routes with wildcard paths do not match with an added deeplink. (I7ea92, b/389970341)
NavDeepLinkmatching has been fixed where a deeplink and a deeplink request have to match exactly on uri, action, and mime. Matching is no longer allowed if only one or two fields match. (I3227f, b/395712033)
Known Issues
- Due to the work to address b/395712033, deeplinks are incorrectly required to have all of the same fields as the deeplink request and/or the
Intent. Deeplinks should only be required to match the fields that they have, and the non-included fields should be ignored. This has been fixed for a later release as part of b/399826566.
Version 2.8.7
February 12, 2025
androidx.navigation:navigation-*:2.8.7 is released. Version 2.8.7 contains these commits.
Bug Fixes
- Navigation Safe Args now provides support for composable destinations. (I35320, b/362791955)
Version 2.8.6
January 29, 2025
androidx.navigation:navigation-*:2.8.6 is released. Version 2.8.6 contains these commits.
Bug Fixes
NavDestinationlabels provided through XML will be parsed viaNavType.getto ensure customNavTypelogic is respected. (Id366d, b/388100796)- When navigating to activity with
dataPattern,ActivityNavigatorwill now try to encode the arg value with the argument'sNavType. (I1a71d, b/383616432)
Version 2.8.5
December 11, 2024
androidx.navigation:navigation-*:2.8.5 is released. Version 2.8.5 contains these commits.
Bug Fixes
- Fixed an issue where
NavHostcould throw an exception inside of thePredictiveBackHandlerif the back stack is popped down to 1 entry and a system back are triggered in the same frame. (I1a429, b/375343407) - Fixed
NavDestinationNullPointerExceptionwhen updating a graph'sstartDestination. (I99421, b/361560785) - Fixed an issue that caused an unexpected scale animation when using Navigation Compose and calling navigate in the same frame that the current animation is ending. (I26cb1, b/353294030)
- Fixed a
ConcurrentModificationExceptionthat could occur when aLifecycleObserverattached to aNavBackStackEntrytriggers a change to the back stack when the hostLifecycleOwnersuch as the containing Activity or Fragment changes its lifecycle state. (Ia9494)
External Contribution
- Navigation type safety now supports
List<Enum>as an argument type of a route without requiring any customNavType. Thanks Csaba Kozák! (GH-725, b/375559962)
Version 2.8.4
November 13, 2024
androidx.navigation:navigation-*:2.8.4 is released. Version 2.8.4 contains these commits.
New Features
- From Navigation
2.9.0-alpha03: Navigation type safety now supports value class as route or as the argument type of a route (I9344a, b/374347483)
Bug Fixes
- From Navigation
2.9.0-alpha01: Attempting to use aNavControllerthat has been previouslyDESTROYEDwill now cause anIllegalStateException. (I520da, b/369616172)
Version 2.8.3
October 16, 2024
androidx.navigation:navigation-*:2.8.3 is released. Version 2.8.3 contains these commits.
New Features
- Added new lint checks for the
navigation-common,navigation-runtime, andnavigation-composemodules to help identify any type-safe routes that are not correctly annotated with@Serializable. This check is applied to allNavGraphBuilderandNavDeepLinkBuilderextension functions. (I4a259, I95402, Ie601a, Id8c6e, I28bda, b/362725816) - Added new lint checks for the
navigation-common,navigation-runtime, andnavigation-composemodules to help identify any type-safe routes with Enum arguments that are not correctly annotated with@Keep. This check is applied to allNavGraphBuilderandNavDeepLinkBuilderextension functions. (I4a259, I95402, Ie601a, Id8c6e, I2b46f, b/358687142)
Bug Fixes
- Fixed an issue where the new lint rules that were added in
Navigation 2.8.*would cause anObsolete custom lint checkerror when attempting to run lint with Android Gradle Plugin 8.4+. (I1be3d, b/368070326, b/371463741)
Known Issues
- Navigation lint will throw an Obsolete custom lint check error when attempting to run lint with Lint 16 (AGP 8.7) or higher. (b/371926651)
Version 2.8.2
October 2, 2024
androidx.navigation:navigation-*:2.8.2 is released. Version 2.8.2 contains these commits.
New Features
- Navigation Type Safety now supports Serializable classes that include a
Double,Double?,DoubleArray,DoubleArray?,List<Double>, andList<Double>?without requiring any customNavType. (I570eb, Ibc4c0, I37461, I5bed4, b/359245753)
Bug Fixes
- Improved the error message for when Navigation fails to map a route's argument to a
NavType, the new error message will contain the argument name, argument fully qualified name, and the route's fully qualified name. (Id8416, b/346264232)
Version 2.8.1
September 18, 2024
androidx.navigation:navigation-*:2.8.1 is released. Version 2.8.1 contains these commits.
New Features
- Added a new lint rule to ensure the use of the
popBackStackfunction that takes a reified class type when attempting topopBackStackusing type-safe APIs. (Ief161, b/358095343)
Bug Fixes
- Navigation now requires that the route passed to a
NavGraph'sstartDestinationcontains the values for all required arguments, which includes arguments that are non-nullable and have no default value. (I18e74, b/362594265) - Navigation safe args has added support for non-nullable strings such that "null" values will be parsed and stored into the bundle as is. This departs from existing behavior where "null" values are parsed into a null object. This change only applies to non-nullable String types. Nullable strings remain unchanged. (I08b4a, b/348936238)
- A
NavDestinationcan no longer be deeplinked into except through a deep link that was explicitly added to the destination. This also means that you can only navigate to a destination's route with the navigate function overload that takes a string route. This fixes a vulnerability that made it possible to deep link to a potentially protected destination. (Ie30e6)
Dependency Update
- Navigation Safe Args now depends on Kotlin 1.9.24, rather than Kotlin 2.X, ensuring that developers are not forced to update. (a4129a)
- Navigation Compose now depends on Compose
1.7.2.
Version 2.8.0
September 4, 2024
androidx.navigation:navigation-*:2.8.0 is released. Version 2.8.0 contains these commits.
Important changes since 2.7.0
Navigation Kotlin DSL Type-Safety
- Navigation now provides type-safety for the Kotlin DSL (used by Navigation Compose) using Kotlin Serialization to allow you to define destinations in your navigation graph via type safe objects and data classes:
// Define a home destination that doesn't take any arguments
@Serializable
object Home
// Define a profile destination that takes an ID
@Serializable
data class Profile(val id: String)
// Now define your NavHost using type safe objects
NavHost(navController, startDestination = Home) {
composable<Home> {
HomeScreen(onNavigateToProfile = { id ->
navController.navigate(Profile(id))
})
}
composable<Profile> { backStackEntry ->
val profile: Profile = backStackEntry.toRoute()
ProfileScreen(profile)
}
}
See the Navigation Compose meet Type Safety blog post for more information.
Navigation Compose Predictive Back
- Navigation Compose now provides support for Predictive in-app back via the new
SeekableTransitionStateAPIs from compose-animation. This allows you to use the back gesture to see the previous destination with your custom Transition before deciding to either commit the transaction via the completed gesture or cancel.
Navigation Fragment Composable
- Added a new
navigation-fragment-composeartifact that includes aComposableNavHostFragmentalternative toNavHostFragmentthat allows you to add composable destinations to your Navigation XML files. Eachcomposabledestination must be expressed as a top-level, no argument@Composablemethod whose fully qualified name is used as theandroid:nameattribute on each destination. When navigating to one of these destinations, a containing fragment is created to display the composable content.
// In HomeScreen.kt
@Composable
fun HomeScreen() {
// Your Composable content here
}
// In your navigation.xml
<composable
android:id="@+id/home_screen"
android:name="com.example.HomeScreenKt\$HomeScreen" />
Other Changes
- Navigation Compose now depends on Compose 1.7.0.
- Navigation now provides a new
CollectionNavType<T>class, a subclass ofNavType<T>for collection-based arguments such as list, arrays, maps. All of the defaultNavTypearrays (IntArrayType,LongArrayType,FloatArrayType,BoolArrayType, andStringArrayType) now inherit from this new class. NavTypenow has built-in support for Lists of Int, String, Boolean, Float, and Long.
Version 2.8.0-rc01
August 21, 2024
androidx.navigation:navigation-*:2.8.0-rc01 is released. Version 2.8.0-rc01 contains these commits.
Bug Fixes
- Fix navigation crash when passing in top level Enum classes as type safe arguments. (I0ba76, b/358137294)
- Navigation 2.8 now correctly works with SDK 34 and will not swap over to SDK 35 until the 2.9 release along with the rest of the AndroidX libraries. (b/358798728)
Version 2.8.0-beta07
August 7, 2024
androidx.navigation:navigation-*:2.8.0-beta07 is released. Version 2.8.0-beta07 contains these commits.
Known Issues
- Due to b/358137294, only Enums nested in another class are supported out of the box. Top level Enums will be supported in the next release.
Bug Fixes
- When navigating to duplicate or shared destinations, navigation will prioritize going to the closest matching destination from the current location in the graph. (Ic89a4, b/352006850)
- Navigation in safe args now has added a new
NavType.EnumType. This meansEnumtypes no longer require customNavTypes. Note that theEnum’sSerialNamemust be the default fully qualified name. (I66d22, b/346475493) - Navigation in safe args has added built-in support for nullable argument types including
Int?,Long?,Float?,Boolean?, andEnum<*>?. (I32d13,I1c580,Ifba66,I978b0,Ide076 , b/351994237) - The
NavGraph’sstartDestinationwill now use the default argument values if thestartDestinationroute passed to theNavGraphis exactly equal to thestartDestination.route. (I13762, b/354046047)
Version 2.8.0-beta06
July 24, 2024
androidx.navigation:navigation-*:2.8.0-beta06 is released. Version 2.8.0-beta06 contains these commits.
Bug Fixes
- Fixed an issue where the
WrongStartDestinationTypelint checks did not check for Companion objects on the passed in class type, causing lint to fail to detect the error. (I92b09)
Version 2.8.0-beta05
July 10, 2024
androidx.navigation:navigation-*:2.8.0-beta05 is released. Version 2.8.0-beta05 contains these commits.
Bug Fixes
- Fix
singleTopnavigation crash when nestedNavGraphsshare the samestartDestinationroute. (I17b94, b/294408596)
Version 2.8.0-beta04
June 26, 2024
androidx.navigation:navigation-*:2.8.0-beta04 is released. Version 2.8.0-beta04 contains these commits.
Bug Fixes
- Navigation now supports navigating with empty strings in path arguments. (Ic5dbd, b/339481310)
- Improve error message for custom serializers declared directly on class fields via
@Serializable(with =...)to clarify that this is currently an unsupported feature. (I052b0, b/341319151) SavedStateHandleFactorytest api can now be used in non-android tests but will require Robolectric to support argument parsing with Bundles. (I76cdc, b/340966212)- Fixed crash from restoring state when resuming the app after process death with using Type-Safe Navigation in Compose. (Ia8f38, b/341801005)
- Fixed an issue in Navigation Compose where after canceling the Predictive Back Gesture, the
NavBackStackEntrythat the user returns to never returns back to theRESUMEDLifecycle State. This also ensures the returning destination correctly animates back in instead of snapping into place after a fling. (I97a0c, b/346608857) - When using Predictive back with Navigation Compose, the destination being popped will now have the proper z-order, correctly animating on top of the incoming destination. (I2077b, b/345993681)
Version 2.8.0-beta03
June 12, 2024
androidx.navigation:navigation-*:2.8.0-beta03 is released. Version 2.8.0-beta03 contains these commits.
API Changes
CollectionNavTypehas a new abstractemptyCollection()method. Override this to handle an empty collection passed in as an argument. (Ie4d84, b/341723133)
Bug Fixes
- Added documentation on
NavType.serializeAsValueandserializeAsValuesto highlight that the final outputs should be Uri encoded. (Ida6bd, b/344943214) - Fixed crash when calling
toRoute<T>with a nullCollectionNavTypeargument. When navigating with a nullCollectionNavType, the output argument will be the default value declared on your Serializable class, or the return value ofemptyCollection()if there is no default value. (I84158, Id630f, b/342672856)
Version 2.8.0-beta02
May 29, 2024
androidx.navigation:navigation-*:2.8.0-beta02 is released. Version 2.8.0-beta02 contains these commits.
Bug Fixes
- Fixed
ClassCastExceptioncrash when usingNavBackStackEntry.toRoutewith a nullable customNavType. (I1c29b, b/342239473) - Fixed Navigation back stack state restoration issues caused when attempting to restore a back stack entry that is not reachable via id from the current destination. Since routes are backed by ids, destinations built with routes were also affected. This also fixes a crash caused by calling
clearBackStack()that had the same underlying issue. (I423c3, b/339908057)
Version 2.8.0-beta01
May 14, 2024
androidx.navigation:navigation-*:2.8.0-beta01 is released. Version 2.8.0-beta01 contains these commits.
API Changes
SavedStateHandle.toRoute()now takes in atypeMapparameter for custom argument types. (Ie39fb, b/339026523)- Added a test API to
navigation-testingto to create aSavedStateHandlefrom a Kotlin Serializable object. (Id4867, b/339080702)
Bug Fixes
- Missing parameter docs for Navigation Kotlin DSL functions have been added. (I26a36)
Version 2.8.0-alpha08
May 1, 2024
androidx.navigation:navigation-*:2.8.0-alpha08 is released. Version 2.8.0-alpha08 contains these commits.
Safe Args in Navigation Compose
- The work to support compile time type safety for Navigation Compose and users of the Navigation Kotlin DSL based on Kotlin Serialization has completed and previously experimental APIs are now stable. (Iea94d, I0eb0d, I873b7, I3a64b, I6c3a2, I11f0b, Ic3032, I8d394, I95710, Ice060, Id0e55, I45f8b, Idcdaf, If5380, I08b23, Ia5c59, b/188693139)
This functionality uses Kotlin Serialization to allow you to define destinations in your navigation graph via type safe objects and data classes:
// Define a home destination that doesn't take any arguments
@Serializable
object Home
// Define a profile destination that takes an ID
@Serializable
data class Profile(val id: String)
// Now define your NavHost using type safe objects
NavHost(navController, startDestination = Home) {
composable<Home> {
HomeScreen(onNavigateToProfile = { id ->
navController.navigate(Profile(id))
})
}
composable<Profile> { backStackEntry ->
val profile: Profile = backStackEntry.toRoute()
ProfileScreen(profile)
}
}
See the Navigation Compose meet Type Safety blog post for more information.
New Features
- The
navigation-fragment-composeartifact now provides aLocalFragmentcomposition local to composable methods within aComposableFragment. (If35e5) NavTypenow has built-in support for Lists of Int, String, Boolean, Float, and Long. (I4b6dd, Ia914c, b/188693139)
Version 2.8.0-alpha07
April 17, 2024
androidx.navigation:navigation-*:2.8.0-alpha07 is released. Version 2.8.0-alpha07 contains these commits.
New Features
Adds a new
navigation-fragment-composeartifact that includes aComposableNavHostFragmentalternative toNavHostFragmentthat allows you to addcomposabledestinations to your Navigation XML files. Eachcomposabledestination must be expressed as a top-level, no argument@Composablemethod whose fully qualified name is used as theandroid:nameattribute on each destination. When navigating to one of these destinations, a containing fragment is created to display the composable content. (I0ef2e, b/265480755)// In HomeScreen.kt @Composable fun HomeScreen() { // Your Composable content here }// In your navigation.xml <composable android:id="@+id/home_screen" android:name="com.example.HomeScreenKt\$HomeScreen" />
API Changes
- Support for Safe Args in Navigation Compose using an approach based on Kotlin Serialization continued. These APIs are not finished and are marked with the
ExperimentalSafeArgsApiannotation. This annotation will be removed when the entire API surface is complete in a future release. (Iefd95, I409c8, I5b5ac, I7e753, I960f8, I3eabd, I8ed5a, Ied2c9, I9b73c, I554db, Ib3aba, Ia668d, b/188693139)
Version 2.8.0-alpha06
April 3, 2024
androidx.navigation:navigation-*:2.8.0-alpha06 is released. Version 2.8.0-alpha06 contains these commits.
API Changes
- Support for Safe Args in Navigation Compose using an approach based on Kotlin Serialization has begun. These APIs are not finished and are marked with the
ExperimentalSafeArgsApiannotation. This annotation will be removed when the entire API surface is complete in a future release. (I644e7, I98896, I2a1c5, I43a51, I836a1, Ic5eec, I39407, I24e41, If9e14, Ibb13e, If44d3, Icb70f, I8972f, I1d432, Icf32b, I20a14, I262aa, I7de99, I35990, I1033d, b/188693139)
Bug Fixes
NavHostnow usedAlignment.TopStartas the default contentAlignment argument. This puts it in line with the default forAnimatedContentand fixes some instances of an unexpected scale from center transition. (I09e72, b/330111602)- When flicking the predictive back gesture while using Navigation Compose, the
NavHostwill now correctly complete the custom transition instead of immediately finishing. (I99017, b/327292110)
Version 2.8.0-alpha05
March 20, 2024
androidx.navigation:navigation-*:2.8.0-alpha05 is released. Version 2.8.0-alpha05 contains these commits.
New Features
- You can now pass arguments to
NavGraph'sstartDestinationdirectly in thestartDestinationroute without relying ondefaultValue. This applies to nestedNavGraphstartDestinationsas well. (I0e0b5, b/109505019, b/188693139)
API Changes
- Added new abstract
CollectionNavType<T>class, a subclass ofNavType<T>for collection-based arguments such as list, arrays, maps. (Ic6d63, b/188693139) - All of the default
NavTypearrays (IntArrayType,LongArrayType,FloatArrayType,BoolArrayType, andStringArrayType) are now of typeCollectionNavType(Idcf79, b/188693139) NavTypenow provides a new openvalueEqualsAPI that determines if two values of the same type are equal to one another. (I6cb97, b/327229511)
Bug Fixes
- Query parameters in deep links now allows values in the form of curly braces around argument name (i.e.
{argName}) as valid values for string-basedNavTypes. This fixes an issue where such a value would be considered invalid (or absence of value) for all types. (I18302, b/327274038) NavControllerfunctions that support routes such asnavigateorpopBackStackcan now properly match routes filled with arguments of ArrayNavTypes. (Iea805, b/327229511)
Version 2.8.0-alpha04
March 6, 2024
androidx.navigation:navigation-*:2.8.0-alpha04 is released. Version 2.8.0-alpha04 contains these commits.
New Features
- You can now specify the
SizeTranformfor your transitions in Navigation Compose by defining them as part of the initialization for thecomposableand/ornavigationfunctions. (I91062, b/296912651)
Bug Fixes
- Fixed an issue where
NavHostin Compose Navigation failed to properly show the transition when using System Back without a gesture. (Iceeae, b/325998468)
Version 2.8.0-alpha03
February 21, 2024
androidx.navigation:navigation-*:2.8.0-alpha03 is released. Version 2.8.0-alpha03 contains these commits.
API Changes
NavBackStackEntry.savedStateHandleis now marked as@MainThreadas it uses code that is required to be on the main thread anyway. (Ibb988, b/299523245)
Bug Fixes
- Fixed an issue in Navigation that caused
NavGraphViewModels to beDESTROYEDtoo soon because the associated entry’sViewModelwas not part of the saved state. (Ib6bb7, b/317581849)
Dependency Update
- Navigation Compose now depends on Compose 1.7.0-alpha03.
Version 2.8.0-alpha02
February 7, 2024
androidx.navigation:navigation-*:2.8.0-alpha02 is released. Version 2.8.0-alpha02 contains these commits.
New Features
- Navigation Compose now provides support for Predictive in-app back via the new
SeekableTransitionStateAPIs from compose-animation. This allows you to use the back gesture to see the previous destination with your custom Transition before deciding to either commit the transaction via the completed gesture or cancel. (I8b8e9)
Version 2.8.0-alpha01
January 24, 2024
androidx.navigation:navigation-*:2.8.0-alpha01 is released. Version 2.8.0-alpha01 contains these commits.
Bug Fixes
- Fixed
BackStackStateleak where multiplesaveStatecalls on a destination would result in multiple states to be saved, but only the first one could be restored. (I598b0, b/309559751) - Fixed an issue where non-String arguments would not be properly displayed when using the
NavigationUIhelpers to populate the title of app bars. (#636, b/316676794)
Dependency Update
- Navigation Compose now depends on Compose
1.7.0-alpha01fixing an issue that could cause an unexpected scale animation. (b/297258205)
External Contribution
- Thanks SimonMarquis for fixing the display issue for non-String arguments when using the
NavigationUIhelpers to populate the title of app bars.
Version 2.7.7
Version 2.7.7
February 7, 2024
androidx.navigation:navigation-*:2.7.7 is released. Version 2.7.7 contains these commits.
Bug Fixes
- Backported from Navigation
2.8.0-alpha01: FixedBackStackStateleak where multiplesaveState()calls on a singleNavBackStackEntrywould result in multiple states being saved, but only the first saved state could be restored. (I598b0, b/309559751) - Backported from Navigation
2.8.0-alpha01: Fixed an issue where non-String arguments would not be properly displayed when using theNavigationUIhelpers to populate the title of app bars. (#636, b/316676794)
External Contribution
- Thanks SimonMarquis for fixing the display issue for non-String arguments when using the
NavigationUIhelpers to populate the title of app bars.
Version 2.7.6
Version 2.7.6
December 13, 2023
androidx.navigation:navigation-*:2.7.6 is released. Version 2.7.6 contains these commits.
Bug Fixes
- The
NavGraphequals()function now correctly considers the nodes of the other graph instead of just the calling one. This will ensure that graphs that have nodes with different ids will no longer be considered equal (I401cb, b/311414915)
Version 2.7.5
Version 2.7.5
November 1, 2023
androidx.navigation:navigation-*:2.7.5 is released. Version 2.7.5 contains these commits.
Performance Improvements
- Greatly improved the performance (both in terms of time and number of allocations) of comparing two graphs. This means that calls such as
setGraphwhich internally compare the new graph to the existing one are much faster and result in fewer skipped frames. Thank you Michał Z for the thorough analysis that led to this improvement. (I6ad62) NavHostwill now render the start destination on the first composition pass instead of needing to wait for the second pass to read updated state. (I439a7, b/304852206)
Bug Fixes
- Fixed an issue where your back stack would be popped if you called
setGraphmore than once with the exact same graph only if there was a destination in your graph that contained an action linking two destinations. (Ieaed7) - Dialogs that were navigated to and dismissed in quick succession will no longer leak into the list of
NavController.visibleEntries. (I67586, b/287969970) - When an entry is popped followed by a configuration change, the entry's
ViewModelwill now be cleared properly ifsaveStateis false. (Idf242, b/298164648) - Fixed an issue where
NavControllercould handle the same deep link more than once if the back stack was entirely empty before a configuration change or call tosetGraphonly when the incoming Intent had theFLAG_ACTIVITY_NEW_TASKflag set. (I73c7f)
Dependency Updates
- Navigation with Fragments now depends on Fragment 1.6.2, fixing an issue where the
ViewModelinstances of nested fragments would not be cleared when callingclearBackStack.
Version 2.7.4
Version 2.7.4
October 4, 2023
androidx.navigation:navigation-*:2.7.4 is released. Version 2.7.4 contains these commits.
New Features
- Added support for
popUpToto use routes with arguments to allow popping back to a specific entry that uses those exact arguments, matching the support found inpopBackStack. (I731f4, b/299255572)
Bug Fixes
- Fix issue where interrupting a navigate with another navigate with
popUpTowill causeFragmentNavigatorto crash. (I3c848, b/301887045) - Fixed issue where system back press caused the
currentDestinationto not be updated correctly to match the displayed Fragment. (Id0d6c, b/289877514) DialogFragmentlifecycle will now properly move toRESUMEDstate when the dialog above it is dismissed. (I88f0d, b/301811387)
Version 2.7.3
Version 2.7.3
September 20, 2023
androidx.navigation:navigation-*:2.7.3 is released. Version 2.7.3 contains these commits.
Bug Fixes
- Fixed an issue in Navigation with Fragments that caused the
visibleEntrieslist to contain incorrect entries. (I5caa9, b/288520638) - Fixed an issue that caused Floating Window destination (i.e.
Dialogs,Bottomsheets, etc) to never get aRESUMEDLifecycle callback. (I3b866, b/287505132)
Version 2.7.2
Version 2.7.2
September 6, 2023
androidx.navigation:navigation-*:2.7.2 is released. Version 2.7.2 contains these commits.
Bug Fixes
- Navigation now depends on Lifecycle
2.6.2, fixing an interaction betweenrememberSaveableand Navigation Compose’sNavHostthat would cause therememberSaveablestate of destinations and anyViewModelownedSavedStateHandleinstances from being properly restored after process death and recreation. (b/298059596, b/289436035) - Fixed an issue when showing multiple dialogs in Navigation Compose simultaneously where the partially obscured dialogs (e.g., not the topmost dialog) would be in the
CREATEDLifecycle state rather than theSTARTEDstate. (aosp/2728520, b/289257213) - Fixed an issue when showing multiple dialogs in Navigation Compose simultaneously where dismissing the topmost dialog would cause the new topmost dialog to be stuck in the
STARTEDLifecycle state rather than correctly moving toRESUMED. (aosp/2629401, b/286371387) - Navigation Safe Args no longer instantiates its task eagerly if it is not actually being executed. (I0e385, b/260322841)
Dependency Update
- Navigation Compose now depends on Compose 1.5.1.
Version 2.7.1
Version 2.7.1
August 23, 2023
androidx.navigation:navigation-*:2.7.1 is released. Version 2.7.1 contains these commits.
Bug Fixes
- Fixed an issues in Navigation with Compose where when using a
Scaffoldit was possible to get an error for trying to access aLifecycle.State.DESTROYEDViewModel. (I1dc11, b/268422136)
Version 2.7.0
Version 2.7.0
August 9, 2023
androidx.navigation:navigation-*:2.7.0 is released. Version 2.7.0 contains these commits.
Important changes since 2.6.0
Animations from Accompanist
Now that AnimatedContent is stable, we were able to move the code from Accompanist Navigation Animation back into Navigation Compose itself.
This means all of the support for setting custom transitions that existed in AnimatedNavHost is directly supported in NavHost.
No additional changes will be made to Accompanist Navigation Animation and we’ll be formally deprecating it soon, along with guidance on how to migrate back to Navigation Compose itself, but it'll be the inverse of the migration guide with no other API changes required if you're already using the latest Accompanist alpha (0.31.2-alpha). (b/197140101)
Bug Fixes
- NavHost in Navigation Compose now correctly intercepts system back calls even after the Activity has been STOPPED and RESUMED. (Icb6de, b/279118447)
Dependency Updates
- Navigation now depends on Compose
1.5.0up from1.1.0.
Version 2.7.0-rc01
July 26, 2023
androidx.navigation:navigation-*:2.7.0-rc01 is released. Version 2.7.0-rc01 contains these commits.
Bug Fixes
- Fixed an issue where the
EnterTransitionandExitTransitionlambdas created as part of theNavHostcould potentially remain in memory even after theNavHostis removed from composition. (I893d0)
Known Issues
- There is an issue from Navigation 2.6.x that when navigating with popUpTo it is possible to cause an
IllegalArgumentException. It is possible that this exception can be avoided by restructuring your graph, similar to the advice suggested here. (b/287133013)
Version 2.7.0-beta02
June 28, 2023
androidx.navigation:navigation-*:2.7.0-beta02 is released. Version 2.7.0-beta02 contains these commits.
Bug Fixes
- Navigation Compose now has the right z-order for custom transitions that use navigate with the
popUpTooption.(/Ib1c3a, b/285153947)
Version 2.7.0-beta01
June 7, 2023
androidx.navigation:navigation-*:2.7.0-beta01 is released. Version 2.7.0-beta01 contains these commits.
Bug Fixes
NavHostin Navigation Compose now correctly intercepts system back calls even after theActivityhas beenSTOPPEDandRESUMED. (Icb6de, b/279118447)
Version 2.7.0-alpha01
May 24, 2023
androidx.navigation:navigation-*:2.7.0-alpha01 is released. Version 2.7.0-alpha01 contains these commits.
Animations from Accompanist
Now that AnimatedContent is stable, we were able to move the code from Accompanist Navigation Animation back into Navigation Compose itself.
This means all of the support for setting custom transitions that existed in AnimatedNavHost is directly supported in NavHost.
No additional changes will be made to Accompanist Navigation Animation and we’ll be formally deprecating it soon, along with guidance on how to migrate back to Navigation Compose itself, but it'll be the inverse of the migration guide with no other API changes required if you're already using the latest Accompanist alpha (0.31.2-alpha). (b/197140101)
Bug Fixes
- From Navigation
2.6.0-rc02: Fixed an issue with Navigation in Fragments where navigating withpopUpToand popping a fragment off the back stack without recreating its view would cause system back to stop working. (Ieb8d4, b/281726455)
Dependency Updates
- Navigation now depends on Compose
1.5.0-beta01.
Version 2.6.0
Version 2.6.0
June 7, 2023
androidx.navigation:navigation-*:2.6.0 is released. Version 2.6.0 contains these commits.
Important changes to Navigation since 2.5.0
NavBackStackEntry'sargumentsand theargumentspassed to anOnDestinationChangedListenerare now only a copy of the immutable arguments that were created when you navigated to the destination. This means any changes made to those Bundles will not be reflected in subsequent accesses to theargumentsor otherOnDestinationChangedListenerinstances.NavDeepLinknow supports default values for arrays, which allows support for repeated query params that will map to the argument's array type.NavTypealso now includes a default method which can be overridden to combine two parsed values.- Custom subclasses of
NavTypecan now overrideserializeAsValueto serialize a value into a String, allowing both serialization and deserialization (viaparseValue) to be entirely encapsulated in theNavTypeclass.StringTypenow overrides this method to callUri.encodeon the givenString.
Important changes to Navigation Compose since 2.5.0
- When previewing a composable with
NavHost, it will now show the NavGraph'sstartDestinationby default. NavController.popBackStack(route),NavController.getBackStackEntry(route),NavController.clearBackStack(route)now all support routes with arguments partially or fully filled in. Note that the arguments have to be an exact match with the entry's arguments.- Attempting to create an empty
NavDeepLinkusing thenavDeepLinkKotlin DSL will now result in a lint warning indicating that a deep link needs an uri, action, and/or mimetype to be valid.
Important changes to Navigation with Fragments since 2.5.0
NavHostFragmentno longer intercepts the system back button itself. This allows the underlyingFragmentManagerto handle system back. This allows Fragment1.7.0-alpha01and higher to provide an In-App Predictive Back animation on Android U devices.- When using Navigation with Fragments, attempting to manually do a
FragmentTransactionthat adds a fragment to theFragmentManager's back stack will now throw anIllegalArgumentException. You should always add fragments via thenavigate()API. - When using the exact string
${applicationId}as the placeholder in theapp:dataandapp:dataPatternattributes in the activity element of a navigation XML file, the placeholder will be automatically filled in with thepackageNameof the context upon inflation. - The
FragmentNavigatornow uses the transition APIs when navigating and poppingNavBackStackEntries. This means that theNavBackStackEntryLifecyclewill now wait for the entering and exiting fragment special effects to complete before moving their finalLifecycle.State. - The
DialogFragmentNavigatornow uses the transition APIs when navigating and poppingNavBackStackEntries. This means that theNavBackStackEntryLifecyclewill now wait for theDialogFragmentLifecycleto move toDESTROYEDbefore moving toDESTROYEDitself. NavHostFragmentnow allows you to retrieve theNavControlleras soon as theNavHostFragmentis attached to theFragmentManager, rather than only afteronCreate().- Navigation's support for Dynamic Feature Modules now depend on the granular Play Feature Delivery Library.
- Navigation Safe Args now depends on Android Gradle Plugin version 7.3.0. This means it is now only compatible with versions 7.3.0+.
Important changes to NavigationUI since 2.5.0
- When passing the ID of a navigation graph to
AppBarConfiguration(such as via aMenu),NavigationUInow only considers the start destination of that navigation graph as a top level destination, rather than incorrectly marking every destination within the graph as a top level destination. The behavior of passing the ID of an individual destination is unchanged. This same functionality is available to your own code via the newisTopLevelDestinationfunction onAppBarConfiguration. - The
setupWithNavControllerintegrations inNavigationUIfor working with the top app bar will now parseR.stringvalues forReferenceTypearguments found in yourandroid:labelinto their String values instead of outputting the auto-generated resource integer. NavigationUInow provides logs when it fails to navigate via a selectedMenuItem.
Version 2.6.0-rc02
May 24, 2023
androidx.navigation:navigation-*:2.6.0-rc02 is released. Version 2.6.0-rc02 contains these commits.
Bug Fixes
- Fixed an issue with Navigation in Fragments where navigating with
popUpToand popping a fragment off the back stack without recreating its view would cause system back to stop working. (Ieb8d4, b/281726455)
Version 2.6.0-rc01
May 10, 2023
androidx.navigation:navigation-*:2.6.0-rc01 is released. Version 2.6.0-rc01 contains these commits.
Bug Fixes
- Fixed an issue in Navigation with fragments where removing a fragment via navigate with
popUpToin itsonResume()lifecycle callback would cause anIllegalStateException. (I21884, b/279644470)
Version 2.6.0-beta01
April 19, 2023
androidx.navigation:navigation-*:2.6.0-beta01 is released. Version 2.6.0-beta01 contains these commits.
New Features
NavBackStackEntrynow provides a customtoStringimplementation. (Iff00b)
Bug Fixes
- When using Navigation with Fragments, attempting to manually do a
FragmentTransactionthat adds a fragment to theFragmentManager's back stack will now throw anIllegalArgumentException. You should always add fragments via thenavigate()API. (I6d38e) - When there is a
navigatethat adds an entry and apopBackStackthat removes it in the same frame, the resulting top entry on the back stack will now consistently make it back to theRESUMEDLifecycle.State. (Id8067, b/276495952)
Version 2.6.0-alpha09
April 5, 2023
androidx.navigation:navigation-*:2.6.0-alpha09 is released. Version 2.6.0-alpha09 contains these commits.
Bug Fixes
- Fixed checks for invalid route such that if a
NavDestinationcontains non-nullableNavArgument, this destination's route must contain placeholders for args named the same as the non-nullableNavArgument. (Ic62bf, b/274697949) - Deeplink navigations based on
Action/MimeTypewill now fail if the navigation operation is missing a non-nullableNavArgumentrequired by theNavDestinationthat theAction/MimeTypematches with. (Ibfa17, b/271777424) - When
NavControllersets a graph with the same route and destinations as the previous graph, it now properly replaces its current graph nodes and its back stack destinations with new instances. This fixes a crash when usingonLaunchSingleTopwithout saving state in Navigation Compose. This also fixes an error where navigating to destinations associated with the root graph builds and incorrect back stack. (I5bc58, b/275258161, b/275407804)
Version 2.6.0-alpha08
March 22, 2023
androidx.navigation:navigation-*:2.6.0-alpha08 is released. Version 2.6.0-alpha08 contains these commits.
New Features
NavHostFragmentnow allows you to retrieve theNavControlleras soon as theNavHostFragmentis attached to theFragmentManager, rather than only afteronCreate(). (Ic6382, b/220186282)
Bug Fixes
- Fixed a
NullPointerExceptionwhen popping a nested graph that includes a non-nullable argument. (6b3581, b/249988437) - When using system back after doing a navigate with
popUpTo, the state of theNavControllerwill pop to the correct entry. (I3a8ec, b/270447657) FragmentNavigatorwill now properly pop entries when the back stack is popped via system back orpopBackStack()and whether or not the transaction uses effects for the fragment. (I81bdf)- Adding fragments to the
FragmentNavigator'sFragmentManagerwithout using navigation will no longer cause a crash. (b17204, b/274167493)
Dependency Updates
- Navigation now depends on Lifecycle
2.6.1. (586fe7) - Navigation now depends on SavedState
1.2.1. (078e4e) - Navigation now depends on ProfileInstaller
1.3.0. (512f0c)
Version 2.6.0-alpha07
March 8, 2023
androidx.navigation:navigation-*:2.6.0-alpha07 is released. Version 2.6.0-alpha07 contains these commits.
Bug Fixes
- The
getBackStackEntry,popBackStack,clearBackStackAPI variants that take routes now take route patterns with nullable arguments and nullable query params (I22294, b/269302500) - Fixed an issue where calling
clearBackStack()from theNavControllerwould not clear the saved state in the fragment manager associated with the cleared back stack. (Ic1cce, b/271190202) - Fixed a regression in 2.6.0-alpha06 that caused the wrong
MenuItemin theBottomNavigationViewto be highlighted when using System back between tabs. (I634f6, b/270447657) - Fixed regression in 2.6.0-alpha06 that caused
NavBackStackEntrys not to be moved to the RESUMED state when usingAnimations. (Ib3589, b/269646882)
Version 2.6.0-alpha06
February 22, 2023
androidx.navigation:navigation-*:2.6.0-alpha06 is released. Version 2.6.0-alpha06 contains these commits.
New features
- When previewing a composable with
NavHost, it will now show the NavGraph'sstartDestinationby default. (I2b89f)
API Changes
- All
NavControllernavigateoverloads are now annotated with@MainThreadto ensure that they are called on the main thread. (I2c0b0, b/263427111)
Bug Fixes
- Fixed a crash when attempting to navigate while using Dynamic Fragment Navigation. (I3ee29, b/268360479)
- Fixed bug where navigating to another fragment via system back button does not update bottom bar to the correct selected item (If559f, b/269044426)
Known Issues
- When using Navigation with Fragments, the
NavBackStackEntry's Lifecycle fails to reachRESUMEDwhen usingAnimationAPIs. (b/269646882) - When using Navigation with Fragments, and navigating with
BottomNavigation, if you attempt to restore a back stack with multiple entries, theBottomMenuItemis not correctly updated. (b/270447657) - When using Navigation with Fragments, after restoring the state the
NavBackStackEntryLifecycledoes not getDESTROYEDwhen its fragment isDESTROYED. (b/270610768)
Version 2.6.0-alpha05
February 8, 2023
androidx.navigation:navigation-*:2.6.0-alpha05 is released. Version 2.6.0-alpha05 contains these commits.
New Features
NavController.popBackStack(route),NavController.getBackStackEntry(route),NavController.clearBackStack(route)now all support routes with arguments partially or fully filled in. Note that the arguments have to be an exact match with the entry's arguments. (Iebd28, Ic678c, I3b37b, b/257514373)- The
FragmentNavigatornow uses the transition APIs when navigating and poppingNavBackStackEntries. This means that theNavBackStackEntryLifecyclewill now wait for the entering and exiting fragment special effects to complete before moving their finalLifecycle.State. (I3cb19, b/238686802) - The
DialogFragmentNavigatornow uses the transition APIs when navigating and poppingNavBackStackEntries. This means that theNavBackStackEntryLifecyclewill now wait for theDialogFragmentLifecycleto move toDESTROYEDbefore moving toDESTROYEDitself. (I53ee5, b/261213893)
API Changes
NavigatorStatenow provides theprepareForTransitionAPI to allowNavigators to moveNavBackStackEntriesto intermediateLifecycle.States. (I42c21, b/238686802)- You can now access the back stack associated with a
NavGraphNavigatoror aComposeNavigatorvia abackstackproperty.ComposeNavigatoralso now exposes theonTransitionComplete()callback to mark aNavBackStackEntrythat has executed a navigate orpopBackStackoperation as complete. (I02062, I718db, b/257519195)
Bug Fixes
- Navigator state will now no-op when using the
push/popWithTransitionAPIs and the entry is already being handled. (Iadbfa, b/261213893) - When using
launchSingleTopwith a nestedNavGraphall destinations starting from original destination to itsstartDestinationwill only be properly added to the top of the backstack. (Id4bea, b/253256629) - Navigation will now properly replace the
DialogFragmentinstance when navigating to the same destination with thelaunchSingleTopflag set to true. (I45b5a, b/149572817) - Navigation SafeArgs will no longer cause a compilation error when using arguments that are exactly 19 characters long. (Id60bc, b/257110095)
Version 2.6.0-alpha04
November 9, 2022
androidx.navigation:navigation-*:2.6.0-alpha04 is released. Version 2.6.0-alpha04 contains these commits.
New Features
- Custom subclasses of
NavTypecan now overrideserializeAsValueto serialize a value into a String, allowing both serialization and deserialization (viaparseValue) to be entirely encapsulated in theNavTypeclass.StringTypenow overrides this method to callUri.encodeon the givenString. (Ie5213, b/247637434) NavigationUInow provides logs when it fails to navigate via a selectedMenuItem. (I2af5a, b/247730357)
Bug Fixes
- Navigation deep links are now parsed lazily instead of on graph initialization which could improve app performance at start up. (Iab0ab)
- Fixed crash caused by navigating up after deep linking to a destination with null default arguments. (I51c24, b/243183636)
Dependency Update
- Navigation's support for Dynamic Feature Modules now depend on the granular Play Feature Delivery Library. (Ib4ddc)
- Navigation Safe Args now depends on Android Gradle Plugin version 7.3.0. This means it is now only compatible with versions 7.3.0+. (I47e49)
Version 2.6.0-alpha03
October 24, 2022
androidx.navigation:navigation-*:2.6.0-alpha03 is released. Version 2.6.0-alpha03 contains these commits.
Bug Fixes
- From Navigation
2.5.3:NavHostwill no longer cause aNoSuchElementExceptionwhen there is no destination available for theCrossfadeto compose. It will now just skip the composition. (Ieb46e, b/253299416) - From Navigation
2.5.3: Fixed an issue where saved Compose state (e.g., usages ofrememberSaveable) were not being forgotten and removed when a destination was popped off the back stack. (I64949)
Dependency Updates
- Navigation now depends on Fragment
1.5.4. (Icd424)
Version 2.6.0-alpha02
October 5, 2022
androidx.navigation:navigation-*:2.6.0-alpha02 is released. Version 2.6.0-alpha02 contains these commits.
Behavior Changes
- When passing the ID of a navigation graph to
AppBarConfiguration(such as via aMenu),NavigationUInow only considers the start destination of that navigation graph as a top level destination, rather than incorrectly marking every destination within the graph as a top level destination. The behavior of passing the ID of an individual destination is unchanged. This same functionality is available to your own code via the newisTopLevelDestinationfunction onAppBarConfiguration. (Ie936e, b/238496771)
Bug Fixes
- The
navigation:navigation-fragmentcomponent now depends on Fragment version1.5.2. (I00ba4) - The selected menu item will no longer be updated when navigating to a
FloatingWindowdestination such as a dialog. (I4cde8, b/240308330)
Version 2.6.0-alpha01
September 7, 2022
androidx.navigation:navigation-*:2.6.0-alpha01 is released. Version 2.6.0-alpha01 contains these commits.
New Features
- The
setupWithNavControllerintegrations inNavigationUIfor working with the top app bar will now parseR.stringvalues forReferenceTypearguments found in yourandroid:labelinto their String values instead of outputting the auto-generated resource integer. (I5f803, b/167959935) NavDeepLinknow supports default values for arrays, which allows support for repeated query params that will map to the argument's array type.NavTypealso now includes a default method which can be overridden to combine two parsed values. (Id68c3, b/209977108)- When using the exact string
${applicationId}as the placeholder in theapp:dataandapp:dataPatternattributes in the activity element of a navigation XML file, the placeholder will be automatically filled in with thepackageNameof the context upon inflation. (Iaabde, b/234223561) - Attempting to create an empty
NavDeepLinkusing thenavDeepLinkKotlin DSL will now result in a lint warning indicating that a deep link needs an uri, action, and/or mimetype to be valid. (I08d2f, b/154038883)
API Changes
- Added new
NavDestinationextension function to parse dynamic labels with arguments in the form ofandroid:label="{arg}"into String. SupportsReferenceTypearguments by parsingR.stringvalues into their String values. (I07d89, b/236269380)
Behavior Changes
- NavBackStackEntry's
argumentsand theargumentspassed to anOnDestinationChangedListenerare now only a copy of the immutable arguments that were created when you navigated to the destination. This means any changes made to those Bundles will not be reflected in subsequent accesses to theargumentsor otherOnDestinationChangedListenerinstances. (I676f5)
Bug Fixes
- From Navigation
2.5.2: Dynamic Navigation now properly attempts to install Activity destinations from other modules before navigating to them. (Ia2c16, b/240292838) - From Navigation
2.5.2: Navigation will now properly replace the Fragment instance when navigating to the same destination and setting thelaunchSingleTopflag to true. (I5a2f1, b/237374580) - From Navigation
2.5.2: FixedIllegalStateExceptioncaused by navigating to a double nested graph that shares a parent with a new popped start destination. (I9f7cb, b/243778589)
Version 2.5
Version 2.5.3
October 24, 2022
androidx.navigation:navigation-*:2.5.3 is released. Version 2.5.3 contains these commits.
Bug Fixes
NavHostwill no longer cause aNoSuchElementExceptionwhen there is no destination available for theCrossfadeto compose. It will now just skip the composition. (Ieb46e, b/253299416)- Fixed an issue where saved Compose state (e.g., usages of
rememberSaveable) were not being forgotten and removed when a destination was popped off the back stack. (I64949)
Version 2.5.2
September 7, 2022
androidx.navigation:navigation-*:2.5.2 is released. Version 2.5.2 contains these commits.
Bug Fixes
- Dynamic Navigation now properly attempts to install Activity destinations from other modules before navigating to them. (Ia2c16, b/240292838)
- Navigation will now properly replace the Fragment instance when navigating to the same destination and setting the
launchSingleTopflag to true. (I5a2f1, b/237374580) - Fixed
IllegalStateExceptioncaused by navigating to a double nested graph that shares a parent with a new popped start destination. (I9f7cb, b/243778589)
Dependency Update
- Navigation
2.5.2now depends on Fragment1.5.2. (aosp/2178734)
Version 2.5.1
July 27, 2022
androidx.navigation:navigation-*:2.5.1 is released. Version 2.5.1 contains these commits.
Bug Fixes
Navigation Safe Argswill no longer cause deprecation warnings in generated classes when using custom argument types that are saved in aBundle. (Id86ed, b/237725966)
Dependency Updates
- The Navigation library now depends on Lifecycle
2.5.1. (Ib4451) - The Navigation library now depends on Activity
1.5.1. (I3efe8) - The Navigation library now depends on Fragment
1.5.1. (I56177)
Version 2.5.0
June 29, 2022
androidx.navigation:navigation-*:2.5.0 is released. Version 2.5.0 contains these commits.
Important changes since 2.4.0
- CreationExtras Integration -
Navigationnow has the ability to provide a statelessViewModelProvider.Factoryvia Lifecycle2.5.0’sCreationExtras.
Navigation SafeArgs
Navigation Safe Argshas upgraded theAndroid Gradle Plugindependency to rely on7.0.4, dropping compatibility for AGP versions before7.0.- Added support for the namespace build.gradle attribute to be used instead of applicationId.
Other Changes
- The
visibleEntriesAPI is no longer experimental and provides a function to retrieve all of the entries whose destination is currently visible according to theNavController.
Version 2.5.0-rc02
June 15, 2022
androidx.navigation:navigation-*:2.5.0-rc02 is released. Version 2.5.0-rc02 contains these commits.
Bug Fixes
- Fixed a crash caused by fast switching between bottom destinations when using the Navigation Compose
NavHost. (I3979a, b/234054916) Navigation SafeArgswill no longer crash when using anapplicationIdSuffixand namespace with either noapplicationIdpresent, or when theapplicationIdand namespace differ. (I754b1, b/233119646)NavArgumentnow has a customtoString()function to show the internal values of the argument. (I900a8)
Version 2.5.0-rc01
May 11, 2022
androidx.navigation:navigation-*:2.5.0-rc01 is released. Version 2.5.0-rc01 contains these commits.
New Features
- Added a new lint rule to warn against placing
<deeplink>elements inside<activity>elements in yournavigation.xmlfile.(Ic15a5, b/178403185)
Bug Fixes
- Composable scopes in
NavHostandDialogHostare now disposed in the expected order, i.e. inner composabled are disposed before outer composables. (I157e6) - Navigation SafeArgs now uses
PathSensitivity.RELATIVEin theArgumentsGenerationTaskto allow for cache relocatability. This means the cache entry can now be re-used from a CI build to a local build. (I5f67c, b/173420454) - The
UnrememberedGetBackStackEntryDetectorlint rule has been updated to ensure that theremembercall surrounding the call togetBackStackEntry()also passes in aNavBackStackEntryobject as a key.(Ib7081, b/227382831)
Version 2.5.0-beta01
April 20, 2022
androidx.navigation:navigation-*:2.5.0-beta01 is released. Version 2.5.0-beta01 contains these commits.
Bug Fixes
DialogNavigatornow usespopWithTransitionwhen executing adismiss()call. This fixes a race condition when using aViewModelwithindialogdestination that would cause anIllegalStateExceptionwhen dismissing the Dialog by either using system back or tapping outside of the dialog to exit. (Id7376, b/226552301)
Dependency Updates
- Navigation now depends on Lifecycle
2.5.0-beta01, fixing anIllegalStateExceptionwhen nesting oneNavHostwithin anotherNavHostin a non-primary bottom navigation tab when using multiple back stacks.
Version 2.5.0-alpha04
April 6, 2022
androidx.navigation:navigation-*:2.5.0-alpha04 is released. Version 2.5.0-alpha04 contains these commits.
API Changes
visibleEntriesis no longer experimental. (I4829f, b/225394514)
Bug Fixes
- NavHost now depend on
visibleEntriesfrom theNavControllerto determine which entries to compose. This means that when using nested NavHost the innerNavHostshould now properly animate out. (I4ba2b, b/225394514) - The
visibleEntriesStateFlowprovided byNavControlleris now based on the entry max Lifecycle state instead of the current Lifecycle state. This means that even if the host lifecycle of thenavControllergoes below STARTED, the list of visible entires will remain the same. (I9e2a8, b/225394514) SavedStateViewFactorynow supports usingCreationExtraseven when it was initialized with aSavedStateRegistryOwner. If extras are provided, the initialized arguments are ignored. (I6c43b, b/224844583)NavDeepLinkcan now parse Uris with a single query parameter with no value. (I0efe8, b/148905489)- Empty string are now considered as valid arguments in deep links. (I70a0d, b/217399862)
Navigation Safe Argswill no longer crash when using namespaces and noAndroidManifest.xmlis present. (I17ccf, b/227229815)
Version 2.5.0-alpha03
February 23, 2022
androidx.navigation:navigation-*:2.5.0-alpha03 is released. Version 2.5.0-alpha03 contains these commits.
API Changes
- You can now pass in
CreationExtrastoby navGraphViewModelsto create aViewModel. (I29217, b/217618359)
Bug Fixes
NavDeepLinksnow properly support encoded new line characters embedded in routes/deep link URIs. (I513d1, b/217815060)CreationExtraswill now work correctly when used withNavBackStackEntriesto create ViewModels. (I69161, b/217617710)- Navigation Safe Args now supports using the namespace defined
in the
build.gradlein place of the package in the AndroidManifest. (I659ef, b/217414933)
Version 2.5.0-alpha02
February 9, 2022
androidx.navigation:navigation-*:2.5.0-alpha02 is released. Version 2.5.0-alpha02 contains these commits.
Bug Fixes
- From Navigation
2.4.1: TheNavHostFragmentwill now properly set theOnBackPressedDispatcherwhen using viewbinding with nested graphs. (Ifbb51, b/214577959) - From Navigation
2.4.1: When deep linking through multiple nestedNavGraphs the back stack will now properly include intermediate start destinations. (I504c0, b/214383060)
Version 2.5.0-alpha01
January 26, 2022
androidx.navigation:navigation-*:2.5.0-alpha01 is released. Version 2.5.0-alpha01 contains these commits.
New Features
NavBackStackEntrynow integrates with ViewModel CreationExtras, introduced as part of Lifecycle2.5.0-alpha01. (Ib9fe2, b/207012490)
Bug Fixes
- Fixed an issue where accessing a
ViewModelcreated viaby navGraphViewModels()from a Fragment'sonCreate()would fail with anIllegalStateException. (I8a14d) NavDeepLinks will no longer unnecessarily decode args twice, meaning that the proper args are now passed to your final destination. (I31b0a, b/210711399)
Safe Args
- Safe Args now depends on Android Gradle Plugin version 7.0.4. This means that Navigation Safe Args will no longer be compatible with Android Studio versions prior to 7.0, but is now compatible with Android Gradle Plugin 7.1.0 and higher. (I41c88, b/213086135, b/207670704)
Version 2.4.2
Version 2.4.2
April 6, 2022
androidx.navigation:navigation-*:2.4.2 is released. Version 2.4.2 contains these commits.
Bug Fixes
- Backported from Navigation
2.5.0-alpha03:NavDeepLinksnow properly support encoded new line characters embedded in routes/deep link URIs. (I513d1, b/217815060) - Backported from Navigation
2.5.0-alpha03: Navigation SafeArgs now supports using the namespace defined in thebuild.gradlein place of the package in the AndroidManifest. (I659ef, b/217414933) - Backported from Navigation
2.5.0-alpha04:Navigation Safe Argswill no longer crash when using namespaces and noAndroidManifest.xmlis present. (I17ccf, b/227229815) - Backported from Navigation
2.5.0-alpha04: Empty string are now considered as valid arguments in deep links. (I70a0d, b/217399862)
Version 2.4.1
Version 2.4.1
February 9, 2022
androidx.navigation:navigation-*:2.4.1 is released. Version 2.4.1 contains these commits.
Bug Fixes
- The
NavHostFragmentwill now properly set theOnBackPressedDispatcherwhen using viewbinding with nested graphs. (Ifbb51, b/214577959) - When deep linking through multiple nested
NavGraphs the back stack will now properly include intermediate start destinations. (I504c0, b/214383060) - Backported from Navigation
2.5.0-alpha01: Fixed an issue where accessing a ViewModel created viaby navGraphViewModels()from a Fragment'sonCreate()would fail with anIllegalStateException. (I8a14d) - Backported from Navigation
2.5.0-alpha01:NavDeepLinks no longer unnecessarily decode args twice, meaning that the properly decoded args are now passed to your final destination. (I31b0a, b/210711399) - Backported from Navigation
2.5.0-alpha01: Safe Args now depends on Android Gradle Plugin version 7.0.4. This means that Navigation Safe Args will no longer be compatible with Android Studio versions prior to 7.0, but is now compatible with Android Gradle Plugin 7.1.0 and higher. (I41c88, b/213086135, b/207670704)
Version 2.4.0
Version 2.4.0
January 26, 2022
androidx.navigation:navigation-*:2.4.0 is released. Version 2.4.0 contains these commits.
Important changes since 2.3.0
- All Navigation artifacts have been rewritten in Kotlin. This has improved the nullability of classes using generics (such as
NavTypesubclasses). All Kotlin extension functions that used to be part of the-ktxartifacts have been moved to their respective main artifacts. The-ktxartifacts will continue to be published, but are completely empty. - The
navigation-fragmentartifact now contains a prebuilt implementation of a two pane layout via the newAbstractListDetailFragment. This fragment uses aSlidingPaneLayoutto manage a list pane (which your subclass provides) and a detail pane, which uses aNavHostFragmentas its implementation, as seen in our example implementation. - The
currentBackStackEntryAsFlow()method onNavControllerprovides aFlowthat emits whenever the currentNavBackStackEntrychanges. This flow can be used as an alternative to manually managing anOnDestinationChangedListener. - NavController now offers the ability to retrieve a list of all visible
NavBackStackEntryinstances as aStateFlowvia the experimentalvisibleEntriesproperty. - It is now possible to extend the
NavTypeclass to create custom NavTypes. Custom types are supported only when building your navigation graph programmatically, such as via the Navigation Graph Kotlin DSL. Navigation now provides
findStartDestination()andgetHierarchy()APIs that can be used to help implement custom NavigationUI.findStartDestination()is an extension function onNavGraphthat will locate the actual start destination that will be displayed when you navigate to the graph, even if thestartDestinationis itself a nestedNavGraph.getHierarchy()is a function onNavDestinationthat can be used to verify if a given destination is within the hierarchy of another.val matchingRoute: Boolean = destination.hierarchy.any { it.route == routeToFind }NavigationUImethods that took aBottomNavigationViewhave been updated to instead take its superclass introduced in Material1.4.0,NavigationBarView. This allows these methods to be used with theNavigationRailView.When inflating an
<action>element via XML, animation attributes can use attributes pulled from your theme using theapp:enterAnim="?attr/transitionEnter"syntax.Safe Args now generates a
fromSavedStateHandle()method for eachNavArgsclass. (#122, b/136967621)class HomeViewModel(savedStateHandle: SavedStateHandle) : ViewModel() { // Create a HomeDestinationArgs class with type safe accessors for each argument // defined on your destination private val args = HomeDestinationArgs.fromSavedStateHandle(savedStateHandle) }
Navigation Routes and the Kotlin DSL
Previous versions of Navigation relied on each destination having a constant integer ID that would uniquely identify it from its sibling destinations and allow you to navigate() to that destination either directly or via an action. While this continues to be valid and useful, particularly in cases where you are defining your navigation graph in XML and can use auto-generated R.id constants or Safe Args (which uses those constants to generate code at build time), this system of unique integers did not capture the semantic meaning and expressiveness needed to support fully dynamic graphs built programmatically at runtime via the Navigation Kotlin DSL.
This release introduces a new option for uniquely identifying a destination in a navigation graph by its route. A route is a String that defines the unique path to a destination. All Kotlin DSL methods that took a destination ID are now deprecated and replaced with an equivalent API that takes a route.
Each route should be treated as the ‘path’ part of a Uri that defines that destination, e.g., home, profile/{userId}, profile/{userId}/friends, etc. When the identity of a destination is associated with a specific piece of content, those dynamic arguments should be part of the route, following the same rules as implicit deep links.
All NavController APIs that used to only take an ID now have an overload that takes a route String. This includes navigate(), popBackStack(), popUpTo(), and getBackStackEntry().
This has had some API implications:
- The
popUpToKotlin property on the Kotlin DSL has been deprecated in favor ofpopUpToId. - The
getStartDestination()API has been deprecated in favor ofgetStartDestinationId().
Unlike when navigating by ID, navigating by route follows the same rules as implicit deep links in that you can directly navigate to any destination in any nested graph, ensuring that these routes are usable in multi-module projects without explicitly adding an externally visible deep link to each destination.
Navigation Compose
The navigation-compose artifact provides integration between the Navigation Component and Jetpack Compose. It uses @Composable functions as the destinations in your application.
This release provides:
- A
NavHostcomposable that allows you to construct your navigation graph via a Kotlin DSL, usingcomposableanddialogdestinations, plus support for optional Navigators such as those from Accompanist Navigation Material. - Mandatory support for crossfading between destinations. Accompanist Navigation Animation can be used to control the enter and exit transitions using experimental Compose APIs.
- Scoping of a
Lifecycleto each composable destination. Each destination only reaches theRESUMEDstate when any entering transitions finish and immediately drops toSTARTEDwhen any exiting transitions start, thus allowing you to avoid allIllegalStateExceptionand multi-touch issues by only triggering anavigatecall when theLifecycleisRESUMED. - Scoping of
ViewModel(via theviewModel()API of Lifecycle ViewModel Compose2.4.0orhiltViewModel()of Hilt Navigation Compose1.0.0at the destination level, providing a scope that survives configuration changes and being on the back stack (when your Composable content is otherwise disposed) and a signal in the ViewModel’sonCleared()that indicates the permanent disposal and cleaning up of state associated with thatNavBackStackEntry. - Scoping of
rememberSaveablestate at a destination level, ensuring that all composable state is saved and restored automatically when you return to a destination. - Full support for saving and restoring the state of the
NavControllerand its destination’s state after process death and recreation. - Automatic integration with the system back button.
Support for passing arguments, attaching deep links to destinations, and returning a result to previous destinations.
Compose specific helpers in
rememberNavController()andcurrentBackStackEntryAsState()to allow hoisting state and connecting theNavControllerto composables outside of theNavHost(such as a bottom navigation bar).
val navController = rememberNavController()
Scaffold { innerPadding ->
NavHost(navController, "home", Modifier.padding(innerPadding)) {
composable("home") {
// This content fills the area provided to the NavHost
HomeScreen()
}
dialog("detail_dialog") {
// This content will be automatically added to a Dialog() composable
// and appear above the HomeScreen or other composable destinations
DetailDialogContent()
}
}
}
See the Compose Navigation guide for more information.
Multiple back stacks
The NavController is responsible for managing the back stack of destinations, adding destinations to the back stack when you navigate() to them and removing them when you call popBackStack() or trigger the system back button. The existing NavOptions class and the integration into <action> elements in the navigation graph XML has been expanded to support saving and restoring the back stack.
As part of this change, the NavigationUI methods of onNavDestinationSelected(), BottomNavigationView.setupWithNavController() and NavigationView.setupWithNavController() now automatically save and restore the state of popped destinations, enabling support for multiple back stacks without any code changes. When using Navigation with Fragments, this is the recommended way to integrate with multiple back stacks.
The underlying APIs for saving and restoring the state are exposed via a number of surfaces:
In Navigation XML, the
<action>element can now use the boolean attributes ofapp:popUpToSaveStateandapp:restoreStateto save the state of any destinations popped viaapp:popUpToand restore the state associated with the destination passed as theapp:destination:<action android:id=”@+id/swap_stack” app:destination=”@id/second_stack” app:restoreState=”true” app:popUpTo=”@id/first_stack_start_destination” app:popUpToSaveState=”true” />In the
navOptionsKotlin DSL, you can add therestoreStateboolean property and thesaveStateboolean property on thepopUpTobuilder:// Use the navigate() method that takes a navOptions DSL Builder navController.navigate(selectedBottomNavRoute) { launchSingleTop = true restoreState = true popUpTo(navController.graph.findStartDestination().id) { saveState = true } }In manually building a
NavOptionsobject via theNavOptions.Builder, you can use thesetRestoreState()and new overload tosetPopUpTo()that takes an additionalsaveStateparameter.NavOptions navOptions = new NavOptions.Builder() .setLaunchSingleTop(true) .setRestoreState(true) .setPopUpTo(NavGraph.findStartDestination(navController.getGraph()).getId(), false, // inclusive true) // saveState .build(); navController.navigate(selectedBottomNavId, null, navOptions);Programmatic calls to
popBackStack()can now include an additionalsaveStateparameter.You can use the
clearBackStack()method to clear any state that was saved withpopBackStack()orpopUpToSaveState.
In all cases, the NavController will save and restore the state of each NavBackStackEntry, including any navigation destination scoped ViewModel instances. The Navigator APIs have been updated to enable each Navigator to support saving and restoring their own state.
Behavior changes
NavDeepLinkBuildernow addsPendingIntent.FLAG_IMMUTABLEto thePendingIntentreturned bycreatePendingIntent(), ensuring that this API works as expected when targeting Android 12.- Navigation now depends on
Lifecycle
2.3.1and now markssetGraph(),popBackStack(),navigateUp(), andnavigate(), the methods that update theNavBackStackEntryLifecycle, as@MainThread, aligning Navigation with the main thread enforcement introduced in Lifecycle2.3.0. - Deep links now verify that all required arguments (those without default values) are present in the
Uri. NavDeepLinkparsed arguments now consider pound signs in the same way as question marks as a separator between path segments, preventing an argument from spanning across the pound sign.- When generating actions, Kotlin code generated from Safe Args now puts arguments without default values before those with default values as parameters.
- When generating arguments, Safe Args now puts parameters without default values before those with default values.
- Safe-Args now depends on Android Gradle Plugin 4.2.0. This means you should no longer get the using
applicationIdTextResourcewarning.
Known issues
- Fixed in Navigation
2.5.0-alpha01: accessing aViewModelcreated viaby navGraphViewModels()from a Fragment'sonCreate()will fail with anIllegalStateException. (b/213504272) - Fixed in Navigation
2.5.0-alpha01: Safe Args 2.4.0 is incompatible with Android Gradle Plugin 7.1.0 and higher. (b/213086135) - Deep linking with multiple nested nav graphs doesn't correctly create the full backstack. (b/214383060)
Version 2.4.0-rc01
December 15, 2021
androidx.navigation:navigation-*:2.4.0-rc01 is released. Version 2.4.0-rc01 contains these commits.
Behavior changes
NavDeepLinkparsed arguments now consider pound signs in the same way as question marks as a separator between arguments. (I21309, b/180042703)
Bug Fixes
- Deeplinks will no longer ignore arguments with values that are the same as the name of the placeholder. (If8017, b/207389470)
NavControllerwill no longer crash when popping a nested destination using transitions after theNavControllerhas been restored. (I0f7c9, b/205021623)- The error message when using an invalid
startDestinationwill now default to the start destination's route if one is available. (I86b9d, b/208041894)
Navigation Compose Bug Fixes
- Fixed potential crash caused by fast switching between the start destination and another destination using bottom nav menu items. (Ic8976, b/208887901)
- Dialog destination are now properly restored on top of the screen after config changes or process death. (I4c0dc, b/207386169)
- Fixed an issue where attempting to retrieve a
ViewModelfrom a dialog’sNavBackStackEntrywould fail when the dialog was dismissed. (I6b96d, b/206465487) - Fixed an issue when using
activitydestinations with Navigation Compose'sNavHostthat would result in infinite recompositions. (I8f64c) - Fixed a leak in Navigation Compose where it was holding on to a reference of the old activity after a config change or process death. (I4efcb, b/204905432)
Safe Args Bug Fixes
SafeArgsno longer crashes when attempting to restore custom parcelable arrays after process death. (I618e8, b/207315994)- Fixed a bug in safe args that would not allow boolean arrays to have a
nullvalue. (I8c396, b/174787525)
Version 2.4.0-beta02
November 3, 2021
androidx.navigation:navigation-*:2.4.0-beta02 is released. Version 2.4.0-beta02 contains these commits.
API Changes
- The handling of both explicit and implicit
deep links now automatically adds the
saveStateflag when navigating to another graph, ensuring that code such asNavigationUI.setupWithNavControllerand code using multiple back stacks works as expected. (Ic8807)
Behavior Changes
- Deep link patterns are now compiled lazily in NavDeepLink instead of during inflation. This should improve the inflation time of navigation graphs that include deep links. (b8d257, b/184149935)
Bug Fixes
- Fixed an issue where NavBackStackEntries were being pushed down to
Lifecycle.State.CREATEDafter moving toLifecycle.State.STARTEDwhen theNavHostis added directly to the activity'ssetContent(). (Ia5ac1, b/203536683) - Fixed a race condition where
popping a
DialogFragmentdestination off of the back stack before the dialog was actually shown would not actually dismiss the dialog, resulting in a crash when the errant dialog was manually dismissed by the user. (I687e5) - Fixed an issue where the
onNavDestinationSelectedAPI onNavigationUIwould returntrueeven if you didn't actuallynavigate()to that navigation graph. It now uses the same logic used internally bysetupWithNavControllerto only select theMenuItemassociated with the current destination using thehierarchyof the destination. (I2b053)
Version 2.4.0-beta01
October 27, 2021
androidx.navigation:navigation-*:2.4.0-beta01 is released. Version 2.4.0-beta01 contains these commits.
New Features
- You can now use
by navGraphViewModelwith a route as an alternative to using an ID so as to better support using the Navigation Kotlin DSL with Fragments. (I901e3, b/201446416)
API Changes
- The
visibleEntriesAPI is now experimental. (I93f6f)
Bug Fixes
- ViewModels will no longer be destroyed when transitions are interrupted by navigating back and forth between the same screens (Id52d8, b/200817333)
- Nullable
NavDeepLinkarguments no longer require a default value when adding deep links toNavDestinations. (I5aad4, b/201320030) - NavBackStackEntries now with different Lifecycles are not longer considered equal. This means NavHost will properly recompose all destinations when doing navigation with singleTop and when reselecting bottom menu items. (I1b351, b/196997433)
- Fixed an issue with
AbstractListDetailFragmentthat caused thelayout_widthandlayout_weightattributes on the list pane returned byonCreateListPaneView()to be incorrectly handled or ignored. (f5fbf3) - The visual state of dialog destinations now
correctly stays in sync with the
DialogFragmentNavigator's state. This means that manually calling the asynchronousdismiss()API forDialogFragmentnow properly clears all dialog destinations above the now dismissed dialog. This does not affect cases where you usepopUpToorpopBackStack()to dismiss your dialog. (I77ba2) AbstractAppBarOnDestinationChangedListenernow has clearer error messaging foronDestinationChanged(). (Ie742d)
Version 2.4.0-alpha10
September 29, 2021
androidx.navigation:navigation-*:2.4.0-alpha10 is released. Version 2.4.0-alpha10 contains these commits.
New Features
- NavController now offers the ability to retrieve a list of all visible
NavBackStackEntryinstances via thevisibleEntriesStateFlow (Ia964e) rememberNavController()now takes a optional set ofNavigatorinstances that will be added to the returnedNavControllerto better support optional Navigators such as those from Accompanist Navigation Material. (I4619e)
Bug Fixes
- Dynamic Navigation will no longer crash when the Activity is recreated. (Ifa6a3, b/197942869)
- Fixed an issue with the system back button that occurs only after popping back to a composable destination that contains a
NavHost. (3ed148, b/195668143) - SafeArgs now generates the arguments for
fromBundle()andfromSavedStateHandle()in the proper parameter order. (I824a8, b/200059831)
Version 2.4.0-alpha09
September 15, 2021
androidx.navigation:navigation-*:2.4.0-alpha09 is released. Version 2.4.0-alpha09 contains these commits.
New Features
- You can now use the
clearBackStack()method to clear any state that was saved withpopBackStack()orpopUpToSaveState. (I80a0f) - You can now pass in a list of arguments and/or deep links to your nested navigation graph's builder and they will automatically be added to the resulting graph. (I8a470, b/182545357)
API Changes
- The
navArgumentKotlin DSL function is now part ofnavigation-commoninstead ofnavigation-compose. This will require updating imports to continue to use this function. (I1d095)
Behavior Changes
- When generating arguments, Safe Args now puts parameters without default values before those with default values. (I89709, b/198493585)
Bug Fixes
- When using Navigation Compose, NavGraphs will only be
DESTROYEDonce all their children areDESTROYED. (I86552, b/198741720) - Nullable
NavDeepLinkarguments no longer require a default value. (Ia14ef, b/198689811) - Calling
setGraph()with a new graph will now also clear any saved back stacks in addition to its previous behavior of popping the back stack. (I97f96) - Fixed an issue where
OnDestinationChangedListenerinstances and thecurrentBackStackEntryFlowwere not notified when usinglaunchSingleTop. (Iaaebc)
Dependency Updates
- Navigation Compose now depends on Activity Compose 1.3.1. (I05829)
- Navigation Compose now depends on
Lifecycle ViewModel Compose
2.4.0-beta01. (Ib86a3)
Version 2.4.0-alpha08
September 1, 2021
androidx.navigation:navigation-*:2.4.0-alpha08 is released. Version 2.4.0-alpha08 contains these commits.
New Features
- It is now possible to extend the
NavTypeclass to create custom NavTypes. Custom types are supported only when building your navigation graph programmatically, such as via the Navigation Graph Kotlin DSL. (I78440, b/196871885)
Behavior Changes
- When generating actions, Kotlin code generated from Safe Args now puts arguments without default values before those with default values as parameters. (Idb697, b/188855904)
- Deep links now verify that all required arguments (those without default values) are present in the
Uri. (#204, b/185527157)
Bug Fixes
- Using
getBackStackEntryandpreviousBackStackEntryinside composable(), in conjunction withremember(), will no longer cause an exception for no destination being on the back stack. (I75138, b/194313238) - Navigation Compose now properly recomposes when changing back
stack arguments and using
launchSingleTop=true. (Iebd69, b/186392337) - There will no longer be an
ArrayIndexOutOfBoundsExceptionwhen callingsetGraphwith a graph with 13 or 29 destinations. (I1a9f1, b/195171984) - The SafeArgs java generator should no longer cause lint warnings when generating Args classes. (I1a666, b/185843837)
External Contribution
- Thanks ospixd for ensuring that deep links verify that all required arguments (those without default values) are present in the
Uri. (#204, b/185527157)
Version 2.4.0-alpha07
August 18, 2021
androidx.navigation:navigation-*:2.4.0-alpha07 is released. Version 2.4.0-alpha07 contains these commits.
Bug Fixes
- Navigation Compose now properly saves state after configuration changes and when changing graphs while using the multiple back stack feature. (If5a3d, b/195141957)
- Re-selecting the same tab when using navigation compose with multiple back stacks will no longer result in a blank screen. (I860dc, b/194925622)
NavHostnow observes for changes in theLifecycle.StateofNavBackStackEntrys which means using aNavHostin a fragment now will properly be recomposed as the lifecycle changes instead of resulting in a blank screen. (I4eb85, b/195864489)- Fixed an issue where dismissing a
DialogFragmentwould not correctly update theNavControllerstate after recreating your activity (i.e., after a configuration change). (Icd72b) - Fixed an issue where popping a dialog destination would not update the NavController's system back button handling, potentially causing the NavController to intercept the back button even though it does not have any back stack to pop. (If3b34)
- Safe-args now automatically generates a
toSavedStateHandlemethod for arguments which can be used to test yourViewModelcode. (If1e2d, b/193353880)
Version 2.4.0-alpha06
August 4, 2021
androidx.navigation:navigation-*:2.4.0-alpha06 is released. Version 2.4.0-alpha06 contains these commits.
API Changes
- The
requireSlidingPaneLayout()andrequireDetailPaneNavHostFragment()methods onAbstractListDetailFragmenthave been renamed togetSlidingPaneLayout()andgetDetailPaneNavHostFragment(), respectively. (I34a08)
Behavior Changes
- When navigating with animations (like
Crossfade), the new destination’sLifecyclewill now only reach theRESUMEDwhen the animation completes. (If0543, b/172112072, b/194301889) - Navigation Compose's
NavHostnow sets the graph as part of the first composition. (Ieb7be)
Bug Fixes
- Popping the last destination of a navigation graph no longer throws a
ClassCastException. (If0543, b/172112072, b/194301889) - Fixed a
NullPointerExceptionthat would occur when adding a deep link without aUriand navigating via a route or deep link. (938a0c, b/193805425) - Fixed an issue in Navigation Compose where
a deep linked
NavBackStackEntrywould not reach theRESUMEDstate. (I192c5) - Fixed an issue where popping a dialog destination would not update the NavController's system back button handling, potentially causing the NavController to intercept the back button even though it does not have any back stack to pop. (aosp/1782668)
Version 2.4.0-alpha05
July 21, 2021
androidx.navigation:navigation-*:2.4.0-alpha05 is released. Version 2.4.0-alpha05 contains these commits.
Behavior Changes
- Navigation Compose’s
NavHostnow always uses Crossfades when navigating through destinations. (I07049, b/172112072) - You can now make changes to the graph of a NavHost. Graphs
with the same startDestination and destinations in the graph will be
considered equal and will not clear the
NavControllerback stack. (I0b8db, b/175392262)
Bug Fixes
- Fixed a
NoSuchElementExceptionwhen callingpopBackStack()from within aLifecycleObserverattached to aNavBackStackEntrycaused by reentrant updates to the NavController's state. (I64621) AbstractListDetailFragmentnow allowsSlidingPaneLayoutto be completely stripped from your APK whenAbstractListDetailFragmentis not used. (I611ad)NavGraphandNavDestinationnow override the equals method so two objects with the same values will be considered equal. (I166eb, b/175392262)
Version 2.4.0-alpha04
July 1, 2021
androidx.navigation:navigation-*:2.4.0-alpha04 is released. Version 2.4.0-alpha04 contains these commits.
New Features
- The
navigation-fragmentartifact now contains a prebuilt implementation of a two pane layout via the newAbstractListDetailFragment. This fragment uses aSlidingPaneLayoutto manage a list pane (which your subclass provides) and a detail pane, which uses aNavHostFragmentas its implementation, as seen in our example implementation. (Iac4be, b/191276636) - The
NavHostof thenavigation-composeartifact now supportsdialogdestinations in addition tocomposabledestinations. These dialog destinations will each be shown within a ComposableDialog, floating above the currentcomposabledestination. (I011d0)
val navController = rememberNavController()
Scaffold { innerPadding ->
NavHost(navController, "home", Modifier.padding(innerPadding)) {
composable("home") {
// This content fills the area provided to the NavHost
HomeScreen()
}
dialog("detail_dialog") {
// This content will be automatically added to a Dialog() composable
// and appear above the HomeScreen or other composable destinations
DetailDialogContent()
}
}
}
API Changes
- The
addfunction inNavigatorStatehas been renamed topush. All current calls toadd()will need to be changed to push(). (Ie89fc, b/172112072) - Custom
Navigatorinstances can now use thepushWithTransactionandpopWithTransitionAPIs onNavigatorStateto push or pop a destination asynchronously. Note that this APIs are not yet used by any of the included navigators. (Ic4d7c, b/172112072)
Behavior Changes
NavDeepLinkBuildernow addsPendingIntent.FLAG_IMMUTABLEto thePendingIntentreturned bycreatePendingIntent(), ensuring that this API works as expected when targeting Android 12. (If8c52)
Bug Fixes
- Fixed an issue with
<include-dynamic>where arguments passed to the graph would not be correctly passed to the dynamically included graph. (I3e115) - Fixed a
NullPointerExceptionwhen navigating to a destination using astring[]argument with a default value of@null. (I1fbe8) - Add ProGuard rules for
@Navigator.Name, fixing issues when using R8 3.1 full mode. (I2add9, b/191654433) - SafeArgs will no longer fail when building your app with
Kotlinversions before1.5.0. (Icd1ff, b/190739257)
Version 2.4.0-alpha03
June 16, 2021
androidx.navigation:navigation-*:2.4.0-alpha03 is released. Version 2.4.0-alpha03 contains these commits.
Bug Fixes
- Fixed an issue where two
navigate()calls were needed to navigate to an included dynamic graph. (I7785c, b/188859835) - Fixed a regression introduced in
Navigation
2.4.0-alpha01wheresetupActionBarWithNavController()would not properly remove the Up icon when you are on a top level destination. (I5d443, b/189868637) - Fixed an
IllegalStateExceptionwhen callingpopBackStack()after previously popping the root graph of the NavController. (I2a330, b/190265699) - ProGuard rules for
by navArgs()now properly apply when usingnavigation-commonor any artifacts that depend on it. (I68800, b/190082521) - An
OnDestinationChangedListenerthat callsnavigate()the first time it receives a callback now properly get a second callback with the destination it navigated to. (Ie5f9e, b/190228815) - Safe Args no longer crashes when using it with dynamic feature modules and AGP 7.0+. (I69518, b/189966576)
Known Issue
- Safe Args will fail with an
Unable to find method ‘’java.lang.String kotlin.text.CarsKt.titleCase(char, java.util.Locale)’’error when using Gradle6.7.0due to a dependency on an older version of Kotlin. This can be worked around by updating to use Gradle 7.0. (b/190739257)
Version 2.4.0-alpha02
June 2, 2021
androidx.navigation:navigation-*:2.4.0-alpha02 is released. Version 2.4.0-alpha02 contains these commits.
New Features
- Routes are now supported for Activity, Fragment and Dialog destinations, as well as throughout the DynamicNavigation Kotlin DSL. (Ib5544, Ia617b, I22f96, b/188914648, b/188901565)
NavigationUIhas temporarily added experimental APIs to allow opting out of saving your state. While always saving the state is the correct behavior, there are still uses of deprecated libraries (i.e. retained fragments), that cannot be supported when saving the state so this gives an opportunity for apps to slowly convert away from any unsupported APIs. (Idf93c)Navigation now provides
findDestination()andgetHierarchy()APIs that can be used to help implement custom NavigationUI.findDestination()is an extension function onNavGraphthat will locate a destination within the graph.getHierarchy()is a function onNavDestinationthat can be used to verify if a given destination is within the hierarchy of another.(I2932f, b/188183365)val matchingRoute: Boolean = destination.hierarchy.any { it.route == routeToFind }NavigationUI methods that took a
BottomNavigationViewhave been updated to instead take its superclass introduced in Material1.4.0,NavigationBarView. This allows these methods to be used with theNavigationRailView. (Ib0b36, b/182938895)When inflating an
<action>element via XML, animation attributes can use attributes pulled from your theme using theapp:enterAnim="?attr/transitionEnter"syntax. (I07bc1, b/178291654)
API Changes
- Kotlin DSL builders that use an ID have been deprecated and should be replaced with builders that use routes (I85b42, b/188816479) (I9f58f, b/188816479)
Bug Fixes
DialogFragmentNavigatornow uses theNavigatorState.pop()API to inform theNavControllerwhen a dialog is dismissed by hitting the system back button or clicking outside of it, ensuring that theNavControllerstate is always in sync with the Navigator's state. (I2ead9)Navigation no longer gives a
ConcurrentModificationExceptionwhen using manipulating the list ofOnDestinationChangedListenersfrom with anonDestinationChangedcallback. (Ib1707, b/188860458)Safe Args no longer crashes when attempting to generate direction properties in Kotlin. (Id2416, b/188564435)
The setId method on NavDestination is now properly annotated with
@IdRes, so it only accepts resource ids. (I69b80)The int parameter of
findNodeis nowresIdinstead ofresid. (I7711d)
Dependency Update
- Safe-Args now depends on Android Gradle Plugin 4.2.0. This means you should no longer get the using
applicationIdTextResourcewarning. (I6d67b, b/172824579)
Version 2.4.0-alpha01
May 18, 2021
androidx.navigation:navigation-*:2.4.0-alpha01 is released. Version 2.4.0-alpha01 contains these commits.
New Features
- The
currentBackStackEntryAsFlow()method onNavControllerprovides aFlowthat emits whenever the currentNavBackStackEntrychanges. This flow can be used as an alternative to manually managing anOnDestinationChangedListener. (I19c4a, #89, b/163947280)
Multiple back stacks
The NavController is responsible for managing the back stack of destinations, adding destinations to the back stack when you navigate() to them and removing them when you call popBackStack() or trigger the system back button. The existing NavOptions class and the integration into <action> entries in the navigation graph XML has been expanded to support saving and restoring the back stack. (b/80029773)
As part of this change, the NavigationUI methods of onNavDestinationSelected(), BottomNavigationView.setupWithNavController() and NavigationView.setupWithNavController() now automatically save and restore the state of popped destinations, enabling support for multiple back stacks without any code changes. When using Navigation with Fragments, this is the recommended way to integrate with multiple back stacks. (Ie07ca)
The underlying APIs for saving and restoring the state are exposed via a number of surfaces:
In Navigation XML, the
<action>element can now use the boolean attributes ofapp:popUpToSaveStateandapp:restoreStateto save the state of any destinations popped viaapp:popUpToand restore the state associated with the destination passed as theapp:destination:<action android:id=”@+id/swap_stack” app:destination=”@id/second_stack” app:restoreState=”true” app:popUpTo=”@id/first_stack_start_destination” app:popUpToSaveState=”true” />In the
navOptionsKotlin DSL, you can add therestoreStateboolean property and thesaveStateboolean property on thepopUpTobuilder:// Use the navigate() method that takes a navOptions DSL Builder navController.navigate(selectedBottomNavRoute) { launchSingleTop = true restoreState = true popUpTo(navController.graph.startDestinationId) { saveState = true } }In manually building a
NavOptionsobject via theNavOptions.Builder, you can use thesetRestoreState()and new overload tosetPopUpTo()that takes an additionalsaveStateparameter.NavOptions navOptions = new NavOptions.Builder() .setLaunchSingleTop(true) .setRestoreState(true) .setPopUpTo(navController.getGraph().getStartDestinationId(), false, // inclusive true) // saveState .build(); navController.navigate(selectedBottomNavId, null, navOptions);Programmatic calls to
popBackStack()can now include an additionalsaveStateparameter.
In all cases, the NavController will save and restore the state of each NavBackStackEntry, including any navigation destination scoped ViewModel instances. The Navigator APIs have been updated to enable each Navigator to support saving and restoring their own state.
The ComposeNavigator used for composable destinations in Navigation Compose and the FragmentNavigator and DynamicFragmentNavigator used for <fragment> destinations in Navigation with Fragments have both been updated to use the new Navigator APIs and support saving and restoring state.
Navigation Routes
A route is a String that uniquely identifies a destination. While previously only used in Navigation Compose, this concept has now graduated to become a part of the core Navigation APIs. This provides an alternative to using integer IDs when constructing your graph through the Navigation Kotlin DSL. (b/172823546)
All APIs that used to only take an ID now have an overload that takes a route String. This includes navigate(), popBackStack(), popUpTo(), and getBackStackEntry().
This has had some API implications:
- The
popUpTokotlin property on the Kotlin DSL has been deprecated in favor ofpopUpToId. (I59c73, b/172823546) - The
getStartDestination()API has been deprecated in favor ofgetStartDestinationId(). (I0887f, b/172823546)
For developers upgrading from previous versions of Navigation Compose to Navigation Compose 2.4.0-alpha01, this means that the following imports on extension methods are no longer necessary and should be removed:
import androidx.navigation.compose.navigation
import androidx.navigation.compose.createGraph
import androidx.navigation.compose.getBackStackEntry
import androidx.navigation.compose.navigate
import androidx.navigation.compose.popUpTo
The KEY_ROUTE argument has been replaced with the route property on NavDestination, allowing you to call navBackStackEntry.destination.route directly.
API Changes
- All Navigation artifacts have been rewritten in Kotlin. This has improved the nullability of classes using generics (such as
NavTypesubclasses). All Kotlin extension functions that used to be part of the-ktxartifacts have been moved to their respective main artifacts. The-ktxartifacts will continue to be published, but are completely empty. (b/184292145) NavDeepLinkBuildernow supports adding multiple distinct destinations to the generated back stack. (I3ee0d, b/147913689)- Add factory functions for
DynamicNavHostFragment(Icd515, b/175222619) - The unique ID of a
NavBackStackEntryis now exposed as part of its public API. (Ie033a) - The
nameandargumentfields and destructuring functions ofNamedNavArgumentare now public. (#174, b/181320559) - Introduced a new
NavBackStackEntry#provideToCompositionLocalsextension that provides theNavBackStackEntryto the relevant composition locals. (#175, b/187229439)
Safe Args
Safe Args now generates a
fromSavedStateHandle()method for eachNavArgsclass. (#122, b/136967621)class HomeViewModel(savedStateHandle: SavedStateHandle) : ViewModel() { // Create a HomeDestinationArgs class with type safe accessors for each argument // defined on your destination private val args = HomeDestinationArgs.fromSavedStateHandle(savedStateHandle) }Updated Safe Args to depend on KotlinPoet
1.8.0. (#172, b/183990444)
Behavior Changes
- Navigation now depends on
Lifecycle
2.3.1and now markssetGraph(),popBackStack(),navigateUp(), andnavigate(), the methods that update theNavBackStackEntryLifecycle, as@MainThread, aligning Navigation with the main thread enforcement introduced in Lifecycle2.3.0. (b/171125856) - Parsing Enum arguments from deep links is now case insensitive, allowing a deep link like
http://www.example.com/redto match awww.example.com/{color}deep link even when the enum has the value ofRED. (#152, b/135857840)
Compose Compatibility
androidx.navigation:navigation-compose:2.4.0-alpha01is only compatible with Compose version1.0.0-beta07and above.
Bug Fixes
- Fixed an issue where trailing argument placeholders would take precedence over deep links that have a matching exact suffix. (#153, b/184072811)
NavHostFragmentnow supports custom Navigators that use the same@Navigator.Name("dialog")as the defaultDialogFragmentNavigator. (Ib1c2c, b/175979140)- Improved the behavior of
NavigatorProvider#addNavigatorto ensure that calling it repeatedly with the same instance does not cause issues. (#176, b/187443146)
External Contributions
- Thanks simonschiller for building support for Safe Args generating a
fromSavedStateHandle()method for eachNavArgsclass. (#122, b/136967621) - Thanks Bradleycorn for making parsing Enum arguments from deep links case insensitive. (#152, b/135857840)
- Thanks osipxd for fixing an issue where trailing argument placeholders would take precedence over deep links that have a matching exact suffix. (#153, b/184072811)
- Thanks tatocaster for updating Safe Args to depend on KotlinPoet
1.8.0. (#172, b/183990444) - Thanks jossiwolf for making the
nameandargumentfields and destructuring functions ofNamedNavArgumentpublic. (#174, b/181320559) - Thanks jossiwolf for introducing a new
NavBackStackEntry#provideToCompositionLocalsextension that provides theNavBackStackEntryto the relevant composition locals. (#175, b/187229439) - Thanks jossiwolf for improved the behavior of
NavigatorProvider#addNavigatorto ensure that calling it repeatedly with the same instance does not cause issues. (#176, b/187443146)
Navigation Compose Version 1.0.0
Version 1.0.0-alpha10
April 7, 2021
androidx.navigation:navigation-compose:1.0.0-alpha10 is released. Version 1.0.0-alpha10 contains these commits.
API Changes
NavHostnow accepts aModifier, which is passed down to the composable container that wraps the destination composables. (I85aca, b/175125483)
Bug Fixes
NavHostnow works even when anOnBackPressedDispatcherOwneris not found, such is the case when previewing theNavHost. (I7d8b4)- Navigation Compose now depends on Navigation
2.3.5, fixing an issue when usingBackHandlerinside aNavHostdestination. (I7e63b, b/182284739)
Version 1.0.0-alpha09
March 10, 2021
androidx.navigation:navigation-compose:1.0.0-alpha09 is released. Version 1.0.0-alpha09 contains these commits.
API Changes
LocalViewModelStoreOwner.currentnow returns a nullableViewModelStoreOwnerto better determine whether aViewModelStoreOwneris available in the current composition. APIs that require aViewModelStoreOwner, such asviewModel()andNavHost, still throw an exception if aViewModelStoreOwneris not set. (Idf39a)
Bug Fixes
- Navigation Compose now depends on Navigation 2.3.4 which includes the fix for attempting to set the same ViewModelStore object after the graph has been set. (I65c24, b/177825470)
Version 1.0.0-alpha08
February 24, 2021
androidx.navigation:navigation-compose:1.0.0-alpha08 is released. Version 1.0.0-alpha08 contains these commits.
New Features
NavHostnow populates theLocalSavedStateRegistryOwnerCompositionLocal with that destination’sNavBackStackEntry, ensuring that any state directly saved into theSavedStateRegistrywill be saved and restored alongside the destination. (I435d7, b/179469431)
Version 1.0.0-alpha07
February 10, 2021
androidx.navigation:navigation-compose:1.0.0-alpha07 is released. Version 1.0.0-alpha07 contains these commits.
Dependency Updates
- Navigation Compose now depends on Lifecycle ViewModel Compose 1.0.0-alpha01 to provide
viewModel()support tocomposabledestinations. (I7a374) NavHostnow uses the newLocalOnBackPressedDispatcherOwnerfrom Activity-Compose 1.3.0-alpha01 to get theOnBackPressedDispatcherthat is set on theNavController. (I65b12)
Version 1.0.0-alpha06
January 28, 2021
androidx.navigation:navigation-compose:1.0.0-alpha06 is released. Version 1.0.0-alpha06 contains these commits.
API Changes
- Added a
getBackStackEntry(route: String)extension method onNavControllerthat returns the associatedNavBackStackEntry. (If8931)
Version 1.0.0-alpha05
January 13, 2021
androidx.navigation:navigation-compose:1.0.0-alpha05 is released. Version 1.0.0-alpha05 contains these commits.
Updated to depend on Compose 1.0.0-alpha10.
Version 1.0.0-alpha04
December 16, 2020
androidx.navigation:navigation-compose:1.0.0-alpha04 is released. Version 1.0.0-alpha04 contains these commits.
- Updated for compatibility with Compose
1.0.0-alpha09.
Version 1.0.0-alpha03
December 2, 2020
androidx.navigation:navigation-compose:1.0.0-alpha03 is released. Version 1.0.0-alpha03 contains these commits.
Bug Fixes
- Fixed an issue where
popBackStack()andnavigateUp()would not work after a configuration change or process death and recreation. (Icea47, b/173281473) - Navigating to a nested graph within your NavHost now works properly. (I0948d, b/173647694)
Version 1.0.0-alpha02
November 11, 2020
androidx.navigation:navigation-compose:1.0.0-alpha02 is released. Version 1.0.0-alpha02 contains these commits.
API Changes
- Navigation compose now support NavOptions for using popUpTo and launchSingleTop operations (If96c3, b/171468994)
- Added a navigation function that takes a route instead of an ID that allows you to construct nested graphs in the Navigation Compose DSL. (I1661d)
- startDestination now comes before the route in the list of a parameters for a NavHost (Ie620e)
- You can now create a graph using the route as a start destination outside of a NavHost composable. (Iceb75)
Version 1.0.0-alpha01
October 28, 2020
android.navigation:navigation-compose:1.0.0-alpha01 is released. Version 1.0.0-alpha01 contains these commits.
New Features
The navigation-compose artifact provides integration between the Navigation Component and Jetpack Compose. It uses @Composable functions as the destinations in your application.
This initial release provides:
- A
NavHostcomposable that allows you to construct your navigation graph via a Kotlin DSL. - Scoping of lifecycle,
ViewModel, and remembered state at the destination level. - Automatic integration with the system back button.
- Support for passing arguments, attaching deep links to destinations, and returning a result to previous destinations.
- Compose specific helpers in
rememberNavController()andcurrentBackStackEntryAsState()to allow hoisting state and connecting theNavControllerto composables outside of theNavHost(such as a bottom navigation bar).
See the Compose Navigation guide for more information.
Version 2.3.5
Version 2.3.5
April 7, 2021
androidx.navigation:navigation-*:2.3.5 is released. Version 2.3.5 contains these commits.
New Features
- When navigating using a
NavDeepLinkRequestorUri, you can now access theUri, action, and mime type in the resulting destination by getting the intent from arguments viaKEY_DEEP_LINK_INTENT, mirroring the functionality already available for external deep linking. (I975c3, b/181521877)
Bug Fixes
OnBackPressedCallbacksadded to a dispatcher with theNavBackStackEntryas the LifecycleOwner now properly intercept back after the Activity Lifecycle isSTOPPED, thenSTARTED(Iff94f, b/182284739)- Deep link domain parsing is now case insensitive, ensuring that
www.example.commatches bothwww.example.comandwww.Example.com. Note that query parameter names are still case sensitive. (#144, b/153829033) - Fixed a
NullPointerExceptionthat could occur when a destination has multiple non-nullable default arguments and you navigate to that destination while only overriding a subset of those arguments. (aosp/1644827)
Dependency Updates
- The Navigation Safe Args Gradle Plugin now depends on Kotlin Gradle Plugin 1.4.31. (aosp/1661058, b/181156413)
External Contribution
- Thanks
bentrengrovefor the pull request making deep link domain parsing case insensitive. (#144, b/153829033)
Version 2.3.4
Version 2.3.4
March 10, 2021
androidx.navigation:navigation-*:2.3.4 is released. Version 2.3.4 contains these commits.
New Features
ReferenceTypearguments can now be properly parsed when sent as part of a deeplink URI. This supports both the raw integer value as well as hex values prefixed by0x. (#127, b/179166693)- The
android:defaultValuefor an argument withapp:argType="float"now supports integer default values, allowing you to useandroid:defaultValue="0"rather than requiring the use of0.0. (#117, b/173766247)
Bug Fixes
- Fix stuck installation progress when using Navigation’s support for dynamic features. (Ib27a7, b/169636207)
- Calling
setViewModelStoreorsetLifecycleOwnerwith the same object that has already been set will now be a no-op (Idf491, b/177825470) - Safe-Args now adds suppress annotations on the proper methods when using java. (I8fbc5, b/179463137)
External Contributions
- Thanks
JvmNamefor the pull request to ensure thatReferenceTypearguments can now be properly parsed when sent as part of a deeplink URI. (#127, b/179166693) - Thanks
tatocasterfor the pull request to allow thedefaultValuefor an argument withapp:argType=”float”now supports integer default values. (#117, b/173766247)
Version 2.3.3
Version 2.3.3
January 27, 2021
androidx.navigation:navigation-*:2.3.3 is released. Version 2.3.3 contains these commits.
Bug Fixes
- There is no longer a crash when popping a
NavBackStackEntrybefore itsLifecycleis moved toCREATED. (Ie3ba3) - Fixed regression caused by b/171364502 where navigating to an
activity with an animation resource value of
0caused aResourceNotFoundException. (I7aedb, b/176819931)
Version 2.3.2
Version 2.3.2
December 2, 2020
androidx.navigation:navigation-*:2.3.2 is released. Version 2.3.2 contains these commits.
Bug Fixes
- Fixed a regression in
NavigationUIwhere using an<activity>destination withonNavDestinationSelectedwould fail to navigate to the Activity. (I22e34, b/171364502) - Fixed an issue where
navigation-dynamic-features-fragmentwould result in navigating to the newly installed destination multiple times. (aosp/1486056, b/169636207) - Fixed an issue where default arguments would not be sent to
OnDestinationChangedListenerinstances when usinglaunchSingleTop. (I2c5cb) - Fixed an issue where navigating to a nested navigation graph would not create a new graph instance on the back stack. (Ifc831)
- Fixed an issue where using
navigate()with apopUpTothat removed the last destination in a navigation graph would not immediately destroy and remove the navigation graph itself from the back stack. (I910a3) - Navigation SafeArgs now uses KotlinPoet version 1.7.2 which adds support for Kotlin's explicit API mode. (I918b5)
NavHostFragment.findNavController(Fragment)now also checks the root decor view of a DialogFragment in addition to the existing checks of the Fragment hierarchy and Fragment's view hierarchy. This allows you to test dialog fragments that use Navigation withFragmentScenarioandNavigation.setViewNavController(). (I69e0d)
Version 2.3.1
Version 2.3.1
October 14, 2020
androidx.navigation:navigation-*:2.3.1 is released. Version 2.3.1 contains these commits.
New Features
- Default Animator resources have been added to Navigation UI and are recommended over the default animation resources. (b/167430145)
- NavOptions now overrides the hashcode and equals methods (b/161586466)
- Navigation now includes the current destination in the “No destination with ID” IllegalArgumentException, which should improve the developer debugging experience. (b/168311416)
Bug Fixes
- Safe Args will no longer wrap the return line, even if the generated argument class name is longer than 100 characters. (b/168584987)
Dependency Changes
navigation-uinow depends on DrawerLayout 1.1.1, ensuring thatNavigationUIis able to open the drawer even when usingLOCK_MODE_LOCKED_CLOSEDorLOCK_MODE_LOCKED_OPEN. (b/162253907)- Safe Args now depends on KotlinPoet 1.6.0 (aosp/1435911)
- Safe Args now depends on AGP 4.0.1 (aosp/1442337)
Version 2.3.0
Version 2.3.0
June 24, 2020
androidx.navigation:navigation-*:2.3.0 is released. Version 2.3.0 contains these commits.
Major changes since 2.2.0
- Feature Module integration: The
navigation-dynamic-features-runtimeandnavigation-dynamic-features-fragmentartifacts allow you to navigate to destinations that are defined in feature modules, automatically handling the installation of the feature modules as needed. See Navigate with feature modules for more information. - Navigation Testing: The
navigation-testingartifact provides aTestNavHostControllerthat allows you to set the current destination and verify the back stack after navigation operations. See Test Navigation for more information. - Returning a Result: The
NavBackStackEntryassociated with each destination on the Navigation back stack now allows you to access aSavedStateHandlesuitable for storing small amounts of saved state that should be associated with a particular back stack entry. See Returning a result to the previous Destination for more information. NavigationUIsupport forOpenable: All usages ofDrawerLayoutinNavigationUIhave been replaced with the more genericOpenableinterface added in CustomView1.1.0and implemented byDrawerLayoutin DrawerLayout1.1.0.- Action and Mime Type support in deep links: Deep linking has been expanded to support
app:actionandapp:mimeTypein addition to theapp:uripreviously available.NavControllernow supports navigating by any combination of these fields via the newNavDeepLinkRequestclass. See Navigate using NavDeepLinkRequest for more information.
Known Issues
- Support for deep link actions and mime types is not yet available in Manifest Merger. Until that work is completed, any generated
<intent-filter>elements from the<nav-graph>element in your manifest won't include your mime type in its<data>element or your custom<action>. You must manually add an appropriate<intent-filter>to your manifest.
Version 2.3.0-rc01
June 10, 2020
androidx.navigation:navigation-*:2.3.0-rc01 is released. Version 2.3.0-rc01 contains these commits.
Bug Fixes
- Fixed a
NullPointerExceptionwhen replacing an instance of a destination with no arguments with another instance with arguments withsingleTop. (b/158006669) - All
destination is unknownexceptions thrown byNavControllernow have additional debugging information to help determine the state of theNavController. (b/157764916)
Version 2.3.0-beta01
May 20, 2020
androidx.navigation:navigation-*:2.3.0-beta01 are released. Version 2.3.0-beta01 contains these commits.
Bug Fixes
- Fixed an issue where the
Lifecycleof theNavBackStackEntrywould not be properly updated after process death. (b/155218371) OnDestinationChangedListenerinstances registered before callingsetGraph()are now properly sent the restored destination after a process death. (b/155218371)- When using
singleTop, theNavBackStackEntrynow correctly has its arguments updated and the updated arguments are sent to allOnDestinationChangeListenerinstances. (b/156545508)
Dependency Updates
- The
NavigationUIartifact now depends on CustomView1.1.0-rc01and DrawerLayout1.1.0-rc01. (aosp/1309696)
Version 2.3.0-alpha06
April 29, 2020
androidx.navigation:navigation-*:2.3.0-alpha06 is released. (Version 2.3.0-alpha06 contains these commits.)
New Features
- Deep linking has been expanded to support
app:actionandapp:mimeTypein addition to theapp:uripreviously available. NavController now supports navigating by any combination of these fields via the newNavDeepLinkRequestclass. (b/136573074, b/135334841)
API Changes
- Greatly expanded the Kotlin DSL support for Dynamic Navigation destinations. (b/148969800)
Bug Fixes
- Fixed an issue where deep link Intents would be ignored when using a nested start destination. (b/154532067)
Version 2.3.0-alpha05
April 15, 2020
androidx.navigation:navigation-*:2.3.0-alpha05 is released. Version 2.3.0-alpha05 contains these commits.
New Features
- For dynamic graph includes using
<include-dynamic>, you no longer need to specifyapp:graphPackageand a default one will be used by addingmoduleNamesuffix to theapplicationIdafter a dot. If you do need to customize yourgraphPackage, an${applicationId}placeholder is now supported. (b/152696768) - The Navigation Graph Kotlin DSL now exposes a
defaultArgumentsMapfor actions, mirroring the ability to set default values on<action>elements in Navigation XML files. (b/150345605)
Bug Fixes
- From Navigation 2.2.2: Fixed an
IllegalStateExceptionwhen deep linking to the start destination of your graph when you have multipleNavHostFragmentinstances in your Activity. (b/147378752)
Dependency updates
- Navigation now depends on Fragment
1.2.4. (aosp/1277325) - Dynamic Navigation now depends on Play Core
1.7.2. (aosp/1282257)
Version 2.3.0-alpha04
March 18, 2020
androidx.navigation:navigation-*:2.3.0-alpha04 is released. Version 2.3.0-alpha04 contains these commits.
New Features
- Added support for feature module activity and fragment destinations in the Navigation Kotlin DSL. (b/148969800)
API Changes
- The
DynamicExtrasclass no longer uses a builder pattern and can now be constructed directly. (aosp/1253671) DynamicActivityNavigatornow takes aContextin its constructor rather than anActivity. (aosp/1250252)
Bug Fixes
NavigationUIno longer ignores empty labels (i.e., a destination withandroid:label=””) and now correctly sets the title to an empty string. (b/148679860)
Dependency Updates
- The Navigation Dynamic Features artifacts now depend on Play Core
1.6.5. (b/149556401)
Version 2.3.0-alpha03
March 4, 2020
androidx.navigation:navigation-*:2.3.0-alpha03 is released. Version 2.3.0-alpha03 contains these commits.
API Changes
- Instead of relying on the concrete
DrawerLayoutclass,AppBarConfigurationnow uses theOpenableinterface introduced in CustomView1.1.0-alpha02(whichDrawerLayoutimplements as of DrawerLayout1.1.0-alpha04), allowing you to use custom implementations ofOpenablewithNavigationUI. (b/129030452)
Bug Fixes
- The
navigation-common-ktxProGuard rules now correctly only keep theNavArgsclasses that are used rather than allNavArgsinstances. (b/150213558)
Dependency changes
- Navigation has reverted its dependency on Core
1.2.0and now depends on Core1.1.0to avoid forcing developers to move to a newer dependency when Navigation does not depend on any new APIs in Core1.2.0.
Version 2.3.0-alpha02
February 19, 2020
androidx.navigation:navigation-*:2.3.0-alpha02 is released. Version 2.3.0-alpha02 contains these commits.
New Features
- The
NavBackStackEntrynow allows you to access aSavedStateHandlesuitable for storing small amounts of saved state that should be associated with a particular back stack entry. See Returning a result for an example use case. (b/79672220)
API Changes
- Convenience methods of
getCurrentBackStackEntry()andgetPreviousBackStackEntry()have been added to make it easier to retrieve aNavBackStackEntryfor the current and previous destinations. (b/79672220)
Bug Fixes
navigateUp()now passes the current destination’s arguments and theKEY_DEEP_LINK_INTENTto the previous destination when launching your app on your own task stack. (b/147456890)
Dependency changes
- Navigation now depends on Core
1.2.0.
Version 2.3.0-alpha01
February 5, 2020
androidx.navigation:navigation-*:2.3.0-alpha01 is released. Version 2.3.0-alpha01 contains these commits.
New features
- The new
navigation-testingartifact provides aTestNavHostControllerclass. This class provides an alternative to using a mockNavControllerwhen testing Navigation that allows you to set the current destination and verify the back stack after navigation operations. (b/140884273) - The new
navigation-dynamic-features-fragment(and its transitive dependency,navigation-dynamic-features-runtime) allows you to include destinations or entire navigation graphs (via<include-dynamic>) from feature modules, providing seamless installation of on-demand feature modules when navigating to those destinations. See Navigate with feature modules for more information. (b/132170186)
Bug fixes
- From Navigation
2.2.1: Deep links without query parameters now correctly ignore any query parameters rather than appending them to trailing{argument}elements or not matching the deep link. (b/147447512) - From Navigation
2.2.1: Thenavigation-uiProGuard rules forDrawerArrowDrawablehave been updated to ensure thatandroid.enableJetifier=trueis not required. (b/147610424) - From Navigation
2.2.1: Thenavigation-common-ktxmodule now has a unique manifest package name instead of sharing the same manifest package name asnavigation-runtime-ktx. (aosp/1141947)
Dependency updates
- From Navigation
2.2.1: Navigation2.2.1now depends on Lifecycle ViewModel SavedState2.2.0and Fragment1.2.1.
Version 2.2.2
Version 2.2.2
April 15, 2020
androidx.navigation:navigation-*:2.2.2 are released. Version 2.2.2 contains these commits.
Bug Fixes
- Fixed an
IllegalStateExceptionwhen deep linking to the start destination of your graph when you have multipleNavHostFragmentinstances in your Activity. (b/147378752) NavigationUIno longer ignores empty labels (i.e., a destination withandroid:label=””) and now correctly sets the title to an empty string. This was previously released in Navigation 2.3.0-alpha04. (b/148679860)- The
navigation-common-ktxProGuard rules now correctly only keep theNavArgsclasses that are used rather than allNavArgsinstances. This was previously released in Navigation 2.3.0-alpha03. (b/150213558
Dependency updates
- Navigation now depends on Fragment
1.2.4. (aosp/1277325)
Version 2.2.1
Version 2.2.1
February 5, 2020
androidx.navigation:navigation-*:2.2.1 is released. Version 2.2.1 contains these commits.
Bug fixes
- Deep links without query parameters now correctly ignore any query parameters rather than appending them to trailing
{argument}elements or not matching the deep link. (b/147447512) - The
navigation-uiProGuard rules forDrawerArrowDrawablehave been updated to ensure thatandroid.enableJetifier=trueis not required. (b/147610424) - The
navigation-common-ktxmodule now has a unique manifest package name instead of sharing the same manifest package name asnavigation-runtime-ktx. (aosp/1141947)
Dependency updates
- Navigation
2.2.1now depends on Lifecycle ViewModel SavedState2.2.0and Fragment1.2.1.
Version 2.2.0
Version 2.2.0
January 22, 2020
androidx.navigation:navigation-*:2.2.0 is released. Version 2.2.0 contains these commits.
Important changes since 2.1.0
- NavBackStackEntry: You can now call
NavController.getBackStackEntry(), passing in the ID of a destination or navigation graph on the back stack. The returnedNavBackStackEntryprovides a Navigation-drivenLifecycleOwner,ViewModelStoreOwner(the same returned byNavController.getViewModelStoreOwner()), andSavedStateRegistryOwner, in addition to providing the arguments used to start that destination. - Lifecycle ViewModel SavedState Integration:
SavedStateViewModelFactoryis now the default factory used when usingby navGraphViewModels()or theViewModelProviderconstructor with aViewModelStoreOwnerreturned byNavController.getBackStackEntry()orNavController.getViewModelStoreOwner(). - Query Parameter Support for Deep Links: Deep links with query parameters now support reordered query parameters; arguments that have a default value or are nullable are now optional when matching deep links.
- Improved Animation Support:
NavHostFragmentnow usesFragmentContainerViewfrom Fragment 1.2.0, fixing animation z-ordering issues and window insets dispatching to Fragments.
Version 2.2.0-rc04
December 18, 2019
androidx.navigation:navigation-*:2.2.0-rc04 is released. Version 2.2.0-rc04 contains these commits.
Bug fixes
- Adjusted the default fade animations used by
navigation-uito match the adjusted fade animations in Fragment1.2.0-rc04. (b/145769814)
Version 2.2.0-rc03
December 4, 2019
androidx.navigation:navigation-*:2.2.0-rc03 is released. Version 2.2.0-rc03 contains these commits.
Bug fixes
- Fixed an issue with deep link parsing when using query parameters and an argument as the last part of the path that prevented more than one character of the final path argument from being parsed. (b/144554689)
- Fixed an issue with deep link parsing where optional parameters would receive
"@null"instead ofnull. (b/141613546) NavHostFragmentnow correctly restores the graph after a configuration change when used withFragmentContainerView. (b/143752103)
Dependency changes
- Navigation now depends on Lifecycle
2.2.0-rc03, Lifecycle ViewModel SavedState1.0.0-rc03, Activity1.1.0-rc03, and Fragment1.2.0-rc03where appropriate.
Version 2.2.0-rc02
November 7, 2019
androidx.navigation:navigation-*:2.2.0-rc02 is released. Version 2.2.0-rc02 contains these commits.
Dependency changes
- Navigation now depends on androidx.lifecycle
2.2.0-rc02.
Version 2.2.0-rc01
October 23, 2019
androidx.navigation:navigation-*:2.2.0-rc01 is released with no changes since 2.2.0-beta01. Version 2.2.0-rc01 contains these commits.
Version 2.2.0-beta01
October 9, 2019
androidx.navigation:navigation-*:2.2.0-beta01 is released. Version 2.2.0-beta01 contains these commits.
New features
NavDestinationand its subclasses now overridetoString()to provide more helpful information when debugging. (b/141264986)
Behavior changes
- Extra query parameters are now ignored when matching deep links rather than causing the match to fail. (b/141482822)
Bug fixes
- Fixed an issue where arguments in a deep link’s path would be ignored if query parameters were also specified. (b/141505755)
- The
navArgs()Kotlin extension onActivitynow has a better error message when there are no extras. (b/141408999) - Safe Args generated
DirectionsJava classes now contain default values. (b/141099045) - Safe Args generated
ArgsJava classes now contain default values. (b/140123727) - When using a
Toolbar,NavigationUIno longer animates the text change when moving between two top level destinations. (b/140848160)
Version 2.2.0-alpha03
September 18, 2019
androidx.navigation:navigation-*:2.2.0-alpha03 is released. Version 2.2.0-alpha03 contains these commits.
Behavior changes
- Calling
setViewModelStore()after callingsetGraphnow results in anIllegalStateException. This should always be set by theNavHostas part of the initial setup to ensure that allNavBackStackEntryinstances have a consistent storage forViewModelinstances. (aosp/1111821)
Bug fixes
- Fixed a
ConcurrentModificationExceptionwhen usingViewModelinstances attached to multiple different navigation graph scopedViewModelStoreinstances. (aosp/1112257)
Version 2.2.0-alpha02
September 5, 2019
androidx.navigation:navigation-*:2.2.0-alpha02 is released. The commits included in this version can be found here.
New features
- Deep links with query parameters now support reordered query parameters; arguments that have a default value or are nullable are now optional when matching deep links. (b/133273839)
- You can now call
NavController.getBackStackEntry(), passing in the ID of a destination or navigation graph on the back stack. The returnedNavBackStackEntryprovides a Navigation-drivenLifecycleOwner,ViewModelStoreOwner(the same returned byNavController.getViewModelStoreOwner()), andSavedStateRegistryOwner, in addition to providing the arguments used to start that destination. (aosp/1101691, aosp/1101710)
Bug fixes
- Fixed an issue where adding a
NavHostFragmenttoViewPager2failed with anIllegalArgumentException. (b/133640271) NavInflaternow avoids callinggetResourceName()unnecessarily, speeding up inflation time by up to 40%. (b/139213740)
Version 2.2.0-alpha01
August 7, 2019
androidx.navigation:navigation-*:2.2.0-alpha01 is released. The commits included in this version can be found here.
New features
SavedStateViewModelFactoryis now the default factory used when usingby navGraphViewModels()or theViewModelProviderconstructor with aViewModelStoreOwnerreturned byNavController.getViewModelStoreOwner(). (b/135716331)
API changes
- From Navigation
2.1.0-rc01: The deprecatedgetViewModelStore()API onNavControllerintroduced in2.1.0-alpha02has been removed. (aosp/1091021)
Bug fixes
NavHostFragmentnow usesFragmentContainerView, fixing animation z-ordering issues and window insets dispatching to Fragments. (b/137310379)
Version 2.1.0
Version 2.1.0
September 5, 2019
androidx.navigation:navigation-*:2.1.0 is released. The commits included in this version can be found here.
Important changes since 2.0.0
- Scoping ViewModels to a navigation graph: You can now create ViewModels that are scoped at the navigation graph level using the
by navGraphViewModels()property delegate for Kotlin users using the-ktxlibraries or by using thegetViewModelStoreOwner()API added toNavController. See Share UI-related data between destinations for more information. - Dialog destinations: You can now create
<dialog>destinations that will show aDialogFragmentwhen younavigateto them.NavHostFragmentsupports dialog destinations by default. See Create a destination from a DialogFragment for more information. - Navigating by Uri: You can now
navigateusing aUri, which uses the<deepLink>you’ve added to a destination to navigate there. See Navigate using Uri for more information. - NavHostController: APIs used specifically for constructing a custom
NavHosthave been moved toNavHostController, allowing implementations to connect theirNavControllerto the hostingLifecycleOwner,OnBackPressedDispatcher, andViewModelStore.
Version 2.1.0-rc01
August 7, 2019
androidx.navigation:navigation-*:2.1.0-rc01 is released. The commits included in this version can be found here.
API changes
- The deprecated
getViewModelStore()API onNavControllerintroduced in2.1.0-alpha02has been removed. (aosp/1091021)
Version 2.1.0-beta02
July 19, 2019
androidx.navigation:*:2.1.0-beta02 is released. The commits included in this version can be found here.
Bug fixes
- Removed unintentional jacoco dependency that was introduced in
2.1.0-beta01. (b/137782950)
Version 2.1.0-beta01
July 17, 2019
androidx.navigation:*:2.1.0-beta01 is released. The commits included in this version can be found here.
New features
NavigationUInow animates the removal of the Up button when usingsetupWithNavController()with aToolbarorCollapsingToolbarLayout. (b/131403621)
Bug fixes
- Fixed a timing issue when using multiple NavHostFragments with the same container with
findNavController(). (b/136021571)
Version 2.1.0-alpha06
July 2, 2019
androidx.navigation:*:2.1.0-alpha06 is released. The commits included in this version can be found here.
New features
- The
app:navGraphattribute used by NavHostFragment has now been moved to thenavigation-runtimeartifact. Custom navigators that can be added via XML should use this attribute to gain integration with the Navigation Editor’s Host panel. (b/133880955)
API changes
- The
getViewModelStore()API onNavControllerhas been deprecated in favor of the newgetViewModelStoreOwner()method that returns aViewModelStoreOwner. (aosp/987010) - The implementation of floating window destinations, such as
<dialog>destinations, has been generalized into a marker interface,FloatingWindow, that all<dialog>destinations now implement. NavigationUI methods for interacting with the top app bar now ignoreFloatingWindowdestinations. (b/133600763)
Behavior changes
- Navigation now correctly keeps its state in sync with what is seen on the screen when using a
<dialog>destination. As a consequence, Navigation now automatically pops<dialog>destinations when you navigate to a non-dialog and non-activity destination, such as a<fragment>destination. (b/134089818)
Bug fixes
- Navigation now suppresses the animation that occurs when recreating the activity when handling a deep link, fixing a visual flash. (b/130362979)
- Fixed a bug where the Navigation back stack would be out of sync when popping a Fragment as the initial fragment is being added. (b/133832218)
Version 2.1.0-alpha05
June 5, 2019
androidx.navigation:*:2.1.0-alpha05 is released. The commits included in this version can be found here.
API changes
- Host related APIs on
NavControllerhave been renamed and moved to a new subclass ofNavController,NavHostController. (aosp/966091) - The
NavControllersetHostOnBackPressedDispatcherOwner()method has been replaced withNavHostController’ssetOnBackPressedDispatcher()method and now requires that you callsetLifecycleOwner()prior to calling it. (aosp/965409) NavHostControllernow contains aenableOnBackPressed(boolean)method that replaces theNavHostOnBackPressedManagerclass that was previously returned bysetHostOnBackPressedDispatcherOwner(). (aosp/966091)
Bug fixes
- Fixed an issue where the back stack was not correct after navigating by URI. (b/132509387)
- Deep links automatically handled by NavController now only trigger once. (b/132754763)
Version 2.1.0-alpha04
May 16, 2019
androidx.navigation:*:2.1.0-alpha04 is released. The commits included in this version can be found here.
Bug fixes
NavHostFragmentcorrectly respectsapp:defaultNavHostwhen intercepting the system Back button events, fixing a regression in Navigation2.1.0-alpha03. b/132077777DialogFragmentNavigatornow correctly handlespopBackStack()andnavigateUp()operations. b/132576764- Fixed an
IllegalStateException: unknown destination during restoreissue when repeatedly navigating between nested graphs. b/131733658
Version 2.1.0-alpha03
May 7, 2019
androidx.navigation:*:2.1.0-alpha03 is released. The commits included in this version can be found here.
Known Issues
- NavHostFragment continues to intercept the system Back button despite using
app:defaultNavHost="false"b/132077777
New features
- You can now create
<dialog>destinations that will show aDialogFragmentwhen younavigateto them.NavHostFragmentsupports dialog destinations by default. b/80267254 - In addition to calling
navigatewith a resource id or aNavDirectionsinstance, you can now navigate via aUri, which uses the<deepLink>you’ve added to a destination to navigate to the correct destination. b/110412864
Behavior changes
- The default animations provided by NavigationUI have been sped up from 400ms to 220ms to match the default animation speed of activities and fragments. b/130055522
API changes
- The
createFragmentNavigator()method ofNavHostFragmenthas been deprecated and its functionality moved to the newonCreateNavController()method to make it more clear that this is the correct entry point of adding custom Navigators when subclassingNavHostFragment. b/122802849 - A
hasDeepLink()method has been added toNavDestinationto allow you to check if a givenUrican be handled by that destination or, in the case of aNavGraph, any destination in the navigation graph. b/117437718
Bug fixes
- Default arguments are now correctly passed to
OnDestinationChangedListenerinstances. b/130630686 NavHostFragmentnow intercepts system Back events using theOnBackPressedDispatcher, fixing an issue when doing conditional navigation in Fragment lifecycle methods upon returning to a Fragment. b/111598096- For Safe Args, an
android:defaultValue=”@null”with an unspecifiedapp:argTypeis now properly inferred as astringargument. b/129629192
Version 2.1.0-alpha02
April 3, 2019
androidx.navigation:*:2.1.0-alpha02 is released. The commits included in this version can be found here.
New features
- You can now create ViewModels that are scoped at a navigation graph level via the
by navGraphViewModels()property delegate for Kotlin users or by using thegetViewModelStore()API added toNavController. b/111614463
API changes
- You can now add an
app:targetPackageto an<activity>destination to limit the matching package name. It supportsapp:targetPackage="${applicationId}"for restricting the package to your own application id. b/110975456
Bug fixes
- The
android:namefor<activity>destinations is no longer parsed into a Class at inflation time, preventing ClassNotFoundExceptions when using dynamic features. b/124538597
Version 2.1.0-alpha01
March 19, 2019
This is the first alpha release of Navigation 2.1.0.
Dependency changes
- Navigation now depends on
androidx.core:core:1.0.1andandroidx.fragment:fragment:1.1.0-alpha05. This release also removes the dependency onandroidx.legacy:legacy-support-core-utils:1.0.0. b/128632612
API Changes
- A new
Navigation.createNavigateOnClickListener(NavDirections)method has been added as an alternative to creating a click listener with a resource ID and Bundle. b/127631752 FragmentNavigator.instantiateFragmentis now deprecated. The default implementation now usesFragmentFactoryto instantiate Fragments. b/119054429
Bug Fixes
- Navigation no longer sends a null
Bundlewhen there are arguments attached to a destination, fixing an issue when usingandroid:defaultValue="@null". b/128531879 - Safe Args now depends on KotlinPoet 1.1.0, fixing an issue with extremely long package names. b/123654948
Version 2.0.0
Version 2.0.0
March 14, 2019
Navigation 2.0.0 is released with no changes from 2.0.0-rc02.
Version 2.0.0-rc02
March 6, 2019
Navigation 2.0.0-rc02 provides new artifacts with the androidx.navigation
group ID and changes its dependencies to the AndroidX equivalents.
The behavior of 2.0.0-rc02 is identical to behavior to Navigation 1.0.0-rc02 and no changes to your code should be required to update from 1.0.0-rc02 besides updating your dependencies to match the new dependencies.
Your project must have migrated to AndroidX to use 2.X releases of Navigation. Navigation 1.0 stable will be the last release using the Support Library dependencies; all future development beyond 1.0 will be based on AndroidX and build upon the 2.0 stable release.
Pre-AndroidX Dependencies
For the pre-AndroidX versions of Navigation, include these dependencies:
dependencies {
def nav_version = "1.0.0"
implementation "android.arch.navigation:navigation-fragment:$nav_version" // For Kotlin use navigation-fragment-ktx
implementation "android.arch.navigation:navigation-ui:$nav_version" // For Kotlin use navigation-ui-ktx
}
For Safe args, add the
following classpath in your top level build.gradle file
buildscript {
repositories {
google()
}
dependencies {
classpath "android.arch.navigation:navigation-safe-args-gradle-plugin:1.0.0"
}
}
Version 1.0.0
Version 1.0.0
March 14, 2019
Navigation 1.0.0 is released with no changes from 1.0.0-rc02.
Version 1.0.0-rc02
February 26, 2019
This is the second release candidate for Navigation's 1.0.0 stable release. This release contains a number of bug fixes.
Bug Fixes
- Fixed an issue where
popBackStack()would be ignored if the root graph did not have an ID b/126251695 navigateUp()now correctly handles navigating back to your app's task when called after handling a deep link withoutFLAG_ACTIVITY_NEW_TASKb/126082008- Fixed an issue with
ActivityNavigator.applyPopAnimationsToPendingTransitionnot applying the correct pop exit animation b/126237567 - Kotlin code generated by Safe Args now properly escapes Kotlin keywords
such as
inandfunin the package name associated with theRclass. b/126020455
Version 1.0.0-rc01
February 21, 2019
This is a release candidate for Navigation's 1.0.0 stable release. This release contains one bug fix.
Bug Fixes
- Fixed an issue when using Fragments and
singleTopnavigation operations b/124294805
Version 1.0.0-beta02
February 12, 2019
This release includes a number of minor improvements and important bug fixes.
New Features
- You can now use
0as anandroid:defaultValueforreferencearguments. b/124248602
Behavior changes
- Exact deep link matches are now prioritized over deep links with
.*or argument matches. b/123969518
Bug Fixes
popBackStack()andnavigateUpnow correctly returnfalsewhen popping the last destination on the back stack, fixing a regression introduced in1.0.0-beta01. b/123933201- Navigation now correctly sets the
ClassLoaderduring restoration of saved instance state, avoiding issues when using custom classes inNavigatorsaved state or in arguments sent to aNavDestination. b/123893858 - Safe Args generated NavArgs classes no longer crash when restoring a
Parcelable[]argument from saved instance state. b/123963545 - Safe Args now properly cleans up unnecessary generated Kotlin classes. b/124120883
Version 1.0.0-beta01
February 4, 2019
This is the first beta release of Navigation; moving forward, the Navigation API is expected to stay stable until the next version unless there is a critical problem. This release contains some bug fixes and behavior changes.
Behavior changes
- Navigation now ensures that argument default values are treated identically
at runtime and through Safe Args. As a consequence, only arguments with an
app:argType="reference"can have a default value point to another resource (for example,@color/colorPrimary). Attempting to use a reference default value with a differentapp:argTypewill result in an exception when parsing the navigation XML. b/123551990 - Safe Args now depends on Android Gradle Plugin 3.3.0 aosp/888413
- Safe Args now depends on Kotlin 1.3.20 aosp/888414
Bug Fixes
- Safe Args can now be used in library and feature modules on all versions of the Android Gradle Plugin. b/121304903
- Fixed a regression that would cause a single
popBackStack()operation to pop all copies of a destination off the top of the back stack, rather than just a single destination at a time. b/123552990 - Fixed an issue where the
FragmentNavigatorstate would desynchronize with theNavController's state, causing anIllegalStateExceptionwhen attempting to restore the back stack. b/123803044 - Fixed an issue where the
NavigationUIhandled back arrow would not appear when using ProGuard with obfuscation. b/123449431 - The code generated by Safe Args now properly handles using an
app:argTypepointing to a static inner class in the format.OuterClass$InnerClass. b/123736741 - The Java code generated by Safe Args now properly handles global actions and deeply nested destinations. b/123347762
Version 1.0.0-alpha11
January 23, 2019
This is a hotfix release of 1.0.0-alpha10 that fixes an issue with Safe Args.
Bug Fixes
- Fixes an issue where Safe Args would fail to import the Directions class associated with global actions. b/123307342
Version 1.0.0-alpha10
January 23, 2019
Known Issues
- Safe Args fails to import the Directions class associated with global actions. b/123307342
This release contains breaking API changes; please see the Breaking Changes section below.
New Features
- Kotlin users can now use the
by navArgs()property delegate to lazily get a reference to a Safe Args generatedNavArgsclass in anActivityorFragment. b/122603367 - Safe Args now allows you to generate Kotlin code by applying the
androidx.navigation.safeargs.kotlinplugin. The Kotlin code is built specifically for Kotlin only modules, using default arguments and immutable classes over the builder pattern that is still available via the previousandroidx.navigation.safeargsplugin. b/110263087
Behavior Changes
- Matching deep links are now biased towards the deep link that has the most matching arguments. b/118393029
- Calling
setGraph()on aNavControllerwill now reset the back stack. b/111450672 - Unknown deep links no longer throw an
IllegalStateException, but are ignored, fixing issues with nested or multipleNavHostFragments. b/121340440
Breaking Changes
- The
NavOptions.applyPopAnimationsToPendingTransition()method for applying pop animations to an Activity has been moved toActivityNavigator. b/122413117 - Safe Args now avoids duplicating identical classes for actions without
arguments. The return type for no argument methods in generated NavDirections
classes is now
NavDirections. b/123233147 - Safe Args generated Directions classes no longer have a public constructor - you should only be interacting with the generated static methods. b/123031660
- Safe Args generated
NavDirectionsclasses no longer have a public constructor - they should only be generated via the static methods in the generated Directions classes. b/122963206 - The returned
BundlefromNavDirections'getArguments()is now marked as@NonNullrather than@Nullable. b/123243957
Bug Fixes
NavDeepLinkBuildernow correctly handles multiple simultaneousPendingIntents to the same destination by using the arguments you pass in to determine the uniqueness. b/120042732NavControllernow correctly handlespopBackStack()operations when using a nestedNavHostFragmentor other child Fragments with a back stack. b/122770335NavigationUInow correctly sets the content description of the Up button. b/120395362- Safe Args generated Directions classes now correctly handle global actions that have the same id as an action on a destination. b/122962504
- Safe Args generated
NavDirectionsclasses now correctly have equalhashCode()values whenequals()would return true. b/123043662 FragmentNavigatornow throws a better error message if you attempt to do customFragmentTransactionson theNavHostFragment'sFragmentManager. You should always usegetChildFragmentManager(). b/112927148
Version 1.0.0-alpha09
December 18, 2018
This release contains breaking API changes; please see the Breaking Changes section below.
We have chosen not to continue development of the
android.arch.navigation:navigation-testing artifact. While it has proven
helpful for internal testing of NavController, we strongly recommend
alternate testing strategies, such as mocking the NavController instance
in order to verify that the correct navigate() calls are being done. This
approach is discussed in detail in the
Single Activity talk at AndroidDevSummit 2018
and we'll be working on additional documentation specifically around testing
with Navigation.
New Features
MenuItems withmenuCategory="secondary"will no longer pop the back stack when used withNavigationUImethods. b/120104424AppBarConfigurationnow allows you to set a fallbackOnNavigateUpListenerinstance which will be called whennavController.navigateUp()returnsfalse. b/79993862 b/120690961
Breaking Changes
- When using an
<argument>with anargType="reference", Navigation no longer parses the reference, instead providing the raw resource ID itself. b/111736515 onNavDestinationSelected()now pops back to the start destination of your navigation graph by default, making them consistent with thesetupmethods. AddmenuCategory="secondary"to yourMenuItemto avoid popping the back stack. aosp/852869- The
fromBundle()methods of generatedArgsclasses now take a non-nullBundleinstead of a nullableBundleaosp/845616
Bug Fixes
- Arguments are now properly parsed from deep links as the correct
argTypeinstead of always as strings b/110273284 - Navigation now correctly exports its public resources b/121059552
- Safe Args is now compatible with Android Gradle Plugin 3.4 Canary 4 and higher b/119662045
Version 1.0.0-alpha08
December 6, 2018
This release contains breaking API changes; please see the Breaking Changes section below.
New Features
- Destination labels, when used with
NavigationUImethods, will now automatically replace{argName}instances in yourandroid:labelwith the correct argument b/80267266 - Navigation now depends on Support Library 28.0.0 b/120293333
Breaking Changes
OnNavigatedListenerhas been renamed toOnDestinationChangedListenerb/118670572OnDestinationChangedListenernow also passes theBundleof arguments aosp/837142- The
app:clearTaskandapp:launchDocumentattributes and their associated methods have been removed. Useapp:popUpTowith the root of your graph to remove all destinations from your back stack. b/119628354 ActivityNavigator.Extrasnow uses aBuilderpattern and adds the ability to set anyIntent.FLAG_ACTIVITY_flags aosp/828140NavController.onHandleDeepLinkhas been renamed tohandleDeepLinkaosp/836063- Many classes and methods not meant for subclassing, such as
NavOptions,NavInflater,NavDeepLinkBuilder, andAppBarConfiguration, have been madefinalaosp/835681 - The deprecated
NavHostFragment.setGraph()method has been removed aosp/835684 - The deprecated
NavigationUI.navigateUp(DrawerLayout, NavController)method has been removed. aosp/835684 - Fragment creation has been moved to
FragmentNavigator, making it easier to delegate Fragment creation to aFragmentFactory. b/119054429 - The constructor for
NavGraphNavigatorno longer takes aContextaosp/835340 - NavigatorProvider is now
a class, rather than an interface. The
NavigatorProviderreturned bygetNavigatorProvider()has not changed its functionality. aosp/830660 NavDestination.navigate()has been removed. Callnavigate()on theNavigatorinstead. aosp/830663- Significant refactoring of
Navigator, removing the need forOnNavigatorNavigatedListenerand instead havingnavigatereturn theNavDestinationthat was navigated to. Navigatorinstances can no longer send pop events to theNavController. Consider using aOnBackPressedCallbackto intercept back button presses and callnavController.popBackStack(). aosp/833716
Bug Fixes
popUpTonow works consistently when the destination is a<navigation>element b/116831650- Fixed a number of bugs that resulted in an
IllegalArgumentExceptionwhen using nested graphs b/118713731 b/113611083 b/113346925 b/113305559 - The
dataPatternattribute of<activity>destinations will now populate arguments from non-String arguments by callingtoString()b/120161365
Safe Args
- Safe Args supports Serializable objects, including Enum values. Enum types
can set a default value by using the enum literal without the class name
(e.g.
app:defaultValue="READ") b/111316353 - Safe Args supports arrays of all supported types b/111487504
- Safe Args now ignores subfolders of resource directories b/117893516
- Safe Args adds
@Overrideannotations where appropriate b/117145301
Version 1.0.0-alpha07
October 29, 2018
New Features
- A new AppBarConfiguration class allows you to customize which destinations are considered top-level destinations. See the updated documentation for details. b/117333663
- You can now pass arguments to the start destination of your graph b/110300470
- Deep links now support custom schemes with periods, hyphens, and plus signs. b/112806402
Breaking Changes
- The
navigation-testing-ktxmodule has been folded into thenavigation-testing artifactand will no longer be published. - The
navigation-testingartifact now has a dependency on the Kotlin standard library. The API has been changed to be more consistent with Kotlin conventions, but you can continue to use it for tests written in Java. - Metadata manifest registered navigation graphs are no longer supported. b/118355937
- Actions can no longer be attached to <activity> destinations. aosp/785539
Bug Fixes
- Deep links now correctly parse query parameters. b/110057514
- Activity destinations now correctly apply all enter and exit animations. b/117145284
- Fixed crash that occurs after configuration changes when using custom Navigators. b/110763345
Safe Args
- Safe args now have a fixed dependency on Android Gradle Plugin 3.2.1. b/113167627
- Directions can now be generated for inner classes. b/117407555
- Fixed an issue with generating Directions to an <include> graph. b/116542123
Version 1.0.0-alpha06
September 20, 2018
New Features
- Shared Element Transitions for Fragment and Activity destinations are now supported b/79665225. For more information, see Implement navigation with the Navigation Architecture Component
- Selecting an item in
NavigationViewwill now close any containing bottom sheet b/112158843
API Changes
- Breaking Change: The Navigator
navigate()method now takes aNavigator.Extrasparameter. - NavController's
getGraph()method is nowNonNullb/112243286
Bug Fixes
NavigationUI.setupWithNavController()no longer leaks views if used with views from individual destinations b/111961977- Navigator
onSaveState()is now only called once b/112627079
Safe Args
- Navigation destination Directions classes now extend their parent's Directions class if it exists b/79871405
- Directions and Args classes now have a useful
toString()implementation b/111843389
Version 1.0.0-alpha05
August 10, 2018
Bug Fixes
- Fix a bug which cause incorrect backstack behavior. b/111907708
- Fix a bug in
equals()of Generated Args classes. b/111450897 - Fix a build failure in Safe Args. b/109409713
- Fix a conversion from resource identifiers to java names b/111602491
- Fix error messages about nullability in Safe Args plugin.
- Add missing nullability annotations.
Version 1.0.0-alpha04
July 19, 2018
Navigation 1.0.0-alpha04 and the associated Safe Args gradle plugin contains a number of API changes, behavior changes, and bug fixes.
API / Behavior Changes
- NavHostFragment will always set the current Fragment as the primary navigation fragment, ensuring that child fragment managers are popped before the outer NavController is popped b/111345778
Safe Args
- Breaking Change:
app:typehas been changed toapp:argTypeto avoid conflicts with other libraries such as ConstraintLayout 2.0.0-alpha1 b/111110548 - Error messages from Safe Args are now clickable b/111534438
- Args classes now confirms that
NonNullattributes are actually not null b/111451769 - Additional
NonNullannotations have been added to NavDirections and Args generated classes b/111455455 b/111455456
Bug Fixes
- Fixed an issue with the system back button after deep linking to a fragment destination b/111515685
Version 1.0.0-alpha03
July 12, 2018
Navigation 1.0.0-alpha03 and the associated Safe Args gradle plugin contains a number of API changes, behavior changes, and bug fixes.
API / Behavior Changes
- A NavigationUI.setupWithNavController method for Toolbar has been added b/109868820
- A NavigationUI.setupWithNavController method for CollapsingToolbarLayout has been added b/110887183
- popBackStack() now returns false when the back stack is empty or when the given destination ID is not in the back stack b/110893637
- FragmentNavigator now ignores navigation operations after FragmentManager has saved state, avoiding “Can not perform this action after onSaveInstanceState” exceptions b/110987825
Safe Args
- Breaking Change: Non-alphanumeric characters in action and argument names will be replaced by camel casing in the respective NavDirections method names
- E.g.
DemoController.indexwill becomesetDemoControllerIndexb/79995048 - E.g.
action_show_settingswill becomeactionShowSettingsb/79642240
- E.g.
- Breaking Change: Arguments are now considered non-null by default. To allow null values on string and parcelable arguments, add
app:nullable="true"b/79642307 - You can now use
app:type="long"with defaultValues in the form of “123L” b/79563966 - Parcelable arguments are now supported, using a fully qualified class name for
app:type. The only default value supported is"@null"b/79563966 - Args classes now implement
equals()andhashCode()b/79642246 - The Safe Args plugin can now be applied to library projects b/80036553
- The Safe Args plugin can now be applied to feature projects b/110011752
Bug Fixes
- Fixed issues when navigating during Fragment lifecycle methods b/109916080
- Fixed issues when navigating through nested graphs multiple times b/110178671
- Fixed issues when using
setPopUpTowith the first destination in the graph b/109909461 - Fixed issue where all
app:defaultValuevalues were being passed as Strings b/110710788 - aapt2 bundled with Android Gradle Plugin 3.2 Beta 01 now adds keep rules for every
android:nameattribute in Navigation XML files b/79874119 - Fixed memory leak when replacing the default FragmentNavigator b/110900142
Version 1.0.0-alpha02
June 7, 2018
Behavior Changes
FragmentNavigatornow usessetReorderingAllowed(true). b/109826220Navigation now URLDecodes arguments parsed from deep links URLs. b/79982454
Bug Fixes
Fixed an
IllegalStateExceptionwhen calling navigate from Fragment lifecycle methods. b/79632233Navigation now depends on Support Library 27.1.1 to fix flickering when using animations. b/80160903
Fixed an
IllegalArgumentExceptionwhen using defaultNavHost="true" as a child fragment. b/79656847Fixed a
StackOverflowErrorwhen using NavDeepLinkBuilder. b/109653065Fixed an
IllegalArgumentExceptionwhen navigating back to a nested graph. b/80453447Fixed an issue with overlapping Fragments when using
launchSingleTop. b/79407969Navigation now builds the correct synthetic back stack for nested graphs. b/79734195
NavigationUI will now highlight the correct item when using a nested graph as a
MenuItem. b/109675998
API Changes
The
clearTaskattribute for actions and the associated API inNavOptionshas been deprecated. b/80338878The
launchDocumentattribute for actions and the associated API inNavOptionshas been deprecated. b/109806636
Version 1.0.0-alpha01
May 8, 2018
Navigation provides a framework for building in-app
navigation. This initial release is 1.0.0-alpha01.