iSharkFly-Docs
/
angular-docs-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: correct default for router extra option (#32702) 

PR Close #32702
This commit is contained in:
Judy Bogart 2019-09-16 10:46:50 -07:00 committed by Andrew Kushnir
parent 7a00c676ec
commit 353368cccd
1 changed files with 21 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
packages/router/src/router_module.ts
View File

@ -229,16 +229,17 @@ export function provideRoutes(routes: Routes): any {
* Allowed values in an `ExtraOptions` object that configure * Allowed values in an `ExtraOptions` object that configure
* when the router performs the initial navigation operation. * when the router performs the initial navigation operation.
* *
* * 'enabled' (Default) The initial navigation starts before the root component is created. * * 'enabled' - The initial navigation starts before the root component is created.
* The bootstrap is blocked until the initial navigation is complete. * The bootstrap is blocked until the initial navigation is complete. This value is required
* for [server-side rendering](guide/universal) to work.
* * 'disabled' - The initial navigation is not performed. The location listener is set up before * * '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 * 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 * more control over when the router starts its initial navigation due to some complex
* initialization logic. * initialization logic.
* * 'legacy_enabled'- The initial navigation starts after the root component has been created. * * 'legacy_enabled'- (Default, for compatibility.) The initial navigation starts after the root component has been created.
* The bootstrap is not blocked until the initial navigation is complete. @deprecated * The bootstrap is not blocked until the initial navigation is complete. @deprecated
* * 'legacy_disabled'- The initial navigation is not performed. The location listener is set up * * 'legacy_disabled'- The initial navigation is not performed. The location listener is set up
* after the root component gets created. @deprecated * after the root component gets created. @deprecated since v4
* * `true` - same as 'legacy_enabled'. @deprecated since v4 * * `true` - same as 'legacy_enabled'. @deprecated since v4
* * `false` - same as 'legacy_disabled'. @deprecated since v4 * * `false` - same as 'legacy_disabled'. @deprecated since v4
* *
@ -271,11 +272,24 @@ export interface ExtraOptions {
useHash?: boolean; useHash?: boolean;
/** /**
* One of `enabled` (the default) or `disabled`. * One of `enabled` or `disabled`.
* By default, the initial navigation starts before the root component is created. * When set to `enabled`, the initial navigation starts before the root component is created.
* The bootstrap is blocked until the initial navigation is complete. * The bootstrap is blocked until the initial navigation is complete. This value is required for
* [server-side rendering](guide/universal) to work.
* When set to `disabled`, the initial navigation is not performed. * When set to `disabled`, the initial navigation is not performed.
* The location listener is set up before the root component gets created. * 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`.
*/ */
initialNavigation?: InitialNavigation; initialNavigation?: InitialNavigation;