On this page
ExtraOptions
interface
A set of configuration options for a router module, provided in the forRoot()
method.
interface ExtraOptions extends InMemoryScrollingOptions, RouterConfigOptions {
enableTracing?: boolean
useHash?: boolean
initialNavigation?: InitialNavigation
errorHandler?: ErrorHandler
preloadingStrategy?: any
scrollOffset?: [...]
malformedUriErrorHandler?: (error: URIError, urlSerializer: UrlSerializer, url: string) => UrlTree
relativeLinkResolution?: 'legacy' | 'corrected'
// inherited from router/InMemoryScrollingOptions
anchorScrolling?: 'disabled' | 'enabled'
scrollPositionRestoration?: 'disabled' | 'enabled' | 'top'
// inherited from router/RouterConfigOptions
canceledNavigationResolution?: 'replace' | 'computed'
onSameUrlNavigation?: 'reload' | 'ignore'
paramsInheritanceStrategy?: 'emptyOnly' | 'always'
urlUpdateStrategy?: 'deferred' | 'eager'
}
See also
forRoot()
Properties
Property | Description |
---|---|
enableTracing?: boolean |
When true, log all internal navigation events to the console. Use for debugging. |
useHash?: boolean |
When true, enable the location strategy that uses the URL fragment instead of the history API. |
initialNavigation?: InitialNavigation |
One of |
errorHandler?: ErrorHandler |
A custom error handler for failed navigations. If the handler returns a value, the navigation Promise is resolved with this value. If the handler throws an exception, the navigation Promise is rejected with the exception. |
preloadingStrategy?: any |
Configures a preloading strategy. One of |
scrollOffset?: [ number, number ] | (() => [ number, number ]) |
Configures the scroll offset the router will use when scrolling to an element. When given a tuple with x and y position value, the router uses that offset each time it scrolls. When given a function, the router invokes the function every time it restores scroll position. |
malformedUriErrorHandler?: (error: URIError, urlSerializer: UrlSerializer, url: string) => UrlTree |
A custom handler for malformed URI errors. The handler is invoked when
|
relativeLinkResolution?: 'legacy' | 'corrected' |
Enables a bug fix that corrects relative link resolution in components with empty paths. Example: From the
However, this will work:
In other words, you're required to use The default in v11 is Deprecated |
© 2010–2023 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v14.angular.io/api/router/ExtraOptions