kilua-routing/app.softwork.routingcompose/RouteBuilder

RouteBuilder

@Stable

Use the DSL functions to build the expected route handled by a Router. If two routes match the same path, the first declared route is chosen.

With dynamic routing displaying will not stop if two routes of the same kind match the current route:

wrong usage:

    if (true) {
      int {
        Text("Match")
      }
    }
    int {
      Text("Will be displayed too")
    }

correct usage:

    if (true) {
      int {
        Text("Match")
      }
    } else {
      int {
        Text("Won't be displayed")
      }
    }

Types

Companion

object Companion

NoMatch

@Immutable

class NoMatch

Properties

parameters

val parameters: Parameters?

path

val path: String

Functions

int

@Composable

fun int(nestedRoute: @Composable RouteBuilder.(Int) -> Unit)

Executes its children when the requested subroute is a Int.

intAction

@Composable

fun RouteBuilder.intAction(block: suspend RouteBuilder.(Int) -> Unit)

Executes the given block inside RouteEffect when the route matches the int.

noMatch

@Composable

fun noMatch(content: @Composable RouteBuilder.NoMatch.() -> Unit)

Fallback if no matching route is found.

noMatchAction

@Composable

fun RouteBuilder.noMatchAction(block: suspend RouteBuilder.NoMatch.() -> Unit)

Executes the given block inside RouteEffect when the route doesn't match.

redirect

@Composable

fun redirect(vararg route: String, target: String, hide: Boolean = false)

route

@Composable

fun route(vararg route: String, nestedRoute: @Composable RouteBuilder.() -> Unit)

Executes its children when the requested subroute matches one of these constant route.

routeAction

@Composable

fun RouteBuilder.routeAction(vararg route: String, block: suspend RouteBuilder.() -> Unit)

Executes the given block inside RouteEffect when the route matches the given path.

string

@Composable

fun string(nestedRoute: @Composable RouteBuilder.(String) -> Unit)

Executes its children when the requested subroute is a non-empty String.

stringAction

@Composable

fun RouteBuilder.stringAction(block: suspend RouteBuilder.(String) -> Unit)

Executes the given block inside RouteEffect when the route matches the string.