reaktiv-navigation/io.github.syrou.reaktiv.navigation.dsl/DeepLinkAlias

DeepLinkAlias

data class DeepLinkAlias(val pattern: String, val targetRoute: String, val paramsMapping: (Params) -> Params = { it })(source)

An individual deep link alias mapping a path pattern to a canonical internal route.

Patterns support {paramName} placeholders that match any non-slash segment, including full URL patterns with scheme and host:

alias(
    pattern = "{scheme}://{host}/invitations/team/confirm/{token}",
    targetRoute = "workspace/invite/{token}"
) { params ->
    Params.of("token" to (params["token"] as? String ?: ""))
}

Parameters

pattern

The external path pattern matched against incoming deep link paths

targetRoute

The canonical internal route to navigate to

paramsMapping

Optional transform applied to route params before passing to navigation

Constructors

DeepLinkAlias

constructor(pattern: String, targetRoute: String, paramsMapping: (Params) -> Params = { it })

Properties

paramsMapping

val paramsMapping: (Params) -> Params

pattern

val pattern: String

targetRoute

val targetRoute: String

Functions

matchAndExtract

fun matchAndExtract(url: String): Params?

Attempts to match url against this alias pattern and extract any path parameters.