kotlin-tanstack-react-router/tanstack.react.router/Router

Router

external class Router : RouterCore(source)

Properties

val basepath: String?

val buildLocation: BuildLocationFn

val history: RouterHistory

isScrollRestorationSetup

val isScrollRestorationSetup: Boolean

isScrollRestoring

val isScrollRestoring: Boolean

val isServer: Boolean

isViewTransitionTypesSupported

val isViewTransitionTypesSupported: Boolean?

latestLoadPromise

val latestLoadPromise: Promise<Void>?

val latestLocation: ParsedLocation

val load: LoadFn

looseRoutesById

val looseRoutesById: ReadonlyRecord<String, AnyRoute>

val navigate: NavigateFn

val options: RouterOptions<*>

val origin: String?

pathParamsDecoder

val pathParamsDecoder: (encoded: String) -> String?

pendingBuiltLocation

val pendingBuiltLocation: ParsedLocation?

protocolAllowlist

val protocolAllowlist: Set<String>

resetNextScroll

val resetNextScroll: Boolean

val rewrite: LocationRewrite?

tempLocationKey

val tempLocationKey: String?

Functions

fun beforeLoad()

fun cancelMatch(id: String)

fun cancelMatches()

clearExpiredCache

fun clearExpiredCache()

getParsedLocationHref

fun getParsedLocationHref(location: ParsedLocation): String

hasNotFoundMatch

fun hasNotFoundMatch(): Boolean

fun isPrerendering(): Boolean

fun isShell(): Boolean

resolvePathWithBase

fun resolvePathWithBase(from: String, path: String): String

updateLatestLocation

fun updateLatestLocation()