compose-serialization-kotlinx

Compose lifecycle effects for catching @Serializable objects from the Boomerang store. This module connects the Compose module with the Serialization module, so you can catch typed objects in a single composable call.

Supports primitives, enums, nested objects, lists, and maps. Targets Android, iOS, and Desktop.

Installation

implementation("io.github.buszi.boomerang:core:1.6.0")
implementation("io.github.buszi.boomerang:compose:1.6.0")
implementation("io.github.buszi.boomerang:serialization-kotlinx:1.6.0")
implementation("io.github.buszi.boomerang:compose-serialization-kotlinx:1.6.0")

Usage

Catching a serializable object

CatchSerializableLifecycleEffect deserializes the result and passes it to your lambda. Return true to consume (remove from store), false to leave it.

@Composable
fun PreferencesScreen() {
    var pref by remember { mutableStateOf<UserPreference?>(null) }

    CatchSerializableLifecycleEffect<UserPreference>("user_preferences") { preference ->
        pref = preference
        true
    }
}

Consuming (always remove)

If you always want to consume the result, use ConsumeSerializableLifecycleEffect -- it automatically returns true for you:

ConsumeSerializableLifecycleEffect<UserPreference>("user_preferences") { preference ->
    pref = preference
}

Using type as key

Both Catch and Consume variants have overloads that use the type's qualified name as the key, so you don't need to manage key strings:

// These use the qualified name of UserPreference as the key
CatchSerializableLifecycleEffect<UserPreference> { preference ->
    pref = preference
    true
}

ConsumeSerializableLifecycleEffect<UserPreference> { preference ->
    pref = preference
}

This pairs with store.storeValue(userPreference) (no explicit key) on the sending side.

Storing

Storing is done through the serialization module's extension functions -- this module only adds the Compose catching side:

val store = LocalBoomerangStore.current
store.storeValue(UserPreference("dark", true, 14))

// Or with an explicit key
store.storeValue("user_preferences", UserPreference("dark", true, 14))

Custom lifecycle event

By default, catching happens on ON_START. You can change this:

CatchSerializableLifecycleEffect<UserPreference>(
    key = "user_preferences",
    lifecycleEvent = Lifecycle.Event.ON_RESUME
) { preference ->
    pref = preference
    true
}

Configuration

If you need custom serializers, configure BoomerangFormat globally (see SERIALIZATION-KOTLINX.md):

BoomerangConfig.format = BoomerangFormat {
    serializersModule = SerializersModule { /* ... */ }
}

API Reference

Requirements

• Kotlin 1.5.0+

• Compose Multiplatform 1.0.0+

• Kotlinx Serialization 1.5.0+

• Android API 21+ / iOS 14+ / Desktop JVM 11+