angular-cn/aio/dist/generated/docs/api/router/InitialNavigation.json

5 lines
4.8 KiB
JSON

{
"id": "api/router/InitialNavigation",
"title": "InitialNavigation",
"contents": "\n\n<article>\n <div class=\"breadcrumb-container\">\n <div class=\"breadcrumb\">\n <script type=\"application/ld+json\">\n {\n \"@context\": \"http://schema.org\",\n \"@type\": \"BreadcrumbList\",\n \"itemListElement\": [\n { \"@type\": \"ListItem\", \"position\": 1, \"item\": { \"@id\": \"https://angular.io//api\", \"name\": \"API\" } },\n { \"@type\": \"ListItem\", \"position\": 2, \"item\": { \"@id\": \"https://angular.io/api/router\", \"name\": \"@angular/router\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://angular.io/api/router/InitialNavigation\", \"name\": \"InitialNavigation\" } }\n ]\n }\n </script>\n <a href=\"/api\">API</a> > <a href=\"api/router\">@angular/router</a>\n </div>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/router/src/router_module.ts?message=docs(router)%3A%20describe%20your%20change...#L220-L245\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/router_module.ts#L220-L245\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n \n <header class=\"api-header\">\n <h1 id=\"initialnavigation\">InitialNavigation<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/InitialNavigation#initialnavigation\"><i class=\"material-icons\">link</i></a></h1>\n \n <label class=\"api-type-label type-alias\">type-alias</label>\n \n \n \n </header>\n \n <aio-toc class=\"embedded\"></aio-toc>\n\n <div class=\"api-body\">\n \n <section class=\"short-description\">\n <p>Allowed values in an <code><a href=\"api/router/ExtraOptions\" class=\"code-anchor\">ExtraOptions</a></code> object that configure\nwhen the router performs the initial navigation operation.</p>\n\n <p><a href=\"api/router/InitialNavigation#description\">See more...</a></p>\n </section>\n \n \n \n <section class=\"type-alias-overview\">\n <code-example language=\"ts\" hidecopy=\"true\">\n type <a href=\"api/router/InitialNavigation\" class=\"code-anchor\">InitialNavigation</a> = 'disabled' | 'enabled' | 'enabledBlocking' | 'enabledNonBlocking';\n </code-example>\n </section>\n\n \n<section class=\"see-also\">\n <h2 id=\"see-also\">See also<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/InitialNavigation#see-also\"><i class=\"material-icons\">link</i></a></h2>\n <ul>\n \n <li><p><code>forRoot()</code></p>\n</li>\n </ul>\n</section>\n\n\n \n \n<section class=\"description\">\n <h2 id=\"description\">Description<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/InitialNavigation#description\"><i class=\"material-icons\">link</i></a></h2>\n <ul>\n<li>'enabledNonBlocking' - (default) The initial navigation starts after the\nroot component has been created. The bootstrap is not blocked on the completion of the initial\nnavigation.</li>\n<li>'enabledBlocking' - The initial navigation starts before the root component is created.\nThe bootstrap is blocked until the initial navigation is complete. This value is required\nfor <a href=\"guide/universal\">server-side rendering</a> to work.</li>\n<li>'disabled' - The initial navigation is not performed. The location listener is set up before\nthe root component gets created. Use if there is a reason to have\nmore control over when the router starts its initial navigation due to some complex\ninitialization logic.</li>\n</ul>\n<p>The following values have been <a href=\"guide/releases#deprecation-practices\">deprecated</a> since v11,\nand should not be used for new applications.</p>\n<ul>\n<li>'enabled' - This option is 1:1 replaceable with <code>enabledBlocking</code>.</li>\n</ul>\n\n \n</section>\n\n\n \n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/router\n - api/router/ExtraOptions\n - guide/updating-to-version-11\n-->\n<!-- links from this doc:\n - /api\n - api/router\n - api/router/ExtraOptions\n - api/router/InitialNavigation#description\n - api/router/InitialNavigation#initialnavigation\n - api/router/InitialNavigation#see-also\n - guide/releases#deprecation-practices\n - guide/universal\n - https://github.com/angular/angular/edit/master/packages/router/src/router_module.ts?message=docs(router)%3A%20describe%20your%20change...#L220-L245\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/router_module.ts#L220-L245\n-->"
}