Common/ Shared ViewModel in Kotlin Multiplatform - A Kotlin Multiplatform library that provides shared MVVM for UI applications. Components are lifecycle-aware on Android. Supports Android Parcelable, Kotlin Parcelize, AndroidX SavedStateHandle for restoring state after process death. Easy interoperability with Swift/Objective-C and SwiftUI. Supports Compose Multiplatform Framework (Android, Desktop, Web, iOS, macOS, tvOS, watchOS).
The ViewModel class is a business logic or screen level state holder. It exposes state to the UI and encapsulates related business logic. Its principal advantage is that it caches state and persists it through configuration changes (on Android).
kmp-viewmodel and Navigation for JetBrains Compose Multiplatform 👉 https://github.com/hoc081098/solivagant
Author: Petrus Nguyễn Thái Học
Liked some of my work? Buy me a coffee (or more likely a beer)
android
.jvm
(must addkotlinx-coroutines-swing
/kotlinx-coroutines-javafx
to your dependencies to make sureDispatchers.Main
available).
Note
If you are targeting Desktop
and:
- not using
JetBrains Compose Multiplatform
, you should provide the dependencyorg.jetbrains.kotlinx:kotlinx-coroutines-swing
ororg.jetbrains.kotlinx:kotlinx-coroutines-javafx
. - using
JetBrains Compose Multiplatform
, you should provideorg.jetbrains.kotlinx:kotlinx-coroutines-swing
.
Because the ViewModel.viewModelScope
depends on Dispatchers.Main
provided by that libraries on Desktop.
js
(IR
).wasmJs
.Darwin
targets:iosArm64
,iosX64
,iosSimulatorArm64
.watchosArm32
,watchosArm64
,watchosX64
,watchosSimulatorArm64
.tvosX64
,tvosSimulatorArm64
,tvosArm64
.macosX64
,macosArm64
.
0.x release docs: https://hoc081098.github.io/kmp-viewmodel/docs/0.x
Snapshot docs: https://hoc081098.github.io/kmp-viewmodel/docs/latest
For more information check out the docs.
For more information check out the docs.
For more information check out the docs.
For more information check out the docs.
For more information check out the docs.
For more information check out the docs.
For more information check out https://github.com/hoc081098/solivagant library.
For more information check out the docs.
- KMM sample: shares business logic and
ViewHolder
s, using Jetpack Compose for Android and SwiftUi for iOS. - Compose Multiplatform Koin sample: shares
ViewModel
s and integrates withNavigation
in Compose Multiplatform. It usesKoin
for DI. - Compose Multiplatform Koject sample: shares
ViewModel
s and integrates withNavigation
in Compose Multiplatform. It usesKoject
for DI. - Compose Multiplatform KmpViewModel KMM Unsplash Sample: A KMP template of the Unsplash App using Compose multiplatform for Android, Desktop, iOS. Share everything including data, domain, presentation, and UI.
- 🍭 GithubSearchKMM: Github Repos Search KMM for Android and iOS. Kotlin Multiplatform Mobile using Jetpack Compose, SwiftUI, FlowRedux, Coroutines Flow, Dagger Hilt, Koin Dependency Injection, shared KMP ViewModel, Clean Architecture.
- support
SaveStateHandle
(since 0.2.0). - add extensions for
Flow
/StateFlow
, to use the ViewModel easily onios
/macOS
/tvOS
/watchOS
platforms (since 0.3.0). - support
Compose Multiplatform Framework
(since 0.5.0). - support
Koin
integration with ViewModel andJetBrains Compose Multiplatform
(since 0.6.2).
MIT License
Copyright (c) 2023-2024 Petrus Nguyễn Thái Học