docs(router): clarify the description of legacy relativeLinkResolution (#40384)

PR Close #40384
This commit is contained in:
markostanimirovic 2021-01-11 01:55:27 +01:00 committed by atscott
parent 4e6d69cc85
commit 4a7a649852
1 changed files with 5 additions and 2 deletions

View File

@ -411,7 +411,9 @@ export interface ExtraOptions {
* ];
* ```
*
* From the `ContainerComponent`, this will not work:
* From the `ContainerComponent`, you should be able to navigate to `AComponent` using
* the following `routerLink`, but it will not work if `relativeLinkResolution` is set
* to `'legacy'`:
*
* `<a [routerLink]="['./a']">Link to A</a>`
*
@ -419,7 +421,8 @@ export interface ExtraOptions {
*
* `<a [routerLink]="['../a']">Link to A</a>`
*
* In other words, you're required to use `../` rather than `./`.
* In other words, you're required to use `../` rather than `./` when the relative link
* resolution is set to `'legacy'`.
*
* The default in v11 is `corrected`.
*/