RouteBuilder

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

class NoMatch(val remainingPath: String, val parameters: Parameters?)

@Composable

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

Executes its children when the requested subroute is a Int.

@Composable

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

Fallback if no matching route is found.

@Composable

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

@Composable

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

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

@Composable

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

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