{
  "id": "api/router/NavigationExtras",
  "title": "NavigationExtras",
  "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/NavigationExtras\", \"name\": \"NavigationExtras\" } }\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.ts?message=docs(router)%3A%20describe%20your%20change...#L196-L213\" 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.ts#L196-L213\" 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=\"navigationextras\">NavigationExtras<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/NavigationExtras#navigationextras\"><i class=\"material-icons\">link</i></a></h1>\n    \n    <label class=\"api-type-label interface\">interface</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>Options that modify the <code><a href=\"api/router/Router\" class=\"code-anchor\">Router</a></code> navigation strategy.\nSupply an object containing any of these properties to a <code><a href=\"api/router/Router\" class=\"code-anchor\">Router</a></code> navigation function to\ncontrol how the target URL should be constructed or interpreted.</p>\n\n    \n  </section>\n  \n  \n  <section class=\"interface-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\ninterface <a href=\"api/router/NavigationExtras\" class=\"code-anchor\">NavigationExtras</a> extends <a class=\"code-anchor\" href=\"api/router/UrlCreationOptions\">UrlCreationOptions</a>, <a class=\"code-anchor\" href=\"api/router/NavigationBehaviorOptions\">NavigationBehaviorOptions</a> {\n\n  // inherited from <a class=\"code-anchor\" href=\"api/router/UrlCreationOptions\">router/UrlCreationOptions</a>\n  <a class=\"code-anchor\" href=\"api/router/UrlCreationOptions#relativeTo\"><span class=\"member-name\">relativeTo</span>?: ActivatedRoute | null</a>\n  <a class=\"code-anchor\" href=\"api/router/UrlCreationOptions#queryParams\"><span class=\"member-name\">queryParams</span>?: Params | null</a>\n  <a class=\"code-anchor\" href=\"api/router/UrlCreationOptions#fragment\"><span class=\"member-name\">fragment</span>?: string</a>\n  <a class=\"code-anchor\" href=\"api/router/UrlCreationOptions#queryParamsHandling\"><span class=\"member-name\">queryParamsHandling</span>?: QueryParamsHandling | null</a>\n  <a class=\"code-anchor\" href=\"api/router/UrlCreationOptions#preserveFragment\"><span class=\"member-name\">preserveFragment</span>?: boolean</a>\n\n  // inherited from <a class=\"code-anchor\" href=\"api/router/NavigationBehaviorOptions\">router/NavigationBehaviorOptions</a>\n  <a class=\"code-anchor\" href=\"api/router/NavigationBehaviorOptions#skipLocationChange\"><span class=\"member-name\">skipLocationChange</span>?: boolean</a>\n  <a class=\"code-anchor\" href=\"api/router/NavigationBehaviorOptions#replaceUrl\"><span class=\"member-name\">replaceUrl</span>?: boolean</a>\n  <a class=\"code-anchor\" href=\"api/router/NavigationBehaviorOptions#state\"><span class=\"member-name\">state</span>?: {...}</a>\n}\n</code-example>\n\n  \n  \n\n\n  \n  \n\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/NavigationExtras#see-also\"><i class=\"material-icons\">link</i></a></h2>\n  <ul>\n  \n    <li><p><a href=\"api/router/Router#navigate\">Router.navigate() method</a></p>\n</li>\n    <li><p><a href=\"api/router/Router#navigatebyurl\">Router.navigateByUrl() method</a></p>\n</li>\n    <li><p><a href=\"api/router/Router#createurltree\">Router.createUrlTree() method</a></p>\n</li>\n    <li><p><a href=\"guide/router\">Routing and Navigation guide</a></p>\n</li>\n    <li><p>UrlCreationOptions</p>\n</li>\n    <li><p>NavigationBehaviorOptions</p>\n</li>\n  </ul>\n</section>\n\n\n  \n  \n  \n\n  \n\n\n  \n\n\n  </div>\n</article>\n\n<!-- links to this doc:\n - api/router\n - api/router/Navigation\n - api/router/NavigationBehaviorOptions\n - api/router/NavigationStart\n - api/router/Router\n - api/router/UrlCreationOptions\n - guide/router\n - guide/router-tutorial-toh\n - guide/updating-to-version-11\n-->\n<!-- links from this doc:\n - /api\n - api/router\n - api/router/NavigationBehaviorOptions\n - api/router/NavigationBehaviorOptions#replaceUrl\n - api/router/NavigationBehaviorOptions#skipLocationChange\n - api/router/NavigationBehaviorOptions#state\n - api/router/NavigationExtras#navigationextras\n - api/router/NavigationExtras#see-also\n - api/router/Router\n - api/router/Router#createurltree\n - api/router/Router#navigate\n - api/router/Router#navigatebyurl\n - api/router/UrlCreationOptions\n - api/router/UrlCreationOptions#fragment\n - api/router/UrlCreationOptions#preserveFragment\n - api/router/UrlCreationOptions#queryParams\n - api/router/UrlCreationOptions#queryParamsHandling\n - api/router/UrlCreationOptions#relativeTo\n - guide/router\n - https://github.com/angular/angular/edit/master/packages/router/src/router.ts?message=docs(router)%3A%20describe%20your%20change...#L196-L213\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/router.ts#L196-L213\n-->"
}