androidx.hilt.navigation.fragment

---

Kotlin |Java

Extension functions summary

inline Lazy<VM>	@MainThread <VM : ViewModel> Fragment.hiltNavGraphViewModels(navGraphId: @IdRes Int) Returns a property delegate to access a HiltViewModel -annotated ViewModel scoped to a navigation graph present on the NavController back stack:
inline Lazy<VM>	@MainThread <VM : ViewModel, VMF : Any> Fragment.hiltNavGraphViewModels(     navGraphId: @IdRes Int,     noinline creationCallback: (VMF) -> VM ) Returns a property delegate to access a HiltViewModel -annotated ViewModel with an @AssistedInject-annotated constructor that is scoped to a navigation graph present on the NavController back stack:

Extension functions

hiltNavGraphViewModels

Artifact: androidx.hilt:hilt-navigation-fragment

View Source

@MainThread
inline fun <VM : ViewModel> Fragment.hiltNavGraphViewModels(navGraphId: @IdRes Int): Lazy<VM>

Returns a property delegate to access a HiltViewModel -annotated ViewModel scoped to a navigation graph present on the NavController back stack:

class MyFragment : Fragment() {
    val viewmodel: MainViewModel by hiltNavGraphViewModels(R.navigation.main)
}

This property can be accessed only after this NavGraph is on the NavController back stack, and an attempt access prior to that will result in an IllegalArgumentException.

Parameters
navGraphId: @IdRes Int	ID of a NavGraph that exists on the NavController back stack

hiltNavGraphViewModels

Artifact: androidx.hilt:hilt-navigation-fragment

View Source

@MainThread
inline fun <VM : ViewModel, VMF : Any> Fragment.hiltNavGraphViewModels(
    navGraphId: @IdRes Int,
    noinline creationCallback: (VMF) -> VM
): Lazy<VM>

Returns a property delegate to access a HiltViewModel -annotated ViewModel with an @AssistedInject-annotated constructor that is scoped to a navigation graph present on the NavController back stack:

class MyFragment : Fragment() {
    val viewmodel: MainViewModel by hiltNavGraphViewModels(R.navigation.main) { factory: MainViewModelFactory ->
        factory.create(...)
    }
}

This property can be accessed only after this NavGraph is on the NavController back stack, and an attempt access prior to that will result in an IllegalArgumentException.

Parameters
navGraphId: @IdRes Int	ID of a NavGraph that exists on the NavController back stack
noinline creationCallback: (VMF) -> VM	callback that takes an @AssistedFactory-annotated factory and creates a HiltViewModel using @AssistedInject-annotated constructor.