5 lines
155 KiB
JSON
5 lines
155 KiB
JSON
{
|
|
"id": "api/router/RouteReuseStrategy",
|
|
"title": "RouteReuseStrategy",
|
|
"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/RouteReuseStrategy\", \"name\": \"RouteReuseStrategy\" } }\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...#L33-L60\" 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#L33-L60\" 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=\"routereusestrategy\">RouteReuseStrategy<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/RouteReuseStrategy#routereusestrategy\"><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>Provides a way to customize when activated routes get reused.</p>\n\n \n </section>\n \n \n \n <section class=\"class-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\nabstract class <a href=\"api/router/RouteReuseStrategy\" class=\"code-anchor\">RouteReuseStrategy</a> {\n <a class=\"code-anchor\" href=\"api/router/RouteReuseStrategy#shouldDetach\">abstract <span class=\"member-name\">shouldDetach</span>(route: ActivatedRouteSnapshot): boolean</a>\n <a class=\"code-anchor\" href=\"api/router/RouteReuseStrategy#store\">abstract <span class=\"member-name\">store</span>(route: ActivatedRouteSnapshot, handle: DetachedRouteHandle): void</a>\n <a class=\"code-anchor\" href=\"api/router/RouteReuseStrategy#shouldAttach\">abstract <span class=\"member-name\">shouldAttach</span>(route: ActivatedRouteSnapshot): boolean</a>\n <a class=\"code-anchor\" href=\"api/router/RouteReuseStrategy#retrieve\">abstract <span class=\"member-name\">retrieve</span>(route: ActivatedRouteSnapshot): DetachedRouteHandle | null</a>\n <a class=\"code-anchor\" href=\"api/router/RouteReuseStrategy#shouldReuseRoute\">abstract <span class=\"member-name\">shouldReuseRoute</span>(future: ActivatedRouteSnapshot, curr: ActivatedRouteSnapshot): boolean</a>\n}\n</code-example>\n\n \n \n <div class=\"descendants class\">\n <h2 id=\"subclasses\">Subclasses<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/RouteReuseStrategy#subclasses\"><i class=\"material-icons\">link</i></a></h2>\n \n\n<ul>\n \n <li>\n <code><a href=\"api/router/BaseRouteReuseStrategy\" class=\"code-anchor\">BaseRouteReuseStrategy</a></code>\n \n\n\n </li>\n \n</ul>\n\n\n </div>\n \n\n</section>\n\n\n \n\n \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/RouteReuseStrategy#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/RouteReuseStrategy#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...#L42-L43\" 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#L42-L43\" 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 this route (and its subtree) should be detached to be reused later</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\">abstract <span class=\"member-name\">shouldDetach</span>(route: ActivatedRouteSnapshot): 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/RouteReuseStrategy#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...#L44-L50\" 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#L44-L50\" 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>Stores the detached route.</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\">abstract <span class=\"member-name\">store</span>(route: ActivatedRouteSnapshot, handle: DetachedRouteHandle): 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>handle</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 <tr>\n <td class=\"description\">\n <p>Storing a <code>null</code> value should erase the previously stored value.</p>\n\n </td>\n </tr>\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/RouteReuseStrategy#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...#L51-L53\" 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#L51-L53\" 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 this route (and its subtree) should be 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\">abstract <span class=\"member-name\">shouldAttach</span>(route: ActivatedRouteSnapshot): 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/RouteReuseStrategy#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...#L54-L56\" 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#L54-L56\" 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>Retrieves the previously stored route</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\">abstract <span class=\"member-name\">retrieve</span>(route: ActivatedRouteSnapshot): DetachedRouteHandle | 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/RouteReuseStrategy#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...#L57-L59\" 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#L57-L59\" 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</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\">abstract <span class=\"member-name\">shouldReuseRoute</span>(future: ActivatedRouteSnapshot, curr: ActivatedRouteSnapshot): 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/BaseRouteReuseStrategy\n - api/router/Router\n - api/router/RouterOutlet\n - api/router/RouterOutletContract\n - guide/updating-to-version-11\n-->\n<!-- links from this doc:\n - /api\n - api/router\n - api/router/ActivatedRouteSnapshot\n - api/router/BaseRouteReuseStrategy\n - api/router/DetachedRouteHandle\n - api/router/RouteReuseStrategy#methods\n - api/router/RouteReuseStrategy#retrieve\n - api/router/RouteReuseStrategy#routereusestrategy\n - api/router/RouteReuseStrategy#shouldAttach\n - api/router/RouteReuseStrategy#shouldDetach\n - api/router/RouteReuseStrategy#shouldReuseRoute\n - api/router/RouteReuseStrategy#shouldattach\n - api/router/RouteReuseStrategy#shoulddetach\n - api/router/RouteReuseStrategy#shouldreuseroute\n - api/router/RouteReuseStrategy#store\n - api/router/RouteReuseStrategy#subclasses\n - https://github.com/angular/angular/edit/master/packages/router/src/route_reuse_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L33-L60\n - https://github.com/angular/angular/edit/master/packages/router/src/route_reuse_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L42-L43\n - https://github.com/angular/angular/edit/master/packages/router/src/route_reuse_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L44-L50\n - https://github.com/angular/angular/edit/master/packages/router/src/route_reuse_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L51-L53\n - https://github.com/angular/angular/edit/master/packages/router/src/route_reuse_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L54-L56\n - https://github.com/angular/angular/edit/master/packages/router/src/route_reuse_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L57-L59\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/route_reuse_strategy.ts#L33-L60\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/route_reuse_strategy.ts#L42-L43\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/route_reuse_strategy.ts#L44-L50\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/route_reuse_strategy.ts#L51-L53\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/route_reuse_strategy.ts#L54-L56\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/route_reuse_strategy.ts#L57-L59\n-->"
|
|
} |