5 lines
8.5 KiB
JSON
5 lines
8.5 KiB
JSON
{
|
|
"id": "api/router/IsActiveMatchOptions",
|
|
"title": "IsActiveMatchOptions",
|
|
"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/IsActiveMatchOptions\", \"name\": \"IsActiveMatchOptions\" } }\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/url_tree.ts?message=docs(router)%3A%20describe%20your%20change...#L15-L62\" 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/url_tree.ts#L15-L62\" 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=\"isactivematchoptions\">IsActiveMatchOptions<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/IsActiveMatchOptions#isactivematchoptions\"><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>A set of options which specify how to determine if a <code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code> is active, given the <code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code>\nfor the current router state.</p>\n\n \n </section>\n \n \n <section class=\"interface-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\ninterface <a href=\"api/router/IsActiveMatchOptions\" class=\"code-anchor\">IsActiveMatchOptions</a> {\n <a class=\"code-anchor\" href=\"api/router/IsActiveMatchOptions#matrixParams\"><span class=\"member-name\">matrixParams</span>: 'exact' | 'subset' | 'ignored'</a>\n <a class=\"code-anchor\" href=\"api/router/IsActiveMatchOptions#queryParams\"><span class=\"member-name\">queryParams</span>: 'exact' | 'subset' | 'ignored'</a>\n <a class=\"code-anchor\" href=\"api/router/IsActiveMatchOptions#paths\"><span class=\"member-name\">paths</span>: 'exact' | 'subset'</a>\n <a class=\"code-anchor\" href=\"api/router/IsActiveMatchOptions#fragment\"><span class=\"member-name\">fragment</span>: 'exact' | 'ignored'</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/IsActiveMatchOptions#see-also\"><i class=\"material-icons\">link</i></a></h2>\n <ul>\n \n <li><p>Router.isActive</p>\n</li>\n </ul>\n</section>\n\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/IsActiveMatchOptions#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=\"matrixParams\"></a>\n <code class=\"\"><span class=\"member-name\">matrixParams</span>: 'exact' | 'subset' | 'ignored'</code>\n </td>\n <td>\n \n <p>Defines the strategy for comparing the matrix parameters of two <code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code>s.</p>\n\n <p>The matrix parameter matching is dependent on the strategy for matching the\nsegments. That is, if the <code>paths</code> option is set to <code>'subset'</code>, only\nthe matrix parameters of the matching segments will be compared.</p>\n<ul>\n<li><code>'exact'</code>: Requires that matching segments also have exact matrix parameter\nmatches.</li>\n<li><code>'subset'</code>: The matching segments in the router's active <code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code> may contain\nextra matrix parameters, but those that exist in the <code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code> in question must match.</li>\n<li><code>'ignored'</code>: When comparing <code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code>s, matrix params will be ignored.</li>\n</ul>\n\n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"queryParams\"></a>\n <code class=\"\"><span class=\"member-name\">queryParams</span>: 'exact' | 'subset' | 'ignored'</code>\n </td>\n <td>\n \n <p>Defines the strategy for comparing the query parameters of two <code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code>s.</p>\n\n <ul>\n<li><code>'exact'</code>: the query parameters must match exactly.</li>\n<li><code>'subset'</code>: the active <code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code> may contain extra parameters,\nbut must match the key and value of any that exist in the <code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code> in question.</li>\n<li><code>'ignored'</code>: When comparing <code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code>s, query params will be ignored.</li>\n</ul>\n\n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"paths\"></a>\n <code class=\"\"><span class=\"member-name\">paths</span>: 'exact' | 'subset'</code>\n </td>\n <td>\n \n <p>Defines the strategy for comparing the <code><a href=\"api/router/UrlSegment\" class=\"code-anchor\">UrlSegment</a></code>s of the <code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code>s.</p>\n\n <ul>\n<li><code>'exact'</code>: all segments in each <code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code> must match.</li>\n<li><code>'subset'</code>: a <code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code> will be determined to be active if it\nis a subtree of the active route. That is, the active route may contain extra\nsegments, but must at least have all the segements of the <code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code> in question.</li>\n</ul>\n\n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"fragment\"></a>\n <code class=\"\"><span class=\"member-name\">fragment</span>: 'exact' | 'ignored'</code>\n </td>\n <td>\n \n <ul>\n<li>'exact'<code>: indicates that the</code>UrlTree` fragments must be equal.</li>\n<li><code>'ignored'</code>: the fragments will not be compared when determining if a\n<code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code> is active.</li>\n</ul>\n\n \n </td>\n </tr>\n \n </tbody>\n </table>\n</section>\n \n\n\n \n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/router\n - api/router/Router\n - api/router/RouterLinkActive\n-->\n<!-- links from this doc:\n - /api\n - api/router\n - api/router/IsActiveMatchOptions#fragment\n - api/router/IsActiveMatchOptions#isactivematchoptions\n - api/router/IsActiveMatchOptions#matrixParams\n - api/router/IsActiveMatchOptions#paths\n - api/router/IsActiveMatchOptions#properties\n - api/router/IsActiveMatchOptions#queryParams\n - api/router/IsActiveMatchOptions#see-also\n - api/router/UrlSegment\n - api/router/UrlTree\n - https://github.com/angular/angular/edit/master/packages/router/src/url_tree.ts?message=docs(router)%3A%20describe%20your%20change...#L15-L62\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/url_tree.ts#L15-L62\n-->"
|
|
} |