# androidx.hilt.navigation

*** ** * ** ***

## Top-level functions summary

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelProvider.Factory` | `[HiltViewModelFactory](https://developer.android.com/reference/kotlin/androidx/hilt/navigation/package-summary#HiltViewModelFactory(android.content.Context,androidx.lifecycle.ViewModelProvider.Factory))( context: https://developer.android.com/reference/android/content/Context.html, delegateFactory: https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelProvider.Factory )` **This function is deprecated.** Moved to package: androidx.hilt.lifecycle.viewmodel |
| `https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelProvider.Factory` | `https://developer.android.com/reference/kotlin/androidx/hilt/navigation/package-summary#HiltViewModelFactory(android.content.Context,androidx.navigation.NavBackStackEntry)( context: https://developer.android.com/reference/android/content/Context.html, navBackStackEntry: https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry )` Creates a `https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelProvider.Factory` to get [HiltViewModel](https://dagger.dev/api/latest/dagger/hilt/android/lifecycle/HiltViewModel) -annotated `ViewModel` from a `https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry`. |

## Top-level functions

### HiltViewModelFactory

Artifact: [androidx.hilt:hilt-navigation](https://developer.android.com/jetpack/androidx/releases/hilt) [View Source](https://cs.android.com/search?q=file:androidx/hilt/navigation/HiltNavBackStackEntry.kt+function:HiltViewModelFactory) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/hilt#1.1.0) Deprecated in [1.3.0](https://developer.android.com/jetpack/androidx/releases/hilt#1.3.0)

```
fun [HiltViewModelFactory](https://developer.android.com/reference/kotlin/androidx/hilt/navigation/package-summary#HiltViewModelFactory(android.content.Context,androidx.lifecycle.ViewModelProvider.Factory))(
    context: Context,
    delegateFactory: ViewModelProvider.Factory
): ViewModelProvider.Factory
```

> [!CAUTION]
> **This function is deprecated.**   
> Moved to package: androidx.hilt.lifecycle.viewmodel, use this instead:
>
> ```kotlin
> HiltViewModelFactory(context, delegateFactory)
> ```

Creates a `https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelProvider.Factory` to get [HiltViewModel](https://dagger.dev/api/latest/dagger/hilt/android/lifecycle/HiltViewModel) -annotated `ViewModel` from a `https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelProvider.Factory`.

| Parameters |
|---|---|
| `context: https://developer.android.com/reference/android/content/Context.html` | the activity context. |
| `delegateFactory: https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelProvider.Factory` | the delegated factory. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelProvider.Factory` | the factory. |

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-state-exception/index.html` | if the context given is not an activity. |

### HiltViewModelFactory

Artifact: [androidx.hilt:hilt-navigation](https://developer.android.com/jetpack/androidx/releases/hilt) [View Source](https://cs.android.com/search?q=file:androidx/hilt/navigation/HiltNavBackStackEntry.kt+function:HiltViewModelFactory) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/hilt#1.0.0)

```
fun HiltViewModelFactory(
    context: Context,
    navBackStackEntry: NavBackStackEntry
): ViewModelProvider.Factory
```

Creates a `https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelProvider.Factory` to get [HiltViewModel](https://dagger.dev/api/latest/dagger/hilt/android/lifecycle/HiltViewModel) -annotated `ViewModel` from a `https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry`.

| Parameters |
|---|---|
| `context: https://developer.android.com/reference/android/content/Context.html` | the activity context. |
| `navBackStackEntry: https://developer.android.com/reference/kotlin/androidx/navigation/NavBackStackEntry` | the navigation back stack entry. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelProvider.Factory` | the factory. |

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-state-exception/index.html` | if the context given is not an activity. |