NavResult

Simplifies communication between composables by enabling result passing and handling with minimal configuration. Offers easy setup with request keys, handers, and serializable result types.

#utility
#kotlin-serialization
#compose
#android-ui

Suggest an edit

Android JVMKotlin/Native

GitHub stars2

Authorsandannn

Open issues7

LicenseApache License 2.0

Creation date5 months ago

Last activity11 days ago

Latest release1.0.1 (5 months ago)

GitHub repository Wiki page

A small helper for Jetpack Compose that simplifies sending results between composables.

Install

libs.versions.toml

[versions]
navresult = "1.0.0"

[dependencies]
navresult = { group = "io.github.andannn", name = "navresult", version.ref = "navresult" }

then

dependencies {
    implementation(libs.navresult)
}

Quick Start

Inject NavResultOwner into your composable.

val navResultOwner = rememberNavResultOwner()
CompositionLocalProvider(
    LocalNavResultOwner provides navResultOwner,
) {
    // Top level composable.
    App()
}

Define a request key.

const val ScreenABackResult = "screen_a_back_result"

LaunchNavResultHandler(
    requestKey = ScreenABackResult,
    resultSerializer = ScreenAResult.serializer(),
) { result ->
    // handle result
}

Define a result type which can be marked as @Serializable.

@Serializable
data class ScreenAResult(val id: Int, val name: String)

Send result.

resultOwner.setNavResult(
    requestKey = ScreenABackResult,
    result = ScreenAResult(1, "foo"),
    serializer = ScreenAResult.serializer()
)

Please see the details in this sample.