viewmodel-compose/com.hoc081098.kmp.viewmodel.compose

Package-level declarations

Properties

Link copied to clipboard
val LocalSavedStateHandleFactory: ProvidableCompositionLocal<SavedStateHandleFactory?>

The CompositionLocal containing the current SavedStateHandleFactory or null if not provided.

Link copied to clipboard
val LocalViewModelStoreOwner: ProvidableCompositionLocal<ViewModelStoreOwner?>

The CompositionLocal containing the current ViewModelStoreOwner or null if not provided.

Functions

Link copied to clipboard
@Stable
actual fun defaultPlatformCreationExtras(): CreationExtras

Returns a sentinel DefaultCreationExtrasForAndroid for the current platform (Android). This is used to determine whether the user wants to use the default CreationExtras defined by the platform or not.

@Stable
expect fun defaultPlatformCreationExtras(): CreationExtras

Returns the default CreationExtras for the current platform.

@Stable
actual fun defaultPlatformCreationExtras(): CreationExtras

Returns EmptyCreationExtras for the current platform (non-Android).

Link copied to clipboard
@Composable
@MainThread
actual fun defaultPlatformViewModelStoreOwner(): ViewModelStoreOwner

Returns the nearest androidx.lifecycle.ViewModelStoreOwner that is provided via LocalViewModelStoreOwner. If it is not provided, then the androidx.lifecycle.ViewModelStoreOwner is searched in the hierarchy of Contexts. If no androidx.lifecycle.ViewModelStoreOwner is found, an IllegalStateException will be thrown.

@MainThread
@Composable
expect fun defaultPlatformViewModelStoreOwner(): ViewModelStoreOwner

Returns the default ViewModelStoreOwner for the current platform.

@MainThread
@Composable
actual fun defaultPlatformViewModelStoreOwner(): ViewModelStoreOwner

Remember a ViewModelStoreOwner in the current composition. It clears its ViewModelStoreOwner.viewModelStore when the current @Composable leaves the composition. Basically, its scope ties the lifecycle of the current composition.

Link copied to clipboard
@MainThread
@Composable
inline fun defaultViewModelStoreOwner(): ViewModelStoreOwner

Returns current composition local value for the ViewModelStoreOwner provided by LocalViewModelStoreOwner. or defaultPlatformViewModelStoreOwner if one has not been provided.

Link copied to clipboard
@MainThread
@Composable
expect inline fun <VM : ViewModel> kmpViewModel(factory: ViewModelFactory<VM>, viewModelStoreOwner: ViewModelStoreOwner = defaultViewModelStoreOwner(), key: String? = null, extras: CreationExtras = defaultPlatformCreationExtras(), savedStateHandleFactory: SavedStateHandleFactory? = LocalSavedStateHandleFactory.current): VM
@MainThread
@Composable
inline fun <VM : ViewModel> kmpViewModel(key: String? = null, viewModelStoreOwner: ViewModelStoreOwner = defaultViewModelStoreOwner(), extras: CreationExtras = defaultPlatformCreationExtras(), savedStateHandleFactory: SavedStateHandleFactory? = LocalSavedStateHandleFactory.current, crossinline factory: @DisallowComposableCalls CreationExtras.() -> VM): VM

Returns an existing ViewModel or creates a new one in the given owner (usually, an Android fragment or an Android activity), defaulting to defaultViewModelStoreOwner.

@MainThread
@Composable
actual inline fun <VM : ViewModel> kmpViewModel(factory: ViewModelFactory<VM>, viewModelStoreOwner: ViewModelStoreOwner, key: String?, extras: CreationExtras, savedStateHandleFactory: SavedStateHandleFactory?): VM
Link copied to clipboard
@Composable
inline fun <VM : ViewModel> rememberViewModelFactory(crossinline builder: @DisallowComposableCalls CreationExtras.() -> VM): ViewModelFactory<VM>

Remember a ViewModelFactory that will be used to create a ViewModel.

@Composable
inline fun <VM : ViewModel> rememberViewModelFactory(key: Any?, crossinline builder: @DisallowComposableCalls CreationExtras.() -> VM): ViewModelFactory<VM>

Remember a ViewModelFactory that will be used to create a ViewModel with the given key.

Link copied to clipboard
Link copied to clipboard