Enhances MVI infrastructure for ViewModels, Fragments, and Jetpack Compose in Android and Compose Multiplatform apps, integrating seamlessly with existing UI components and offering configurable error handling.
Yamvil is a library and a compiler plugin bringing MVI Infrastructure to ViewModels, Fragments and Jetpack Compose, for Android and Compose Multiplatform apps.
⚠️ This is a work in progress: Yamvil is still in early development and is not ready for production use. The API is subject to change and only Android Studio Nightly shows the errors thrown by the compiler plugin.
The full documentation of Yamvil is available here.
Write MVI ViewModels like this:
class DashboardViewModel: MVIViewModel<DashboardUiState, DashboardUiEvent>() {
override : DashboardUiState {
DashboardUiState(state = DashboardUiState.ContentState.Loading)
}
{
(event) {
DashboardUiEvent.ClickOnNext -> onClickOnNext()
}
}
{
update { copy(action = Consumable(DashboardUiAction.NavigateToNext)) }
}
}
Then use your MVI ViewModel in a Composable like this:
@Composable
fun DashboardScreen(
uiState: DashboardUiState,
handleEvent: (DashboardUiEvent) -> Unit,
modifier: Modifier = Modifier
) {
when (uiState.state) {
is DashboardUiState.ContentState.Loading -> DashboardLoadingContent()
is DashboardUiState.ContentState.Error -> DashboardErrorContent()
is DashboardUiState.ContentState.Content -> DashboardContent(uiState.state)
}
LaunchedActionEffect(uiState) { action: DashboardUiAction ->
(action) {
DashboardUiAction.NavigateToNext -> {}
}
}
}
Or if you're using Fragments, like this:
class DashboardFragment: MVIFragment<DashboardUiState, DashboardUiEvent>() {
override val viewModel: DashboardViewModel by viewModels()
override fun observeUiState {
(uiState.state) {
DashboardUiState.ContentState.Loading -> onLoading()
DashboardUiState.ContentState.Content -> onContent(uiState.state)
DashboardUiState.ContentState.Error -> onError()
}
uiState.onAction { action ->
(action) {
DashboardUiAction.NavigateToNext -> navigateToNext()
}
}
}
}
In your libs.version.toml, add the following:
[versions]
yamvil = "0.0.2"
[libraries]
yamvil = { group = "dev.galex.yamvil", name = "runtime", version.ref = "yamvil" }
[plugins]
yamvil = { id = "dev.galex.yamvil", version.ref = "yamvil" }
Then add those to your project:
// Root build.gradle.kts
plugins {
alias(libs.plugins.yamvil) apply false
}
// In your app/build.gradle.kts
plugins {
alias(libs.plugins.yamvil)
}
dependencies {
implementation(libs.yamvil)
}
yamvil {
level = YamvilLevel.Error // or Warning
compose {
screenSuffix = "Screen"
uiStateParameterName = "uiState"
handleEventParameterMame = "onEvent"
}
}
Run ./gradlew publishToMavenLocal to publish all the artefacts locally.
Run ./gradlew publishAndReleaseToMavenCentral --no-configuration-cache to publish all artefacts to Maven Central.
Surfaced from shared tags and platforms — no rankings paid for.