ViewModelStoreNavEntryDecoratorKt

Added in 2.10.0

public final class ViewModelStoreNavEntryDecoratorKt

Summary

Public methods
static final @NonNull ViewModelStoreNavEntryDecorator<@NonNull T>

Returns a ViewModelStoreNavEntryDecorator that is remembered across recompositions.
static final @NonNull ViewModelStoreNavEntryDecorator<@NonNull T>
@Composable
<T extends Object> rememberViewModelStoreNavEntryDecorator(
    @NonNull ViewModelStoreOwner viewModelStoreOwner,
    @NonNull Function0<@NonNull Boolean> removeViewModelStoreOnPop
)

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

Public methods

rememberViewModelStoreNavEntryDecorator

@Composable
public static final @NonNull ViewModelStoreNavEntryDecorator<@NonNull T> <T extends Object> rememberViewModelStoreNavEntryDecorator(
    @NonNull ViewModelStoreOwner viewModelStoreOwner
)

Returns a ViewModelStoreNavEntryDecorator that is remembered across recompositions.

Parameters
@NonNull ViewModelStoreOwner viewModelStoreOwner

The ViewModelStoreOwner that provides the ViewModelStore to NavEntries. If this owner implements androidx.lifecycle.HasDefaultViewModelProviderFactory, its default factory and creation extras will be propagated to the NavEntries.

rememberViewModelStoreNavEntryDecorator

@Composable
public static final @NonNull ViewModelStoreNavEntryDecorator<@NonNull T> <T extends Object> rememberViewModelStoreNavEntryDecorator(
    @NonNull ViewModelStoreOwner viewModelStoreOwner,
    @NonNull Function0<@NonNull Boolean> removeViewModelStoreOnPop
)

Returns a ViewModelStoreNavEntryDecorator that is remembered across recompositions.

Parameters
@NonNull ViewModelStoreOwner viewModelStoreOwner

The ViewModelStoreOwner that provides the ViewModelStore to NavEntries. If this owner implements HasDefaultViewModelProviderFactory, its default factory and creation extras will be propagated to the NavEntries.
@NonNull Function0<@NonNull Boolean> removeViewModelStoreOnPop

This parameter is now ignored and the lambda is never invoked. Previously, it was a lambda that returned a Boolean for whether the store for a NavEntry should be removed when the NavEntry is popped from the backStack.