CreationExtras must have a value by `SAVED_STATE_REGISTRY_OWNER_KEY`

Question

I'm trying to implement navigation in my app which is built with Jetpack Compose, but when I try to navigate from a screen to another I get:

java.lang.IllegalArgumentException: CreationExtras must have a value by SAVED_STATE_REGISTRY_OWNER_KEY

I'm using:

implementation "androidx.hilt:hilt-navigation-compose:1.0.0"

And here is the code:

if(viewModel.isAuthenticated) {
    navController.navigate(Screen.Profile.route)
}

For me this issue is resolved by updating to version `1.1.0-alpha01` of the hilt navigation compose library — MEX, Feb 03 '23 at 10:49
@MEX It also works that way, I tested it. If you want, you can post it as an answer. — Joan P., Feb 04 '23 at 08:50

score 51 · Answer 1 · edited May 31 '23 at 12:38

51

@Dragan.T 's answer is correct.

Adding

implementation "androidx.navigation:navigation-compose:2.5.3

Solved my problem. As for why we need to add, I am not so sure.

Edit: Be sure to replace 2.5.3 with latest version.

edited May 31 '23 at 12:38

Boken

4,825
10
32
42

answered Aug 25 '22 at 12:42

Zeeshan Ali

623
1
5
10

I cannot see any reason why we need another dependency as long as we are using one that provides everything that is necessary. – Joan P. Aug 26 '22 at 06:58
You are using hilt navigation not compose navigation so maybe hilt navigation provides stuff only related to hilt injection not for compose viewmodel creation. I am also not sure about this but the solution did work – Zeeshan Ali Aug 26 '22 at 13:31
It already provides stuff for navigation, so it's not about that. – Joan P. Aug 27 '22 at 09:09
1

It worked for me too, 2.4.2 had problem but it was removed after I changed to 2.5.1. – Isaac Lee Oct 09 '22 at 01:41

score 21 · Answer 2 · answered Sep 10 '22 at 22:04

21

If you use Compose with Fragments, then you may not have the Fragments dependency where viewModels() is defined.

Adding:

implementation "androidx.fragment:fragment-ktx:1.5.2"

to my build.grade script fixed it for me (previously this was a transitive dependency).

answered Sep 10 '22 at 22:04

Patrick

855
8
12

Agree, my project was using pure Hilt+Fragments+viewModels() (No navigation components yet) and I have got a runtime error "java.lang.IllegalArgumentException: CreationExtras must have a value by SAVED_STATE_REGISTRY_OWNER_KEY" in the line where Hilt was injecting the viewModel by viewModels()/ Simply updating the androidx.fragment:fragment-ktx library from 1.4.1 to 1.5.2 fixed the error. – Alex Burov Nov 09 '22 at 19:33
This worked for me. I'm not using Jetpack Compose, but I am using `Hilt+Fragments+viewModels()` like the above person. I needed this. Wish Hilt document mentioned this. Thank you. – Saehun Sean Oh Feb 22 '23 at 19:19

score 20 · Accepted Answer · answered Dec 08 '22 at 18:26

20

Hilt release notes for 2.43 flags a dependency incompatibility:

As part ViewModel bug fixes, dependencies were updated as below. androidx.navigation users will need to update to 2.5.0 to interoperate. These libraries require building with SDK 31. To build with SDK 31, AGP users will need to use AGP 7.0+. This will also require using JDK11.

androidx.activity and androidx.fragment to 1.5.0

androidx.lifecycle to 2.5.0

androidx.savedstate to 1.2.0

answered Dec 08 '22 at 18:26

Sofi Software LLC

3,879
1
36
34

Finally they solved the problem. Thank you for answering this question. – Joan P. Dec 09 '22 at 07:22

score 17 · Answer 4 · answered Aug 16 '22 at 21:11

17

Insert implementation "androidx.navigation:navigation-compose:2.5.1" into your gradle file. If you already have it, be sure it's updated with the latest (2.5.1) version.

answered Aug 16 '22 at 21:11

Dragan.T

317
1
5

1

Thanks for taking the time to answer the question. But why would I add another dependency since I already have one? Hilt already provides all the necessary methods for navigation, right? – Joan P. Aug 17 '22 at 10:43
1

Hilt-navigation-compose library just provide methods and annotations for creating necessary scopes and init navigation graph with dependency injection, but you should add "androidx.navigation:navigation-compose:2.5.1" for working with compose nav. – Dragan.T Aug 19 '22 at 12:32
1

`androidx.hilt:hilt-navigation-compose:1.0.0` already contains a navigate method, I have no error in code. It just simply complains when I need to navigate from one screen to another. – Joan P. Aug 20 '22 at 10:07

score 7 · Answer 5 · answered Feb 06 '23 at 10:46

7

This issue is resolved by updating to version 1.1.0-alpha01 of the hilt navigation compose library.

answered Feb 06 '23 at 10:46

MEX

2,664
5
22
28

score 4 · Answer 6 · answered Jun 23 '23 at 11:53

Just adding this to your app/build.gradle fixed this issue:

