ViewModelStoreNavEntryDecoratorKt

Added in 2.10.0-alpha05

public final class ViewModelStoreNavEntryDecoratorKt


Summary

Public methods

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

Returns a ViewModelStoreNavEntryDecorator that is remembered across recompositions.

Public methods

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

@NonNull Function0<@NonNull Boolean> 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.