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

RouterOptions

external interface RouterOptions : RouterOptions<RootRoute> (source)

Properties

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

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

Link copied to clipboard
abstract val defaultErrorComponent: ErrorRouteComponent?

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

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

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

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

The default onCatch handler for errors caught by the Router ErrorBoundary

Link copied to clipboard
abstract val defaultPendingComponent: RouteComponent?

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

Link copied to clipboard
abstract val defaultPendingMinMs: Int?
Link copied to clipboard
abstract val defaultPendingMs: Int?
Link copied to clipboard
abstract val defaultPreload: Preload?
Link copied to clipboard
abstract val defaultPreloadDelay: Int?
Link copied to clipboard
abstract val defaultPreloadGcTime: Int?
Link copied to clipboard
Link copied to clipboard
abstract val defaultPreloadStaleTime: Int?
Link copied to clipboard
abstract val defaultSsr: Any?
Link copied to clipboard
abstract val defaultStaleTime: Int?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract val history: RouterHistory?
Link copied to clipboard
abstract val InnerWrap: ComponentType<PropsWithChildren>?

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

Link copied to clipboard
abstract val isPrerendering: Boolean?
Link copied to clipboard
abstract val isServer: Boolean?
Link copied to clipboard
abstract val isShell: Boolean?
Link copied to clipboard
abstract val notFoundMode: NotFoundMode?
Link copied to clipboard
abstract val origin: String?
Link copied to clipboard
Link copied to clipboard
abstract val routeTree: RootRoute
Link copied to clipboard
Link copied to clipboard
abstract val scrollToTopSelectors: ReadonlyArray<() -> Element?>?
Link copied to clipboard
abstract val search: RouterOptions.Search?
Link copied to clipboard
Link copied to clipboard
abstract val ssr: RouterOptions.SSR?
Link copied to clipboard
abstract val unmaskOnReload: Boolean?
Link copied to clipboard
abstract val Wrap: ComponentType<PropsWithChildren>?

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