ExtraOptions
Represents options to configure the router.
- interface ExtraOptions {
- enableTracing?: boolean
- useHash?: boolean
- initialNavigation?: InitialNavigation
- errorHandler?: ErrorHandler
- preloadingStrategy?: any
- onSameUrlNavigation?: 'reload' | 'ignore'
- scrollPositionRestoration?: 'disabled' | 'enabled' | 'top'
- anchorScrolling?: 'disabled' | 'enabled'
- scrollOffset?: [number, number] | (() => [number, number])
- paramsInheritanceStrategy?: 'emptyOnly' | 'always'
- malformedUriErrorHandler?: (error: URIError, urlSerializer: UrlSerializer, url: string) => UrlTree
- urlUpdateStrategy?: 'deferred' | 'eager'
- relativeLinkResolution?: 'legacy' | 'corrected'
- }
Properties
Property | Description |
---|---|
enableTracing?: boolean
|
Makes the router log all its internal events to the console. |
useHash?: boolean
|
Enables the location strategy that uses the URL fragment instead of the history API. |
initialNavigation?: InitialNavigation
|
Disables the initial navigation. |
errorHandler?: ErrorHandler
|
A custom error handler. |
preloadingStrategy?: any
|
Configures a preloading strategy. See |
onSameUrlNavigation?: 'reload' | 'ignore'
|
Define what the router should do if it receives a navigation request to the current URL. By default, the router will ignore this navigation. However, this prevents features such as a "refresh" button. Use this option to configure the behavior when navigating to the current URL. Default is 'ignore'. |
scrollPositionRestoration?: 'disabled' | 'enabled' | 'top'
|
Configures if the scroll position needs to be restored when navigating back.
You can implement custom scroll restoration behavior by adapting the enabled behavior as follows:
|
anchorScrolling?: 'disabled' | 'enabled'
|
Configures if the router should scroll to the element when the url has a fragment.
Anchor scrolling does not happen on 'popstate'. Instead, we restore the position that we stored or scroll to the top. |
scrollOffset?: [number, number] | (() => [number, number])
|
Configures the scroll offset the router will use when scrolling to an element. When given a tuple with two numbers, the router will always use the numbers. When given a function, the router will invoke the function every time it restores scroll position. |
paramsInheritanceStrategy?: 'emptyOnly' | 'always'
|
Defines how the router merges params, data and resolved data from parent to child routes. Available options are:
|
malformedUriErrorHandler?: (error: URIError, urlSerializer: UrlSerializer, url: string) => UrlTree
|
A custom malformed uri error handler function. This handler is invoked when encodedURI contains invalid character sequences. The default implementation is to redirect to the root url dropping any path or param info. This function passes three parameters:
|
urlUpdateStrategy?: 'deferred' | 'eager'
|
Defines when the router updates the browser URL. The default behavior is to update after successful navigation. However, some applications may prefer a mode where the URL gets updated at the beginning of navigation. The most common use case would be updating the URL early so if navigation fails, you can show an error message with the URL that failed. Available options are:
|
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 |