androidx.lifecycle.viewmodel.navigation3

Kotlin |Java

Classes

ViewModelStoreNavEntryDecorator

Provides the content of a NavEntry with a ViewModelStoreOwner and provides that ViewModelStoreOwner as a LocalViewModelStoreOwner so that it is available within the content.

Cmn

Objects

ViewModelStoreNavEntryDecoratorDefault

Holds the default functions for the ViewModelStoreNavEntryDecorator.

Cmn

android

Top-level functions summary

ViewModelStoreNavEntryDecorator<T>

@Composable
<T : Any> rememberViewModelStoreNavEntryDecorator(
    viewModelStoreOwner: ViewModelStoreOwner,
    removeViewModelStoreOnPop: () -> Boolean
)

Returns a ViewModelStoreNavEntryDecorator that is remembered across recompositions.

Cmn

Top-level functions

rememberViewModelStoreNavEntryDecorator

Cmn

Artifact: androidx.lifecycle:lifecycle-viewmodel-navigation3

View Source

Added in 2.10.0-alpha05

@Composable
fun <T : Any> rememberViewModelStoreNavEntryDecorator(
    viewModelStoreOwner: ViewModelStoreOwner = checkNotNull(LocalViewModelStoreOwner.current) {
            "No ViewModelStoreOwner was provided via LocalViewModelStoreOwner"
        },
    removeViewModelStoreOnPop: () -> Boolean = ViewModelStoreNavEntryDecoratorDefault.removeViewModelStoreOnPop()
): ViewModelStoreNavEntryDecorator<T>

Returns a ViewModelStoreNavEntryDecorator that is remembered across recompositions.

Parameters
`viewModelStoreOwner: ViewModelStoreOwner = checkNotNull(LocalViewModelStoreOwner.current) { "No ViewModelStoreOwner was provided via LocalViewModelStoreOwner" }`	The `ViewModelStoreOwner` that provides the `ViewModelStore` to NavEntries
`removeViewModelStoreOnPop: () -> Boolean = ViewModelStoreNavEntryDecoratorDefault.removeViewModelStoreOnPop()`	A lambda that returns a Boolean for whether the store for a `NavEntry` should be removed when the `NavEntry` is popped from the backStack. If true, the entry's ViewModelStore will be removed.