viewing-state-kmp

1.0.0indexed

Sealed state types modeling common UI transitions — loading, saving, mutating (with original/updated tracking), plus ResourceState that combines load/save flows for predictable, type-safe view-state handling.

AndroidNative·felipearpa/viewing-state-kmp

Stars

—

Used by

dependents

—

Health

/ 100

viewing-state-kmp

A Kotlin Multiplatform library for managing common UI state transitions.

Overview

The viewing-state-kmp package provides sealed classes to handle common view state transitions:

LoadState — Idle, Loading, Loaded, Failure
SaveState — Idle, Saving, Saved, Failure
MutationState — Idle, Mutating, Mutated, Failure (with original/updated tracking)
ResourceState — Idle, Loading, Loaded, LoadFailure, Saving, Saved, SaveFailure

Platforms

Android (JVM 17, minSdk 28, compileSdk 35)
iOS Arm64
iOS Simulator Arm64

Installation

Add the Maven Central repository to your settings.gradle.kts (if not already present):

dependencyResolutionManagement {
    repositories {
        mavenCentral()
    }
}

Then add the dependency to your build.gradle.kts:

implementation("com.felipearpa:viewing-state:1.0.0")

Quick Example

class MyViewModel : ViewModel() {
    private val _state = MutableStateFlow<LoadState<MyData>>(LoadState.Idle)
    val state: StateFlow<LoadState<MyData>> = _state.asStateFlow()

    fun fetchData() {
        viewModelScope.launch {
            _state.value = LoadState.Loading
            try {
                val result = repository.fetchData()
                _state.value = LoadState.Loaded(result)
            } catch (exception: Exception) {
                _state.value = LoadState.Failure(exception)
            }
        }
    }
}