core/com.helloanwar.mvvmate.core/BaseViewModelWithEffect

BaseViewModelWithEffect

abstract class BaseViewModelWithEffect<S : UiState, A : UiAction, E>(initialState: S) : BaseViewModel<S, A> (source)

Base class for ViewModels that manages UI state, handles user actions, and emits side effects.

This class extends BaseViewModel by adding support for emitting side effects via a SharedFlow. Side effects are typically used for actions that should not directly mutate the UI state but trigger external events, such as navigation or showing a dialog.

Parameters

S

The type of UI state that this ViewModel manages. It should implement UiState.

A

The type of user actions (intents) that this ViewModel responds to. It should implement UiAction.

E

The type of side effects that this ViewModel emits.

Constructors

BaseViewModelWithEffect

constructor(initialState: S)

Properties

val sideEffects: SharedFlow<E>

val state: StateFlow<S>

Functions

expect open fun addCloseable(closeable: AutoCloseable)

expect fun addCloseable(key: String, closeable: AutoCloseable)

expect fun <T : AutoCloseable> getCloseable(key: String): T?

fun handleAction(action: A)

Handles a user action and updates the state accordingly using the provided onAction method.

abstract suspend fun onAction(action: A)

Abstract method to be implemented by subclasses to handle the specific action logic.