# ViewModelStoreNavEntryDecoratorDefaults

Artifact: [androidx.lifecycle:lifecycle-viewmodel-navigation3](https://developer.android.com/jetpack/androidx/releases/lifecycle) [View Source](https://cs.android.com/search?q=file:androidx/lifecycle/viewmodel/navigation3/ViewModelStoreNavEntryDecorator.kt+class:androidx.lifecycle.viewmodel.navigation3.ViewModelStoreNavEntryDecoratorDefaults) Added in [2.10.0](https://developer.android.com/jetpack/androidx/releases/lifecycle#2.10.0) Deprecated in [2.11.0](https://developer.android.com/jetpack/androidx/releases/lifecycle#2.11.0) Common/All
- Cmn

  ```
  object ViewModelStoreNavEntryDecoratorDefaults
  ```

*** ** * ** ***

> [!CAUTION]
> **This object is deprecated.**   
> This object is obsolete. The removeViewModelStoreOnPop parameter was a workaround for detecting configuration changes, which are now handled internally. To preserve decorator state outside of a NavDisplay, use the rememberDecoratedNavEntries API.

Holds the default functions for the `https://developer.android.com/reference/kotlin/androidx/lifecycle/viewmodel/navigation3/ViewModelStoreNavEntryDecorator`.

## Summary

| ### Public functions |
|---|---|---|
| `() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable [removeViewModelStoreOnPop](https://developer.android.com/reference/kotlin/androidx/lifecycle/viewmodel/navigation3/ViewModelStoreNavEntryDecoratorDefaults#removeViewModelStoreOnPop())()` **This function is deprecated.** This object is obsolete. | Cmn |

## Public functions

### removeViewModelStoreOnPop

Cmn Added in [2.10.0](https://developer.android.com/jetpack/androidx/releases/lifecycle#2.10.0) Deprecated in [2.11.0](https://developer.android.com/jetpack/androidx/releases/lifecycle#2.11.0)

```
@Composable
fun [removeViewModelStoreOnPop](https://developer.android.com/reference/kotlin/androidx/lifecycle/viewmodel/navigation3/ViewModelStoreNavEntryDecoratorDefaults#removeViewModelStoreOnPop())(): () -> Boolean
```

> [!CAUTION]
> **This function is deprecated.**   
> This object is obsolete. The removeViewModelStoreOnPop parameter was a workaround for detecting configuration changes, which are now handled internally. To preserve decorator state outside of a NavDisplay, use the rememberDecoratedNavEntries API.

Controls whether the `https://developer.android.com/reference/kotlin/androidx/lifecycle/viewmodel/navigation3/ViewModelStoreNavEntryDecorator` should clear the ViewModelStore scoped to a `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/NavEntry` when `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/NavEntryDecorator#onPop()` is invoked for that `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/NavEntry`'s `https://developer.android.com/reference/kotlin/androidx/navigation3/runtime/NavEntry#contentKey()`

The ViewModelStore is cleared if this returns true. The store is retained if false.