Skip to content

Main Navigation Guide API

Appearance

Sidebar Navigation

Compositions

useLink

useRoute

useRouter

Errors

DuplicateParamsError

MetaPropertyConflict

RouterNotInstalledError

UseRouteInvalidError

Interfaces

Register

Type Guards

isRoute

isUrl

Functions

arrayOf

asUrl

createExternalRoute

createParam

createRoute

createRouter

createRouterPlugin

tupleOf

unionOf

withDefault

withParams

Hooks

onAfterRouteLeave

onAfterRouteUpdate

onBeforeRouteLeave

onBeforeRouteUpdate

Types

AddAfterRouteHook

AddBeforeRouteHook

AddComponentAfterRouteHook

AddComponentBeforeRouteHook

AddGlobalRouteHooks

AfterHookContext

AfterRouteHook

AfterRouteHookContext

AfterRouteHookLifecycle

AfterRouteHookRegistration

AfterRouteHookResponse

BeforeHookContext

BeforeRouteHook

BeforeRouteHookContext

BeforeRouteHookLifecycle

BeforeRouteHookRegistration

BeforeRouteHookResponse

CreatedRouteOptions

CreateRouteOptions

LiteralParam

Param

ParamExtras

ParamGetSet

ParamGetter

ParamSetter

PrefetchConfig

PrefetchStrategy

PropsCallbackContext

QuerySource

RegisteredRejectionType

RegisteredRouteMap

RegisteredRouter

RegisteredRouterPush

RegisteredRouterReject

RegisteredRouterReplace

RegisteredRouterRoute

RegisteredRoutes

RegisteredRoutesName

ResolvedRoute

Route

RouteHook

RouteHookAfterRunner

RouteHookBeforeRunner

RouteHookLifecycle

RouteHookRemove

RouteHookResponse

RouteHookTiming

RouteMeta

Router

RouterOptions

RouterPlugin

RouterPushOptions

RouterRoute

RouterRoutes

Routes

ToCallback

Url

UrlParts

UseLink

UseLinkOptions

WithHooks

On this page

Types: RegisteredRouterRoute

ts

type RegisteredRouterRoute = RegisteredRouter["route"];

Represents the Router property within Register

Suggest changes to this page

Pager

Previous pageRegisteredRouterReplace

Next pageRegisteredRoutes