kvision-routing-navigo-ng/io.kvision.routing/Routing

Routing

open class Routing(root: String? = null, useHash: Boolean = true, strategy: Strategy = Strategy.ONE, noMatchWarning: Boolean = false, linksSelector: String? = null) : Navigo, KVRouter(source)

A helper class for Navigo 8+ JavaScript router.

Parameters

root

the root path of the application

useHash

whether to use hash based routing

strategy

a routing strategy

noMatchWarning

do not show warnings when there is no matching route

linksSelector

CSS links selector

Constructors

constructor(root: String? = null, useHash: Boolean = true, strategy: Strategy = Strategy.ONE, noMatchWarning: Boolean = false, linksSelector: String? = null)

Types

object Companion

Properties

open var current: Array<Match>?

open var destroyed: Boolean

open var root: String

open var routes: Array<Route>

Functions

open fun addAfterHook(route: Route, hookFunction: () -> Unit): () -> Unit

open fun addAfterHook(route: String, hookFunction: () -> Unit): () -> Unit

open fun addAlreadyHook(route: Route, hookFunction: () -> Unit): () -> Unit

open fun addAlreadyHook(route: String, hookFunction: () -> Unit): () -> Unit

open fun addBeforeHook(route: Route, hookFunction: (done: DoneFunction) -> Unit): () -> Unit

open fun addBeforeHook(route: String, hookFunction: (done: DoneFunction) -> Unit): () -> Unit

open fun addLeaveHook(route: Route, hookFunction: (done: DoneFunction) -> Unit): () -> Unit

open fun addLeaveHook(route: String, hookFunction: (done: DoneFunction) -> Unit): () -> Unit

open fun destroy()

open fun generate(name: String, data: Any, options: GenerateOptions): String

getCurrentLocation

open fun getCurrentLocation(): Match

open fun getLinkPath(link: Any): String

open fun getRoute(nameOrHandler: Handler): Route?

open fun getRoute(nameOrHandler: String): Route?

open fun hooks(hooks: RouteHooks): Navigo

open override fun kvDestroy()

open override fun kvNavigate(route: String)

open override fun kvOff(handler: (Any) -> Unit)

open override fun kvOn(route: String, handler: (Any) -> Unit): KVRouter

open override fun kvResolve()

open fun lastResolved(): Array<Match>?

open fun link(path: String): String

open fun match(path: String): dynamic

open fun matchLocation(path: String, currentLocation: String, annotatePathWithRoot: Boolean): dynamic

open fun matchLocation(path: RegExp, currentLocation: String, annotatePathWithRoot: Boolean): dynamic

open fun navigate(to: String, options: NavigateOptions)

open fun navigateByName(name: String, data: Any, options: NavigateOptions): Boolean

open fun notFound(handler: Handler, hooks: RouteHooks): Navigo

open fun off(handler: Handler): Navigo

open fun off(path: String): Navigo

open fun off(path: RegExp): Navigo

open fun on(map: Any, hooks: RouteHooks): Navigo

open fun on(f: Handler, hooks: RouteHooks): Navigo

open fun on(path: String, f: Handler, hooks: RouteHooks): Navigo

open fun on(path: RegExp, f: Handler, hooks: RouteHooks): Navigo

open fun resolve(path: String, resolveOptions: ResolveOptions): dynamic

updatePageLinks

open fun updatePageLinks(): Navigo