compose/dev.kindling.compose.experimental/KMviViewModel

KMviViewModel

abstract class KMviViewModel<State, I, E>(initialState: State) : ViewModel, MviViewModel<State, I, E> (source)

Base implementation of a strict MVI (Model-View-Intent) ViewModel.

This class provides the foundational logic for managing state and side effects in a thread-safe and lifecycle-aware manner. It is designed to work seamlessly with KScreen.

Key Features:

State Management: Uses a StateFlow to hold and emit immutable state objects.
Side Effects: Uses a buffered SharedFlow for one-shot effects (e.g., navigation).
Unidirectional Flow: Enforces the Intent ->State pattern.
Async Helpers: Built-in async and collectFlow for coroutine-safe data fetching.

Implementation Example:

data class ProfileState(val name: String = "", val isLoading: Boolean = false)
sealed interface ProfileIntent : Intent { data object Load : ProfileIntent }
sealed interface ProfileEffect : Effect { data class ShowError(val msg: String) : ProfileEffect }

class ProfileViewModel(val repo: Repo) : KMviViewModel<ProfileState, ProfileIntent, ProfileEffect>(ProfileState()) {
    override suspend fun handleIntent(intent: ProfileIntent) {
        when (intent) {
            ProfileIntent.Load -> {
                setState { copy(isLoading = true) }
                async({ repo.getName() }) { result ->
                    result.onSuccess { copy(name = it, isLoading = false) }
                          .onFailure { 
                              emitEffect(ProfileEffect.ShowError("Failed"))
                              copy(isLoading = false) 
                          }
                }
            }
        }
    }
}