am a bit confused with `hilt-navigation` documenta...

# compose

[Marko Novakovic]

am a bit confused with hilt-navigation documentation.

inline fun <reified VM : ViewModel> hiltViewModel()

and

internal fun <VM : ViewModel> hiltViewModel(
    kClass: KClass<VM>,
    backStackEntry: NavBackStackEntry
)

and
hiltNavGraphViewModel() documentation says that it gets or creates ViewModel scoped to the current navigation graph. as far as I know and what I see in code if current ViewModelStoreOwned is NavBackStackEntry, which composables in graph are, ViewModel is scoped to NavBackStackEntry.

hiltViewModel<HomeViewModel>(backStackEntry)

and

hiltViewModel<HomeViewModel>()

should be the same right? it scopes ViewModel to current back stack entry?

[Ian Lake]

Correct, by default, hiltViewModel() will scope the ViewModel to the current NavBackStackEntry i.e., your current composable destination. If you use navController.getBackStackEntry("your_nav_graph_route") and pass that NavBackStackEntry to hiltViewModel(), then the ViewModel will be scoped to that navigation graph - navigation graphs, just like composable destinations, are on the back stack and have their own NavBackStackEntry

[Ian Lake]

We talk about that more in the existing Navigation docs, specifically https://developer.android.com/guide/navigation/navigation-programmatic#navbackstackentry and https://developer.android.com/guide/navigation/navigation-programmatic#share_ui-related_data_between_destinations_with_viewmodel

[Marko Novakovic]

I am still a bit confused with hiltViewModel(backStackEntry) being scoped to graph but I will take a look at links, maybe I will understand better then

[Ian Lake]

Yeah, graph is the wrong term here. It is anything on the navigation back stack

[Ian Lake]

You can file a bug against Hilt to update their docs: https://issuetracker.google.com/issues/new?component=874079

[Marko Novakovic]

thank you very much