commonMain.captain.ParamsUtils.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of captain-router-compose-core-jvm Show documentation

A compose router that follows any type of navigator

There is a newer version: 3.0.13

Show newest version

@file:Suppress("NOTHING_TO_INLINE")

package captain

import androidx.compose.runtime.Composable
import cinematic.watchAsState
import kase.Optional
import kase.optionalOf
import kiota.QueryParams
import kiota.UrlMatch
import kollections.Map
import kollections.mapOf

@Composable
inline fun rememberRouteParams(): UrlMatch = rememberRouteInfo()?.match ?: error("rememberRouteMatchParams can only be used inside a Route{} composable")

@Composable
inline fun rememberOptionalParams(key: String): Optional = optionalOf(rememberRouteInfo()).flatMap { it.match.param(key) }


@Composable
inline fun rememberParam(key: String): String {
    val ri = rememberRouteInfo() ?: error("Param $key is not available")
    return ri.match.param(key).getOrThrow("Param $key is not available at ${ri.match.route.path}")
}

@Deprecated(
    message = "In favour of rememberPathParams",
    replaceWith = ReplaceWith(
        expression = "rememberPathParams()",
        imports = ["captain.rememberPathParams"]
    )
)
@Composable
inline fun rememberParams(): Map = rememberRouteInfo()?.match?.params ?: mapOf()

@Composable
inline fun rememberPathParams(): Map = rememberRouteInfo()?.match?.params ?: mapOf()

@Composable
inline fun rememberQueryParams(): QueryParams {
    val navigator = rememberNavigator()
    return navigator.route.watchAsState().params
}