Class Router

Svelte Router core class.

Hierarchy

Router

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Router(opts: RouterConfig): Router

- Defined in router.ts:121
constructor

Parameters
- opts: RouterConfig
Returns Router

Accessors

activeClass

get activeClass(): string

- Defined in router.ts:220
Get router link active class

Returns string

basename

get basename(): string

- Defined in router.ts:199
Get router basename

Returns string

currentRoute

get currentRoute(): Route | null

- Defined in router.ts:213
Get current resolved route

Returns Route | null

mode

get mode(): HISTORY_MODE

- Defined in router.ts:192
Get router mode

Returns HISTORY_MODE

routes

get routes(): RouteConfig[]

- Defined in router.ts:206
Get routes

Returns RouteConfig[]

Methods

back

back(): void

- Defined in router.ts:359
Go one step back in the navigation history.

Returns void

forward

forward(): void

- Defined in router.ts:366
Go one step forward in the navigation history.

Returns void

go

go(n: number): void

- Defined in router.ts:352
Go to a specific history position in the navigation history.

Parameters
- n: number
  
  number of steps to forward or backwards (negative number).
Returns void

navigationGuard

navigationGuard(guard: navigationGuardFunction): function

- Defined in router.ts:233
Register a navigation guard which will be called whenever a navigation is triggered. All registered navigation guards are resolved in sequence. Navigation guard must call the next() function to continue the execution of navigation change.

Parameters
- guard: navigationGuardFunction
  
  Guard callback function.
Returns function

Unregister guard function.
- - (): void
  - Returns void

onBeforeNavigation

onBeforeNavigation(callback: onNavigationCallback): function

- Defined in router.ts:250
Register a callback which will be called before execution of navigation guards.

Parameters
- callback: onNavigationCallback
  
  callback function.
Returns function

Unregister listener function.
- - (): void
  - Returns void

onError

onError(callback: onErrorCallback): function

- Defined in router.ts:279
Register a callback which will be called when an error is caught during a route navigation.

Parameters
- callback: onErrorCallback
  
  Callback function.
Returns function

Unregister callback function.
- - (): void
  - Returns void

onNavigationChanged

onNavigationChanged(callback: onNavigationCallback): function

- Defined in router.ts:265
Register a callback which will be called when all navigation guards are resolved, and the final navigation change is resolved.

Parameters
- callback: onNavigationCallback
  
  callback function.
Returns function

Unregister listener function.
- - (): void
  - Returns void

push

push(rawLocation: RawLocation | string, onComplete?: undefined | function, onAbort?: undefined | function): void

- Defined in router.ts:294
Push to navigation.

throws

When the rawLocation is invalid or when the path is invalid.

Parameters
- rawLocation: RawLocation | string
  
  raw path or location object.
- Optional onComplete: undefined | function
  
  On complete callback function.
- Optional onAbort: undefined | function
  
  On abort callback function.
Returns void

replace

replace(rawLocation: RawLocation | string, onComplete?: undefined | function, onAbort?: undefined | function): void

- Defined in router.ts:324
Replace in navigation

throws

when the rawLocation is invalid or when the path is invalid.

Parameters
- rawLocation: RawLocation | string
  
  raw path or location object.
- Optional onComplete: undefined | function
  
  On complete callback function.
- Optional onAbort: undefined | function
  
  On abort callback function.
Returns void

routeURL

routeURL(rawLocation: RawLocation): string

- Defined in router.ts:376
Generate route URL from the the raw location.

throws

when the route is not found or the route params are not valid.

Parameters
- rawLocation: RawLocation
  
  raw location object.
Returns string

start

start(): void

- Defined in router.ts:185
Trigger the on load history change.

Returns void

Generated using TypeDoc