circuit-foundation/com.slack.circuit.foundation.backstack

Package-level declarations

Types

object ViewModelNavStackRecordLocalProvider : NavStackRecordLocalProvider<NavStack.Record>

A NavStackRecordLocalProvider that provides a LocalViewModelStoreOwner for each record in the back stack.

Functions

inline fun <VM : ViewModel> backStackHostViewModel(viewModelStoreOwner: ViewModelStoreOwner = checkNotNull(backStackHostViewModelStoreOwner()) { "No ViewModelStoreOwner was provided for backStackHostViewModel" }, key: String? = null, factory: ViewModelProvider.Factory? = null, extras: CreationExtras = if (viewModelStoreOwner is HasDefaultViewModelProviderFactory) { viewModelStoreOwner.defaultViewModelCreationExtras } else { CreationExtras.Empty }): VM

Returns a ViewModel using a ViewModelStoreOwner resolved from the back stack host context.

backStackHostViewModelStoreOwner

@Composable

fun backStackHostViewModelStoreOwner(): ViewModelStoreOwner?

Returns the ViewModelStoreOwner of the component hosting the back stack, populated by ViewModelNavStackRecordLocalProvider or the current LocalViewModelStoreOwner.