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.

This requires the usage of SaveableStateHolderNavEntryDecorator to ensure that the NavEntry scoped ViewModels can properly provide access to androidx.lifecycle.SavedStateHandles.

See also
onPop

for more details on when this callback is invoked

Summary

Public constructors

<T : Any> ViewModelStoreNavEntryDecorator(
    viewModelStoreProvider: ViewModelStoreProvider
)
Cmn
<T : Any> ViewModelStoreNavEntryDecorator(
    viewModelStore: ViewModelStore,
    removeViewModelStoreOnPop: () -> Boolean
)

This function is deprecated. This parameter was a workaround for detecting configuration changes and was never intended for conditional popping.

Cmn

Public constructors

ViewModelStoreNavEntryDecorator

<T : Any> ViewModelStoreNavEntryDecorator(
    viewModelStoreProvider: ViewModelStoreProvider
)

ViewModelStoreNavEntryDecorator

<T : Any> ViewModelStoreNavEntryDecorator(
    viewModelStore: ViewModelStore,
    removeViewModelStoreOnPop: () -> Boolean
)

Constructs a ViewModelStoreNavEntryDecorator.

Parameters
viewModelStore: ViewModelStore

The ViewModelStore that provides to the NavEntry.

removeViewModelStoreOnPop: () -> Boolean

This parameter is now ignored and the lambda is never invoked.