Skip to content

Main Navigation Guide API

Appearance

Sidebar Navigation

Compositions

useLink

useNavigation

useQueryValue

useRejection

useRoute

useRouter

useViewTransition

Errors

DuplicateParamsError

LoaderDataAccessError

LoaderNameConflict

MetaPropertyConflict

NavigationAbandonedError

PayloadValueError

RouterNotInstalledError

SsrOptionRequiredError

UseRouteInvalidError

Interfaces

Register

Type Guards

isRoute

isResolvedRoute

isUrlString

Classes

UnreachableRouteError

Components

RouterLink

RouterProgress

RouterView

ViewTransition

Functions

arrayOf

asUrlString

createExternalRoute

createParam

createRejection

createRoute

createRouter

createRouterAssets

createRouterPlugin

createUrl

hasViewTransition

literal

tupleOf

unionOf

withDefault

withParams

Hooks

onAfterRouteLeave

onAfterRouteUpdate

onBeforeRouteLeave

onBeforeRouteUpdate

Types

AddAfterEnterHook

AddAfterLeaveHook

AddAfterUpdateHook

AddAliasOptions

AddBeforeEnterHook

AddBeforeLeaveHook

AddBeforeUpdateHook

AddErrorHook

AddLoaderOptions

AddRejectionHook

AddViewOptions

AddViewPropsCallbackContext

AddViewPropsGetter

AfterEnterHook

AfterEnterHookContext

AfterHookLifecycle

AfterLeaveHook

AfterLeaveHookContext

AfterUpdateHook

AfterUpdateHookContext

AliasTransform

AliasTransformContext

BeforeEnterHook

BeforeEnterHookContext

BeforeHookLifecycle

BeforeLeaveHook

BeforeLeaveHookContext

BeforeUpdateHook

BeforeUpdateHookContext

CreatedRouteOptions

CreateHookOptions

CreateLoaderOptions

CreateRouteOptions

CreateRouterPluginOptions

CreateUrlOptions

CreateViewOptions

ErrorHook

ErrorHookContext

Hook

HookCallbackContext

HookLifecycle

HookRegistrationOptions

HookRemove

LiteralParam

Loader

LoaderCallbackContext

LoaderGetter

NavigationBehavior

Param

ParamExtras

ParamGetSet

ParamGetter

ParamSetter

ParseUrlOptions

PrefetchConfig

PrefetchConfigOptions

PrefetchConfigs

PrefetchStrategy

PropsCallbackParent

QuerySource

RedirectStatus

RegisteredRouter

RejectContext

Rejection

RejectionHook

RejectionHookContext

RejectionHooks

Rejections

RejectionType

RenderRedirect

RenderReject

RenderSuccess

ResolvedRoute

ResolvedRouteUnion

Route

RouteAddAlias

RouteAddLoader

RouteAddView

RouteCallbackContext

RouteLoaders

RouteMeta

Router

RouterAssets

RouteRedirects

RouterLinkProps

RouterOptions

RouterPlugin

RouterProgressProps

RouterPush

RouterPushOptions

RouterReject

RouterRejectInternal

RouterRejections

RouterReplace

RouterReplaceOptions

RouterResolve

RouterResolvedRouteUnion

RouterResolveOptions

RouterRoute

RouterRouteName

RouterRoutes

RouterRouteUnion

RouterViewTransition

RouteViews

ServerRenderResponse

ToCallback

ToRoute

Url

UrlString

UseLink

UseLinkOptions

UseNavigation

View

ViewCallbackContext

ViewTransitionConfig

ViewTransitionConfigOptions

ViewTransitionConfigs

ViewTransitionContext

ViewTransitionProps

ViewTransitionTypes

ViewTransitionTypesCallback

WithData

WithHost

WithoutHost

WithoutParent

WithParent

Variables

createHook

createLoader

createView

On this page

Types: HookRegistrationOptions

ts

type HookRegistrationOptions = object;

Properties

Property	Type	Description
`signal?`	`AbortSignal`	Removes the hook when aborted.

Suggest changes to this page

Pager

Previous pageHookLifecycle

Next pageHookRemove