core/de.peekandpoke.kraft.addons.routing

Package-level declarations

Types

data class ActiveRoute(val uri: String, val matchedRoute: Route.Match, val mountedRoute: MountedRoute)

Represent the route that is currently selected as active route by a Router

data class MountedRoute(val route: Route, val middlewares: List<RouterMiddleware>, val view: FlowContent.(Route.Match) -> Unit)

Represents a Route that is mounted by a Router

Pattern

open class Pattern(regex: Regex) : Route

A route that matches a regex, f.e. used as a fallback route.

Route

interface Route

Common Route representation

Route1

open class Route1(val pattern: String) : RouteBase

A parameterized route with one route parameter

Route2

open class Route2(val pattern: String) : RouteBase

A parameterized route with two route parameter

Route3

open class Route3(val pattern: String) : RouteBase

A parameterized route with two route parameter

Route4

open class Route4(val pattern: String) : RouteBase

A parameterized route with two route parameter

Route5

open class Route5(val pattern: String) : RouteBase

A parameterized route with two route parameter

RouteBase

abstract class RouteBase(val pattern: String, numParams: Int) : Route, Route.Renderable

A parameterized route with one route parameter

Router

class Router(mountedRoutes: List<MountedRoute>, enabled: Boolean)

The Router

RouterBuilder

class RouterBuilder

Helper class for building a Router

RouterComponent

class RouterComponent : Component<RouterComponent.Props>

RouterMiddleware

typealias RouterMiddleware = RouterMiddlewareContext.() -> Unit

A RouterMiddleware is just a function with RouterMiddlewareContext as the receiver

RouterMiddlewareContext

class RouterMiddlewareContext(val router: Router, val uri: String, val match: Route.Match)

The context for all middle wares

RouterProvider

typealias RouterProvider = () -> Router

Static

open class Static(val pattern: String) : RouteBase

A static route is a route that does not have any route parameters

Functions

navigateTo

fun navigateTo(uri: String)

router

fun router(builder: RouterBuilder.() -> Unit): Router

RouterComponent

fun Tag.RouterComponent(router: Router): ComponentRef<RouterComponent>

The router component displays the view that is associated with the ActiveRoute of the given Router

routerMiddleware

fun routerMiddleware(func: RouterMiddleware): RouterMiddleware

Helper for defining a router middleware

urlParam

fun <C> Component<C>.urlParam(router: Router, name: String, default: Int, onChange: (Int) -> Unit? = null): ReadWriteProperty<Component<C>, Int>

fun <C> Component<C>.urlParam(router: Router, name: String, default: String, onChange: (String) -> Unit? = null): ReadWriteProperty<Component<C>, String>

urlParams

fun <C, T> Component<C>.urlParams(router: Router, fromParams: (Map<String, String>) -> T, toParams: (T) -> Map<String, Any?>, onChange: (T) -> Unit? = null): ReadWriteProperty<Component<C>, T>