5 lines
51 KiB
JSON
5 lines
51 KiB
JSON
{
|
|
"id": "api/router/NavigationStart",
|
|
"title": "NavigationStart",
|
|
"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/NavigationStart\", \"name\": \"NavigationStart\" } }\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/events.ts?message=docs(router)%3A%20describe%20your%20change...#L52-L106\" 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/events.ts#L52-L106\" 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=\"navigationstart\">NavigationStart<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/NavigationStart#navigationstart\"><i class=\"material-icons\">link</i></a></h1>\n \n <label class=\"api-type-label class\">class</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>An event triggered when a navigation starts.</p>\n\n \n </section>\n \n \n \n <section class=\"class-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\nclass <a href=\"api/router/NavigationStart\" class=\"code-anchor\">NavigationStart</a> extends <a class=\"code-anchor\" href=\"api/router/RouterEvent\">RouterEvent</a> {\n <a class=\"code-anchor\" href=\"api/router/NavigationStart#constructor()\"><span class=\"member-name\">constructor</span>(id: number, url: string, navigationTrigger: \"imperative\" | \"popstate\" | \"hashchange\" = 'imperative', restoredState: { [k: string]: any; navigationId: number; } = null)</a>\n <a class=\"code-anchor\" href=\"api/router/NavigationStart#navigationTrigger\"><span class=\"member-name\">navigationTrigger</span>?: 'imperative' | 'popstate' | 'hashchange'</a>\n <a class=\"code-anchor\" href=\"api/router/NavigationStart#restoredState\"><span class=\"member-name\">restoredState</span>?: {...}</a>\n <a class=\"code-anchor\" href=\"api/router/NavigationStart#toString\"><span class=\"member-name\">toString</span>(): string</a>\n\n // inherited from <a class=\"code-anchor\" href=\"api/router/RouterEvent\">router/RouterEvent</a>\n <a class=\"code-anchor\" href=\"api/router/RouterEvent#constructor()\"><span class=\"member-name\">constructor</span>(id: number, url: string)</a>\n <a class=\"code-anchor\" href=\"api/router/RouterEvent#id\"><span class=\"member-name\">id</span>: number</a>\n <a class=\"code-anchor\" href=\"api/router/RouterEvent#url\"><span class=\"member-name\">url</span>: string</a>\n}\n</code-example>\n\n \n \n\n</section>\n\n\n \n\n \n \n \n\n\n\n\n\n\n<h2 id=\"constructor\">Constructor<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/NavigationStart#constructor\"><i class=\"material-icons\">link</i></a></h2>\n<a id=\"constructor()\"></a>\n<table class=\"is-full-width method-table constructor\">\n \n <tbody>\n \n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">constructor</span>(id: number, url: string, navigationTrigger: \"imperative\" | \"popstate\" | \"hashchange\" = 'imperative', restoredState: { [k: string]: any; navigationId: number; } = null)</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table constructor-overload-parameters\">\n <tbody>\n \n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>id</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a></code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>navigationTrigger</code>\n </td>\n <td class=\"param-type\"><code>\"imperative\" | \"popstate\" | \"hashchange\"</code></td>\n <td class=\"param-description\">\n <p>Optional. Default is <code>'imperative'</code>.</p>\n \n </td>\n </tr>\n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>restoredState</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>Optional. Default is <code>null</code>.</p>\n \n </td>\n </tr>\n </tbody>\n</table>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n\n\n\n<section class=\"instance-properties\">\n <h2 id=\"properties\">Properties<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/NavigationStart#properties\"><i class=\"material-icons\">link</i></a></h2>\n <table class=\"is-full-width list-table property-table\">\n <thead>\n <tr>\n <th>Property</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"navigationTrigger\"></a>\n <code class=\"\"><span class=\"member-name\">navigationTrigger</span>?: 'imperative' | 'popstate' | 'hashchange'</code>\n </td>\n <td>\n \n <p>Identifies the call or event that triggered the navigation.\nAn <code>imperative</code> trigger is a call to <code>router.navigateByUrl()</code> or <code>router.navigate()</code>.</p>\n\n \n <p>See also:</p>\n <ul>\n \n <li><p><code><a href=\"api/router/NavigationEnd\" class=\"code-anchor\">NavigationEnd</a></code></p>\n</li>\n <li><p><code><a href=\"api/router/NavigationCancel\" class=\"code-anchor\">NavigationCancel</a></code></p>\n</li>\n <li><p><code><a href=\"api/router/NavigationError\" class=\"code-anchor\">NavigationError</a></code></p>\n</li>\n </ul>\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"restoredState\"></a>\n <code class=\"\"><span class=\"member-name\">restoredState</span>?: {\n [k: string]: any;\n navigationId: number;\n} | null</code>\n </td>\n <td>\n \n <p>The navigation state that was previously supplied to the <code>pushState</code> call,\nwhen the navigation is triggered by a <code>popstate</code> event. Otherwise null.</p>\n\n <p>The state object is defined by <code><a href=\"api/router/NavigationExtras\" class=\"code-anchor\">NavigationExtras</a></code>, and contains any\ndeveloper-defined state value, as well as a unique ID that\nthe router assigns to every router transition/navigation.</p>\n<p>From the perspective of the router, the router never \"goes back\".\nWhen the user clicks on the back button in the browser,\na new navigation ID is created.</p>\n<p>Use the ID in this previous-state object to differentiate between a newly created\nstate and one returned to by a <code>popstate</code> event, so that you can restore some\nremembered state, such as scroll position.</p>\n\n </td>\n </tr>\n \n </tbody>\n </table>\n</section>\n\n\n\n<section class=\"instance-methods\">\n <h2 id=\"methods\">Methods<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/NavigationStart#methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"toString\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"tostring\">\n toString()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/NavigationStart#tostring\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/router/src/events.ts?message=docs(router)%3A%20describe%20your%20change...#L101-L105\" 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/events.ts#L101-L105\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n \n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">toString</span>(): string</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-1\">Parameters</h6>\n <p>There are no parameters.</p>\n\n \n <h6 class=\"no-anchor\" id=\"returns\">Returns</h6>\n <p><code>string</code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n</section>\n\n\n\n \n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/router\n - api/router/Event\n - api/router/NavigationCancel\n - api/router/NavigationEnd\n - api/router/NavigationError\n - api/router/RouterEvent\n - api/router/RouterLink\n - guide/observables-in-angular\n - guide/router\n-->\n<!-- links from this doc:\n - /api\n - api/common/DecimalPipe\n - api/router\n - api/router/NavigationCancel\n - api/router/NavigationEnd\n - api/router/NavigationError\n - api/router/NavigationExtras\n - api/router/NavigationStart#constructor\n - api/router/NavigationStart#constructor()\n - api/router/NavigationStart#methods\n - api/router/NavigationStart#navigationTrigger\n - api/router/NavigationStart#navigationstart\n - api/router/NavigationStart#properties\n - api/router/NavigationStart#restoredState\n - api/router/NavigationStart#toString\n - api/router/NavigationStart#tostring\n - api/router/RouterEvent\n - api/router/RouterEvent#constructor()\n - api/router/RouterEvent#id\n - api/router/RouterEvent#url\n - https://github.com/angular/angular/edit/master/packages/router/src/events.ts?message=docs(router)%3A%20describe%20your%20change...#L101-L105\n - https://github.com/angular/angular/edit/master/packages/router/src/events.ts?message=docs(router)%3A%20describe%20your%20change...#L52-L106\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/events.ts#L101-L105\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/events.ts#L52-L106\n-->"
|
|
} |