implementation 'androidx.navigation:navigation-compose:2.6.0'

Example:

dependencies {

    // ...
    implementation 'androidx.hilt:hilt-navigation-compose:1.0.0'
    implementation 'androidx.navigation:navigation-compose:2.6.0'
}

score 2 · Answer 7 · answered Nov 17 '22 at 06:33

In my case I had to upgrade two dependencies: Hilt and androidx.navigation. The curious issue is that after upgrading it, the error is gone, but if I downgrade again to previous versions, the error doesn't appear again. These are the dependencies I changed:

    navigation_version = "2.5.3" // was 2.5.1
    dagger_hilt_version = "2.44.2" // was 2.43.2

    implementation "androidx.navigation:navigation-fragment-ktx:$navigation_version"
    implementation "androidx.navigation:navigation-ui-ktx:$navigation_version"
    implementation "androidx.navigation:navigation-dynamic-features-fragment:$navigation_version"
    androidTestImplementation "androidx.navigation:navigation-testing:$navigation_version"

    implementation "com.google.dagger:hilt-android:$dagger_hilt_version"
    kapt "com.google.dagger:hilt-android-compiler:$dagger_hilt_version"
    testImplementation "com.google.dagger:hilt-android-testing:$dagger_hilt_version"
    kaptTest "com.google.dagger:hilt-android-compiler:$dagger_hilt_version"
    androidTestImplementation "com.google.dagger:hilt-android-testing:$dagger_hilt_version"
    kaptAndroidTest "com.google.dagger:hilt-android-compiler:$dagger_hilt_version"

score 2 · Answer 8 · answered Jun 07 '23 at 02:35

2

In my case I had to update the

implementation 'androidx.navigation:navigation-fragment-ktx:2.4.2'

to

implementation 'androidx.navigation:navigation-fragment-ktx:2.5.3'

answered Jun 07 '23 at 02:35

Edwin Paz ss. -

177
2
5

this answer worked for me! – Ahmed Nabil Jun 30 '23 at 16:11

score 0 · Answer 9 · answered Oct 05 '22 at 17:48

0

You can to continue use this library:

androidx.hilt:hilt-navigation-compose:1.0.0

Only you are sure that ViewModel is initialized in a Composable that is root in your activity. For example:

    setContent {
        AndroidLearningTheme {
            Surface(
                modifier = Modifier.fillMaxSize(),
                color = MaterialTheme.colors.background
            ) {
                HeroesScreen()
            }
        }
    }

Your Composable

@Composable
fun HeroesScreen(
    viewModel: HeroesViewModel = hiltViewModel()
)

answered Oct 05 '22 at 17:48

Carlos Buruel Ortiz

1
1

Oh, thank you Carlos for taking the time to answer this unsolved issue. I didn't try it yet. So, let's it works, how about the other composables? – Joan P. Oct 06 '22 at 05:06
I tried to create the ViewModel only inside the activity and pass them as parameter, but it doesn't work either. I get the same error :( – Joan P. Oct 06 '22 at 05:24
Sorry, don't worries, maybe I need more code for to replicate the error, can you share the repository project with error? @JoanP. – Carlos Buruel Ortiz Oct 06 '22 at 17:06

score 0 · Answer 10 · answered Mar 03 '23 at 10:10

I faced this error due to ViewModelProviders and after spending a long time and changing to ViewModelProvider than it get fixed

ViewModelProviders is deprecated

Old:

ViewModelProviders.of(context, context.defaultViewModelProviderFactory)
    .get(XYZViewModel::class.java)

New one fixed:

ViewModelProvider(
    context,
    context.defaultViewModelProviderFactory
)[XYZViewModel::class.java]

score 0 · Answer 11 · answered Apr 15 '23 at 18:01

It seems that updating the versions of the following AndroidX libraries might resolve the issue:

androidx.activity
androidx.fragment
androidx.lifecycle
androidx.savedstate

Alternatively, you could use the following versions:

dependencies {
    implementation 'androidx.lifecycle:lifecycle-viewmodel-ktx:2.4.0'
    implementation 'androidx.savedstate:savedstate:1.2.1'
    implementation 'androidx.lifecycle:lifecycle-common:2.6.1'
    implementation 'androidx.activity:activity-ktx:1.7.0'
    implementation 'androidx.fragment:fragment-ktx:1.5.6'
}

These versions have been tested and found to work well together for me.

score 0 · Answer 12 · answered Apr 29 '23 at 20:24

0

Updating androidx.navigation:navigation-compose library to the current stable version 2.5.3 solved my issue.

answered Apr 29 '23 at 20:24

Jan Kotas

71
1
3

score 0 · Answer 13 · answered May 13 '23 at 20:14

0

For me, adding implementation("androidx.lifecycle.lifecycle-viewmodel-compose:2.6.1") fixed it.

answered May 13 '23 at 20:14

Edward Sills

103
1
3

CreationExtras must have a value by `SAVED_STATE_REGISTRY_OWNER_KEY`

13 Answers13

Example:

Linked