kotlin-tanstack-react-router/tanstack.react.router/RouterOptions

RouterOptions

external interface RouterOptions : RouterOptions<RootRoute> (source)

Properties

Link copied to clipboard
abstract external val additionalContext: Context?
Link copied to clipboard
abstract external val basepath: String?
Link copied to clipboard
abstract external val caseSensitive: Boolean?
Link copied to clipboard
abstract external val context: Context?
Link copied to clipboard
abstract external val defaultComponent: RouteComponent?

The default component a route should use if no component is provided.

Link copied to clipboard
abstract external val defaultErrorComponent: ErrorRouteComponent?

The default errorComponent a route should use if no error component is provided.

Link copied to clipboard
abstract external val defaultGcTime: Int?
Link copied to clipboard
Link copied to clipboard
abstract external val defaultNotFoundComponent: NotFoundRouteComponent?

The default notFoundComponent a route should use if no notFound component is provided.

Link copied to clipboard
abstract external val defaultOnCatch: (JsError, errorInfo: ErrorInfo) -> Unit?

The default onCatch handler for errors caught by the Router ErrorBoundary

Link copied to clipboard
abstract external val defaultPendingComponent: RouteComponent?

The default pendingComponent a route should use if no pending component is provided.

Link copied to clipboard
abstract external val defaultPendingMinMs: Int?
Link copied to clipboard
abstract external val defaultPendingMs: Int?
Link copied to clipboard
abstract external val defaultPreload: Preload?
Link copied to clipboard
abstract external val defaultPreloadDelay: Int?
Link copied to clipboard
abstract external val defaultPreloadGcTime: Int?
Link copied to clipboard
abstract external val defaultPreloadIntentProximity: Int?
Link copied to clipboard
abstract external val defaultPreloadStaleTime: Int?
Link copied to clipboard
abstract external val defaultSsr: SSROption?
Link copied to clipboard
Link copied to clipboard
abstract external val defaultStaleTime: Int?
Link copied to clipboard
abstract external val defaultStructuralSharing: Boolean?
Link copied to clipboard
Link copied to clipboard
abstract external val disableGlobalCatchBoundary: Boolean?
Link copied to clipboard
abstract external val getScrollRestorationKey: (location: ParsedLocation) -> String?
Link copied to clipboard
abstract external val history: RouterHistory?
Link copied to clipboard
abstract external val InnerWrap: ComponentType<PropsWithChildren>?

A component that will be used to wrap the inner contents of the router.

Link copied to clipboard
abstract external val isPrerendering: Boolean?
Link copied to clipboard
abstract external val isServer: Boolean?
Link copied to clipboard
abstract external val isShell: Boolean?
Link copied to clipboard
abstract external val notFoundMode: NotFoundMode?
Link copied to clipboard
abstract external val origin: String?
Link copied to clipboard
abstract external val parseSearch: SearchParser?
Link copied to clipboard
Link copied to clipboard
abstract external val protocolAllowlist: ReadonlyArray<String>?
Link copied to clipboard
abstract external val rewrite: LocationRewrite?
Link copied to clipboard
abstract external val routeTree: RootRoute
Link copied to clipboard
abstract external val scrollRestoration: (options: RouterOptions.ScrollRestorationOptions) -> Boolean?
Link copied to clipboard
abstract external val scrollRestorationBehavior: ScrollBehavior?
Link copied to clipboard
abstract external val scrollToTopSelectors: ReadonlyArray<() -> Element?>?
Link copied to clipboard
abstract external val search: RouterOptions.SearchOptions?
Link copied to clipboard
abstract external val serializationAdapters: ReadonlyArray<Any>?
Link copied to clipboard
abstract external val ssr: SSROptions?
Link copied to clipboard
abstract external val stringifySearch: SearchSerializer?
Link copied to clipboard
abstract external val trailingSlash: TrailingSlash?
Link copied to clipboard
abstract external val unmaskOnReload: Boolean?
Link copied to clipboard
abstract external val Wrap: ComponentType<PropsWithChildren>?

A component that will be used to wrap the entire router.

Generated by Dokka
© 2026 Copyright