RouterOptions

Types

Link copied to clipboard
interface Search
Link copied to clipboard
interface SSR

Properties

Link copied to clipboard
abstract val additionalContext: Any?
Link copied to clipboard
abstract val basepath: String?

The basepath for then entire router. This is useful for mounting a router instance at a subpath.

Link copied to clipboard
abstract val caseSensitive: Boolean?

If true, all routes will be matched as case-sensitive.

Link copied to clipboard
abstract val context: Any?

The root context that will be provided to all routes in the route tree.

Link copied to clipboard
abstract val defaultGcTime: Int?

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

Link copied to clipboard

The default hashScrollIntoView a route should use if no hashScrollIntoView is provided while navigating

Link copied to clipboard
abstract val defaultPendingMinMs: Int?

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

Link copied to clipboard
abstract val defaultPendingMs: Int?

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

Link copied to clipboard
abstract val defaultPreload: Preload?

If false, routes will not be preloaded by default in any way.

Link copied to clipboard
abstract val defaultPreloadDelay: Int?

The delay in milliseconds that a route must be hovered over or touched before it is preloaded.

Link copied to clipboard
abstract val defaultPreloadGcTime: Int?

The default defaultPreloadGcTime a route should use if no preloadGcTime is provided.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
abstract val defaultSsr: Any?

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

Link copied to clipboard
abstract val defaultStaleTime: Int?

The default staleTime a route should use if no staleTime is provided. This is the time in milliseconds that a route will be considered fresh.

Link copied to clipboard

Configures whether structural sharing is enabled by default for fine-grained selectors.

Link copied to clipboard

If true, route navigations will called using document.startViewTransition().

Link copied to clipboard

When true, disables the global catch boundary that normally wraps all route matches. This allows unhandled errors to bubble up to top-level error handlers in the browser.

Link copied to clipboard
abstract val history: RouterHistory?

The history object that will be used to manage the browser history.

Link copied to clipboard
abstract val isPrerendering: Boolean?

default - false

Link copied to clipboard
abstract val isServer: Boolean?

While usually automatic, sometimes it can be useful to force the router into a server-side state, e.g. when using the router in a non-browser environment that has access to a global.document object.

Link copied to clipboard
abstract val isShell: Boolean?

default - false

Link copied to clipboard
abstract val notFoundMode: NotFoundMode?

default - 'fuzzy' API Docs Guide

Link copied to clipboard
abstract val origin: String?

Configures how the router will rewrite the location between the actual href and the internal href of the router.

Link copied to clipboard

Configures which URI characters are allowed in path params that would ordinarily be escaped by encodeURIComponent.

Link copied to clipboard
abstract val routeTree: TRouteTree

The route tree that will be used to configure the router instance.

Link copied to clipboard

The default behavior for scroll restoration.

Link copied to clipboard

An array of selectors that will be used to scroll to the top of the page in addition to window

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract val ssr: RouterOptions.SSR?
Link copied to clipboard
abstract val unmaskOnReload: Boolean?

If true, route masks will, by default, be removed when the page is reloaded.