填写这份《一分钟调查》,帮我们(开发组)做得更好!去填写Home

ExtraOptions

表示路由器的配置项。

A set of configuration options for a router module, provided in the forRoot() method.

      
      interface ExtraOptions {
  enableTracing?: boolean
  useHash?: boolean
  initialNavigation?: InitialNavigation
  errorHandler?: ErrorHandler
  preloadingStrategy?: any
  onSameUrlNavigation?: 'reload' | 'ignore'
  scrollPositionRestoration?: 'disabled' | 'enabled' | 'top'
  scrollOffset?: [number, number] | (() => [number, number])
  paramsInheritanceStrategy?: 'emptyOnly' | 'always'
  malformedUriErrorHandler?: (error: URIError, urlSerializer: UrlSerializer, url: string) => UrlTree
  urlUpdateStrategy?: 'deferred' | 'eager'
  relativeLinkResolution?: 'legacy' | 'corrected'
}
    

属性

属性说明
enableTracing?: boolean

When true, log all internal navigation events to the console. Use for debugging.

useHash?: boolean

修改位置策略(LocationStrategy),用 URL 片段(#)代替 history API。

When true, enable the location strategy that uses the URL fragment instead of the history API.

initialNavigation?: InitialNavigation

One of enabled or disabled. When set to enabled, the initial navigation starts before the root component is created. The bootstrap is blocked until the initial navigation is complete. This value is required for server-side rendering to work. When set to disabled, the initial navigation is not performed. The location listener is set up before the root component gets created. Use if there is a reason to have more control over when the router starts its initial navigation due to some complex initialization logic.

Legacy values are deprecated since v4 and should not be used for new applications:

  • legacy_enabled - Default for compatibility. The initial navigation starts after the root component has been created, but the bootstrap is not blocked until the initial navigation is complete.
  • legacy_disabled - The initial navigation is not performed. The location listener is set up after the root component gets created.
  • true - same as legacy_enabled.
  • false - same as legacy_disabled.

禁用首次导航

errorHandler?: ErrorHandler

自定义的错误处理器。

A custom error handler for failed navigations.

preloadingStrategy?: any

配置预加载策略,参见 PreloadAllModules

Configures a preloading strategy. One of PreloadAllModules or NoPreloading (the default).

onSameUrlNavigation?: 'reload' | 'ignore'

规定当路由器收到一个导航到当前 URL 的请求时该如何处理。 默认情况下,路由器会忽略本次导航。不过,这会阻止实现类似于"刷新"按钮的功能。 使用该选项可以控制导航到当前 URL 时的行为。默认为 'ignore'。

Define what the router should do if it receives a navigation request to the current URL. Default is ignore, which causes the router ignores the navigation. This can disable 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.

  • 'disabled' - 什么也不做(默认)。在导航时,会自动维护滚动位置

    'disabled'- (Default) Does nothing. Scroll position is maintained on navigation.

  • 'top' - 在任何一次导航中都把滚动位置设置为 x=0, y=0。

    'top'- Sets the scroll position to x = 0, y = 0 on all navigation.

  • 'enabled' —— 当向后导航时,滚动到以前的滚动位置。当向前导航时,如果提供了锚点,则自动滚动到那个锚点,否则把滚动位置设置为 [0, 0]。该选项将来会变成默认值。

    'enabled'- Restores the previous scroll position on backward navigation, else sets the position to the anchor if one is provided, or sets the scroll position to [0, 0] (forward navigation). This option will be the default in the future.

你可以像下面的例子一样适配它启用时的行为,来自定义恢复滚动位置的策略:

You can implement custom scroll restoration behavior by adapting the enabled behavior as in the following example.

class AppModule { constructor(router: Router, viewportScroller: ViewportScroller) { router.events.pipe( filter((e: Event): e is Scroll => e instanceof Scroll) ).subscribe(e => { if (e.position) { // backward navigation viewportScroller.scrollToPosition(e.position); } else if (e.anchor) { // anchor navigation viewportScroller.scrollToAnchor(e.anchor); } else { // forward navigation viewportScroller.scrollToPosition([0, 0]); } }); } }
      
      class AppModule {
  constructor(router: Router, viewportScroller: ViewportScroller) {
    router.events.pipe(
      filter((e: Event): e is Scroll => e instanceof Scroll)
    ).subscribe(e => {
      if (e.position) {
        // backward navigation
        viewportScroller.scrollToPosition(e.position);
      } else if (e.anchor) {
        // anchor navigation
        viewportScroller.scrollToAnchor(e.anchor);
      } else {
        // forward navigation
        viewportScroller.scrollToPosition([0, 0]);
      }
    });
  }
}
    
scrollOffset?: [number, number] | (() => [number, number])

When set to 'enabled', scrolls to the anchor element when the URL has a fragment. Anchor scrolling is disabled by default.

Anchor scrolling does not happen on 'popstate'. Instead, we restore the position that we stored or scroll to the top.

anchorScrolling?: 'disabled'|'enabled';

配置当滚动到一个元素时,路由器使用的滚动偏移。

/** 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.

paramsInheritanceStrategy?: 'emptyOnly' | 'always'

Defines how the router merges parameters, data, and resolved data from parent to child routes. By default ('emptyOnly'), inherits parent parameters only for path-less or component-less routes. Set to 'always' to enable unconditional inheritance of parent parameters.

malformedUriErrorHandler?: (error: URIError, urlSerializer: UrlSerializer, url: string) => UrlTree

一个自定义的 URI 格式无效错误的处理器。每当 encodeURI 包含无效字符序列时,就会调用该处理器。默认的实现是跳转到根路径,抛弃任何路径和参数信息。该函数传入三个参数:

A custom handler for malformed URI errors. The handler is invoked when encodedURI contains invalid character sequences. The default implementation is to redirect to the root URL, dropping any path or parameter information. The function takes three parameters:

  • 'URIError' - 当传入错误的 URL 时抛出的错误。

    'URIError' - Error thrown when parsing a bad URL.

  • 'UrlSerializer' - 路由器所配置的 UrlSerializer。

    'UrlSerializer' - UrlSerializer that’s configured with the router.

  • 'url' - 导致 URIError 的格式无效的 URL

    'url' - The malformed URL that caused the URIError

urlUpdateStrategy?: 'deferred' | 'eager'

Defines when the router updates the browser URL. By default ('deferred'), update after successful navigation. Set to 'eager' if prefer to update the URL at the beginning of navigation. Updating the URL early allows you to handle a failure of navigation by showing an error message with the URL that failed.

relativeLinkResolution?: 'legacy' | 'corrected'

启用 BUG 补丁,纠正空路径组件的相对链接解析问题。

Enables a bug fix that corrects relative link resolution in components with empty paths. Example:

const routes = [ { path: '', component: ContainerComponent, children: [ { path: 'a', component: AComponent }, { path: 'b', component: BComponent }, ] } ];
      
      const routes = [
  {
    path: '',
    component: ContainerComponent,
    children: [
      { path: 'a', component: AComponent },
      { path: 'b', component: BComponent },
    ]
  }
];
    

ContainerComponent 中不能这样用:

From the ContainerComponent, this will not work:

<a [routerLink]="['./a']">Link to A</a>

不过,可以这样用:

However, this will work:

<a [routerLink]="['../a']">Link to A</a>

换句话说,要使用 ../ 而不是 ./。它是当前版本的默认行为。把该选项设置为 corrected 可以启用这项修正。

In other words, you're required to use ../ rather than ./. This is currently the default behavior. Setting this option to corrected enables the fix.