5 lines
156 KiB
JSON
5 lines
156 KiB
JSON
{
|
|
"id": "api/router/BaseRouteReuseStrategy",
|
|
"title": "BaseRouteReuseStrategy",
|
|
"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/BaseRouteReuseStrategy\", \"name\": \"BaseRouteReuseStrategy\" } }\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/route_reuse_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L61-L111\" 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/route_reuse_strategy.ts#L61-L111\" 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=\"baseroutereusestrategy\">BaseRouteReuseStrategy<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/BaseRouteReuseStrategy#baseroutereusestrategy\"><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>This base route reuse strategy only reuses routes when the matched router configs are\nidentical. This prevents components from being destroyed and recreated\nwhen just the fragment or query parameters change\n(that is, the existing component is <em>reused</em>).</p>\n\n <p><a href=\"api/router/BaseRouteReuseStrategy#description\">See more...</a></p>\n </section>\n \n \n \n <section class=\"class-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\nabstract class <a href=\"api/router/BaseRouteReuseStrategy\" class=\"code-anchor\">BaseRouteReuseStrategy</a> implements <a class=\"code-anchor\" href=\"api/router/RouteReuseStrategy\">RouteReuseStrategy</a> {\n <a class=\"code-anchor\" href=\"api/router/BaseRouteReuseStrategy#shouldDetach\"><span class=\"member-name\">shouldDetach</span>(route: ActivatedRouteSnapshot): boolean</a>\n <a class=\"code-anchor\" href=\"api/router/BaseRouteReuseStrategy#store\"><span class=\"member-name\">store</span>(route: ActivatedRouteSnapshot, detachedTree: DetachedRouteHandle): void</a>\n <a class=\"code-anchor\" href=\"api/router/BaseRouteReuseStrategy#shouldAttach\"><span class=\"member-name\">shouldAttach</span>(route: ActivatedRouteSnapshot): boolean</a>\n <a class=\"code-anchor\" href=\"api/router/BaseRouteReuseStrategy#retrieve\"><span class=\"member-name\">retrieve</span>(route: ActivatedRouteSnapshot): DetachedRouteHandle | null</a>\n <a class=\"code-anchor\" href=\"api/router/BaseRouteReuseStrategy#shouldReuseRoute\"><span class=\"member-name\">shouldReuseRoute</span>(future: ActivatedRouteSnapshot, curr: ActivatedRouteSnapshot): boolean</a>\n}\n</code-example>\n\n \n \n\n</section>\n\n\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/BaseRouteReuseStrategy#description\"><i class=\"material-icons\">link</i></a></h2>\n <p>This strategy does not store any routes for later reuse.</p>\n<p>Angular uses this strategy by default.</p>\n<p>It can be used as a base class for custom route reuse strategies, i.e. you can create your own\nclass that extends the <code><a href=\"api/router/BaseRouteReuseStrategy\" class=\"code-anchor\">BaseRouteReuseStrategy</a></code> one.</p>\n\n \n</section>\n\n \n\n\n\n\n\n\n\n\n\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/BaseRouteReuseStrategy#methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"shouldDetach\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"shoulddetach\">\n shouldDetach()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/BaseRouteReuseStrategy#shoulddetach\"><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/route_reuse_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L80-L86\" 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/route_reuse_strategy.ts#L80-L86\" 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 <tr>\n <td class=\"short-description\">\n <p>Whether the given route should detach for later reuse.\nAlways returns false for <code><a href=\"api/router/BaseRouteReuseStrategy\" class=\"code-anchor\">BaseRouteReuseStrategy</a></code>.</p>\n\n </td>\n </tr>\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\">shouldDetach</span>(route: <a href=\"api/router/ActivatedRouteSnapshot\" class=\"code-anchor\">ActivatedRouteSnapshot</a>): boolean</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>route</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/router/ActivatedRouteSnapshot\" class=\"code-anchor\">ActivatedRouteSnapshot</a></code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns\">Returns</h6>\n <p><code>boolean</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 <a id=\"store\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"store\">\n store()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/BaseRouteReuseStrategy#store\"><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/route_reuse_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L87-L91\" 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/route_reuse_strategy.ts#L87-L91\" 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 <tr>\n <td class=\"short-description\">\n <p>A no-op; the route is never stored since this strategy never detaches routes for later re-use.</p>\n\n </td>\n </tr>\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\">store</span>(route: <a href=\"api/router/ActivatedRouteSnapshot\" class=\"code-anchor\">ActivatedRouteSnapshot</a>, detachedTree: <a href=\"api/router/DetachedRouteHandle\" class=\"code-anchor\">DetachedRouteHandle</a>): void</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-1\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>route</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/router/ActivatedRouteSnapshot\" class=\"code-anchor\">ActivatedRouteSnapshot</a></code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>detachedTree</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/router/DetachedRouteHandle\" class=\"code-anchor\">DetachedRouteHandle</a></code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-1\">Returns</h6>\n <p><code>void</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 <a id=\"shouldAttach\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"shouldattach\">\n shouldAttach()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/BaseRouteReuseStrategy#shouldattach\"><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/route_reuse_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L92-L96\" 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/route_reuse_strategy.ts#L92-L96\" 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 <tr>\n <td class=\"short-description\">\n <p>Returns <code>false</code>, meaning the route (and its subtree) is never reattached</p>\n\n </td>\n </tr>\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\">shouldAttach</span>(route: <a href=\"api/router/ActivatedRouteSnapshot\" class=\"code-anchor\">ActivatedRouteSnapshot</a>): boolean</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-2\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>route</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/router/ActivatedRouteSnapshot\" class=\"code-anchor\">ActivatedRouteSnapshot</a></code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-2\">Returns</h6>\n <p><code>boolean</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 <a id=\"retrieve\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"retrieve\">\n retrieve()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/BaseRouteReuseStrategy#retrieve\"><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/route_reuse_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L97-L101\" 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/route_reuse_strategy.ts#L97-L101\" 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 <tr>\n <td class=\"short-description\">\n <p>Returns <code>null</code> because this strategy does not store routes for later re-use.</p>\n\n </td>\n </tr>\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\">retrieve</span>(route: <a href=\"api/router/ActivatedRouteSnapshot\" class=\"code-anchor\">ActivatedRouteSnapshot</a>): <a href=\"api/router/DetachedRouteHandle\" class=\"code-anchor\">DetachedRouteHandle</a> | null</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-3\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>route</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/router/ActivatedRouteSnapshot\" class=\"code-anchor\">ActivatedRouteSnapshot</a></code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-3\">Returns</h6>\n <p><code><a href=\"api/router/DetachedRouteHandle\" class=\"code-anchor\">DetachedRouteHandle</a> | null</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 <a id=\"shouldReuseRoute\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"shouldreuseroute\">\n shouldReuseRoute()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/BaseRouteReuseStrategy#shouldreuseroute\"><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/route_reuse_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L102-L110\" 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/route_reuse_strategy.ts#L102-L110\" 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 <tr>\n <td class=\"short-description\">\n <p>Determines if a route should be reused.\nThis strategy returns <code>true</code> when the future route config and current route config are\nidentical.</p>\n\n </td>\n </tr>\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\">shouldReuseRoute</span>(future: <a href=\"api/router/ActivatedRouteSnapshot\" class=\"code-anchor\">ActivatedRouteSnapshot</a>, curr: <a href=\"api/router/ActivatedRouteSnapshot\" class=\"code-anchor\">ActivatedRouteSnapshot</a>): boolean</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-4\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>future</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/router/ActivatedRouteSnapshot\" class=\"code-anchor\">ActivatedRouteSnapshot</a></code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>curr</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/router/ActivatedRouteSnapshot\" class=\"code-anchor\">ActivatedRouteSnapshot</a></code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-4\">Returns</h6>\n <p><code>boolean</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/RouteReuseStrategy\n-->\n<!-- links from this doc:\n - /api\n - api/router\n - api/router/ActivatedRouteSnapshot\n - api/router/BaseRouteReuseStrategy#baseroutereusestrategy\n - api/router/BaseRouteReuseStrategy#description\n - api/router/BaseRouteReuseStrategy#methods\n - api/router/BaseRouteReuseStrategy#retrieve\n - api/router/BaseRouteReuseStrategy#shouldAttach\n - api/router/BaseRouteReuseStrategy#shouldDetach\n - api/router/BaseRouteReuseStrategy#shouldReuseRoute\n - api/router/BaseRouteReuseStrategy#shouldattach\n - api/router/BaseRouteReuseStrategy#shoulddetach\n - api/router/BaseRouteReuseStrategy#shouldreuseroute\n - api/router/BaseRouteReuseStrategy#store\n - api/router/DetachedRouteHandle\n - api/router/RouteReuseStrategy\n - https://github.com/angular/angular/edit/master/packages/router/src/route_reuse_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L102-L110\n - https://github.com/angular/angular/edit/master/packages/router/src/route_reuse_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L61-L111\n - https://github.com/angular/angular/edit/master/packages/router/src/route_reuse_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L80-L86\n - https://github.com/angular/angular/edit/master/packages/router/src/route_reuse_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L87-L91\n - https://github.com/angular/angular/edit/master/packages/router/src/route_reuse_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L92-L96\n - https://github.com/angular/angular/edit/master/packages/router/src/route_reuse_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L97-L101\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/route_reuse_strategy.ts#L102-L110\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/route_reuse_strategy.ts#L61-L111\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/route_reuse_strategy.ts#L80-L86\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/route_reuse_strategy.ts#L87-L91\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/route_reuse_strategy.ts#L92-L96\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/route_reuse_strategy.ts#L97-L101\n-->"
|
|
} |