kotlin-tanstack-router-core/tanstack.router.core

Package-level declarations

Types

external interface ActiveOptions

typealias AnyRoute = BaseRoute<*>

AssetFnContextOptions

external interface AssetFnContextOptions

open external class BaseRootRoute<TChild : BaseRoute<TChild>> : BaseRoute<TChild>

open external class BaseRoute<TChild : BaseRoute<TChild>>

BeforeLoadContextOptions

external interface BeforeLoadContextOptions : ContextOptions, FullSearchSchemaOption

BuildLocationFn

typealias BuildLocationFn = Invoker<BuildLocationOptions, ParsedLocation>

BuildLocationOptions

external interface BuildLocationOptions : ToOptions

sealed external interface Cause

typealias Context = Any

external interface ContextOptions

FilebaseRouteOptions

sealed external interface FilebaseRouteOptions

FullSearchSchemaOption

external interface FullSearchSchemaOption

class Invoker<O : Any, R>

LinkOptionProps

external interface LinkOptionProps

external interface LinkOptions : NavigateOptions, LinkOptionProps

typealias LoaderData = Any

typealias LoaderDeps = Any

LoaderFnContext

external interface LoaderFnContext

LoaderStaleReloadMode

sealed external interface LoaderStaleReloadMode

typealias LoadFn = SuspendInvoker<LoadOptions, Void>

external interface LoadOptions

LocationRewrite

external interface LocationRewrite

LocationRewriteFunction

external class LocationRewriteFunction

typealias NavigateFn = SuspendInvoker<NavigateOptions, Void>

NavigateOptionProps

external interface NavigateOptionProps

The NavigateOptions type is used to describe the options that can be used when describing a navigation action in TanStack Router. API Docs

NavigateOptions

external interface NavigateOptions : ToOptions, NavigateOptionProps

external interface NotFoundError : JsErrorLike

sealed external interface NotFoundMode

NotFoundOptions

external interface NotFoundOptions : NotFoundError

sealed external interface ParamName

typealias Params = ReadonlyRecord<ParamName, String>

external interface ParsedLocation

external class PathParamError : Throwable

Error thrown when path parameter parsing/validation fails.

sealed external interface Preload

external interface Redirect : Response, JsErrorLike

RedirectOptions

external interface RedirectOptions : NavigateOptions

RemountDepsOptions

external interface RemountDepsOptions

sealed external interface RootRouteId

RootRouteOptions

external interface RootRouteOptions : FilebaseRouteOptions, UpdatableRouteOptions

RouteContextOptions

external interface RouteContextOptions : ContextOptions

sealed external interface RouteId

RouteLoaderEntry

sealed external interface RouteLoaderEntry

external interface RouteLoaderFn : RouteLoaderEntry

RouteLoaderObject

external interface RouteLoaderObject : RouteLoaderEntry

external interface RouteMatch

external interface RouteOptions : FilebaseRouteOptions, UpdatableRouteOptions

sealed external interface RoutePath

open external class RouterCore

external interface RouterOptions<TRouteTree : BaseRootRoute<*>>

typealias Search = ReadonlyRecord<String, *>

SearchMiddleware

typealias SearchMiddleware = (context: SearchMiddlewareContext) -> Search

SearchMiddlewareContext

external interface SearchMiddlewareContext

SearchParamError

external class SearchParamError : Throwable

Error thrown when search parameter validation fails.

typealias SearchParser = (searchStr: String) -> Search

SearchSerializer

typealias SearchSerializer = (searchObj: Search) -> String

SsrContextOptions

external interface SsrContextOptions

sealed external interface SSROption

external interface SSROptions

class SuspendInvoker<O : Any, R>

external interface ToOptions

sealed external interface TrailingSlash

UpdatableRouteOptions

external interface UpdatableRouteOptions

UseNavigateResult

typealias UseNavigateResult = Invoker<NavigateOptions, Promise<Void>>

ViewTransitionOptions

external interface ViewTransitionOptions

Properties

val TrailingSlash.Companion.always: TrailingSlash

val LoaderStaleReloadMode.Companion.background: LoaderStaleReloadMode

val LoaderStaleReloadMode.Companion.blocking: LoaderStaleReloadMode

val SSROption.Companion.dataOnly: SSROption

DEFAULT_PROTOCOL_ALLOWLIST

external val DEFAULT_PROTOCOL_ALLOWLIST: ReadonlyArray<String>

Default list of URL protocols to allow in links, redirects, and navigation. Any absolute URL protocol not in this list is treated as dangerous by default.

val Cause.Companion.enter: Cause

val Preload.Companion.false: Preload

val SSROption.Companion.false: SSROption

val NotFoundMode.Companion.fuzzy: NotFoundMode

val Preload.Companion.intent: Preload

val TrailingSlash.Companion.never: TrailingSlash

val Cause.Companion.preload: Cause

val TrailingSlash.Companion.preserve: TrailingSlash

val Preload.Companion.render: Preload

val NotFoundMode.Companion.root: NotFoundMode

external val rootRouteId: RootRouteId

val Cause.Companion.stay: Cause

val SSROption.Companion.true: SSROption

val Preload.Companion.viewport: Preload

Functions

operator fun LocationRewriteFunction.invoke(url: URL): URL?

A function that will be called to rewrite the URL.

external fun isNotFound(value: Any?): Boolean

Determine if a value is a TanStack Router not-found error.

external fun isRedirect(value: Any?): Boolean

fun notFound(): Nothing

Create a not-found error object recognized by TanStack Router.

fun notFound(block: NotFoundOptions.() -> Unit): Nothing

inline fun ParamName(value: String): ParamName

fun redirect(block: RedirectOptions.() -> Unit): Nothing

inline fun RouteId(value: String): RouteId

fun RouteLoaderFn(block: suspend CoroutineScope.(options: LoaderFnContext) -> LoaderData?): RouteLoaderFn

inline fun RoutePath(value: String): RoutePath

inline fun RoutePath(segment1: String, paramName1: ParamName): RoutePath

inline fun RoutePath(segment1: String, paramName1: ParamName, segment2: String): RoutePath

inline fun RoutePath(segment1: String, paramName1: ParamName, segment2: String, paramName2: ParamName): RoutePath