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

Router

external class Router : RouterCore(source)

Properties

external val basepath: String?

external val buildLocation: BuildLocationFn

external val history: RouterHistory

isScrollRestorationSetup

external val isScrollRestorationSetup: Boolean

isScrollRestoring

external val isScrollRestoring: Boolean

external val isServer: Boolean

isViewTransitionTypesSupported

external val isViewTransitionTypesSupported: Boolean?

latestLoadPromise

external val latestLoadPromise: Promise<Void>?

external val latestLocation: ParsedLocation

external val load: LoadFn

looseRoutesById

external val looseRoutesById: ReadonlyRecord<String, AnyRoute>

external val navigate: NavigateFn

external val options: RouterOptions<*>

external val origin: String?

pathParamsDecoder

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

pendingBuiltLocation

external val pendingBuiltLocation: ParsedLocation?

protocolAllowlist

external val protocolAllowlist: Set<String>

resetNextScroll

external val resetNextScroll: Boolean

external val rewrite: LocationRewrite?

tempLocationKey

external val tempLocationKey: String?

Functions

external fun beforeLoad()

external fun cancelMatch(id: String)

external fun cancelMatches()

clearExpiredCache

external fun clearExpiredCache()

getParsedLocationHref

external fun getParsedLocationHref(location: ParsedLocation): String

hasNotFoundMatch

external fun hasNotFoundMatch(): Boolean

external fun isPrerendering(): Boolean

external fun isShell(): Boolean

resolvePathWithBase

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

updateLatestLocation

external fun updateLatestLocation()