5 lines
99 KiB
JSON
5 lines
99 KiB
JSON
{
|
|
"id": "api/router/RouterOutletContract",
|
|
"title": "RouterOutletContract",
|
|
"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/RouterOutletContract\", \"name\": \"RouterOutletContract\" } }\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/directives/router_outlet.ts?message=docs(router)%3A%20describe%20your%20change...#L15-L75\" 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/directives/router_outlet.ts#L15-L75\" 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=\"routeroutletcontract\">RouterOutletContract<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/RouterOutletContract#routeroutletcontract\"><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>An interface that defines the contract for developing a component outlet for the <code><a href=\"api/router/Router\" class=\"code-anchor\">Router</a></code>.</p>\n\n <p><a href=\"api/router/RouterOutletContract#description\">See more...</a></p>\n </section>\n \n \n <section class=\"interface-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\ninterface <a href=\"api/router/RouterOutletContract\" class=\"code-anchor\">RouterOutletContract</a> {\n <a class=\"code-anchor\" href=\"api/router/RouterOutletContract#isActivated\"><span class=\"member-name\">isActivated</span>: boolean</a>\n <a class=\"code-anchor\" href=\"api/router/RouterOutletContract#component\"><span class=\"member-name\">component</span>: Object | null</a>\n <a class=\"code-anchor\" href=\"api/router/RouterOutletContract#activatedRouteData\"><span class=\"member-name\">activatedRouteData</span>: Data</a>\n <a class=\"code-anchor\" href=\"api/router/RouterOutletContract#activatedRoute\"><span class=\"member-name\">activatedRoute</span>: ActivatedRoute | null</a>\n <a class=\"code-anchor\" href=\"api/router/RouterOutletContract#activateWith\"><span class=\"member-name\">activateWith</span>(activatedRoute: ActivatedRoute, resolver: ComponentFactoryResolver): void</a>\n <a class=\"code-anchor\" href=\"api/router/RouterOutletContract#deactivate\"><span class=\"member-name\">deactivate</span>(): void</a>\n <a class=\"code-anchor\" href=\"api/router/RouterOutletContract#detach\"><span class=\"member-name\">detach</span>(): ComponentRef<unknown></a>\n <a class=\"code-anchor\" href=\"api/router/RouterOutletContract#attach\"><span class=\"member-name\">attach</span>(ref: ComponentRef<unknown>, activatedRoute: ActivatedRoute): void</a>\n}\n</code-example>\n\n \n \n\n\n \n \n <div class=\"descendants class\">\n <h2 id=\"class-implementations\">Class implementations<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/RouterOutletContract#class-implementations\"><i class=\"material-icons\">link</i></a></h2>\n \n\n<ul>\n \n <li>\n <code><a href=\"api/router/RouterOutlet\" class=\"code-anchor\">RouterOutlet</a></code>\n \n\n\n </li>\n \n</ul>\n\n\n </div>\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/RouterOutletContract#see-also\"><i class=\"material-icons\">link</i></a></h2>\n <ul>\n \n <li><p><code><a href=\"api/router/ChildrenOutletContexts\" class=\"code-anchor\">ChildrenOutletContexts</a></code></p>\n</li>\n </ul>\n</section>\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/RouterOutletContract#description\"><i class=\"material-icons\">link</i></a></h2>\n <p>An outlet acts as a placeholder that Angular dynamically fills based on the current router state.</p>\n<p>A router outlet should register itself with the <code><a href=\"api/router/Router\" class=\"code-anchor\">Router</a></code> via\n<code><a href=\"api/router/ChildrenOutletContexts\" class=\"code-anchor\">ChildrenOutletContexts</a>#onChildOutletCreated</code> and unregister with\n<code><a href=\"api/router/ChildrenOutletContexts\" class=\"code-anchor\">ChildrenOutletContexts</a>#onChildOutletDestroyed</code>. When the <code><a href=\"api/router/Router\" class=\"code-anchor\">Router</a></code> identifies a matched <code><a href=\"api/router/Route\" class=\"code-anchor\">Route</a></code>,\nit looks for a registered outlet in the <code><a href=\"api/router/ChildrenOutletContexts\" class=\"code-anchor\">ChildrenOutletContexts</a></code> and activates it.</p>\n\n \n</section>\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/RouterOutletContract#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=\"isActivated\"></a>\n <code class=\"\"><span class=\"member-name\">isActivated</span>: boolean</code>\n </td>\n <td>\n \n <p>Whether the given outlet is activated.</p>\n\n <p>An outlet is considered \"activated\" if it has an active component.</p>\n\n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"component\"></a>\n <code class=\"\"><span class=\"member-name\">component</span>: Object | null</code>\n </td>\n <td>\n \n <p>The instance of the activated component or <code>null</code> if the outlet is not activated.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"activatedRouteData\"></a>\n <code class=\"\"><span class=\"member-name\">activatedRouteData</span>: <a href=\"api/router/Data\" class=\"code-anchor\">Data</a></code>\n </td>\n <td>\n \n <p>The <code><a href=\"api/router/Data\" class=\"code-anchor\">Data</a></code> of the <code><a href=\"api/router/ActivatedRoute\" class=\"code-anchor\">ActivatedRoute</a></code> snapshot.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"activatedRoute\"></a>\n <code class=\"\"><span class=\"member-name\">activatedRoute</span>: <a href=\"api/router/ActivatedRoute\" class=\"code-anchor\">ActivatedRoute</a> | null</code>\n </td>\n <td>\n \n <p>The <code><a href=\"api/router/ActivatedRoute\" class=\"code-anchor\">ActivatedRoute</a></code> for the outlet or <code>null</code> if the outlet is not activated.</p>\n\n \n </td>\n </tr>\n \n </tbody>\n </table>\n</section>\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/RouterOutletContract#methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"activateWith\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"activatewith\">\n activateWith()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/RouterOutletContract#activatewith\"><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/directives/router_outlet.ts?message=docs(router)%3A%20describe%20your%20change...#L49-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/directives/router_outlet.ts#L49-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>Called by the <code><a href=\"api/router/Router\" class=\"code-anchor\">Router</a></code> when the outlet should activate (create a component).</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\">activateWith</span>(activatedRoute: <a href=\"api/router/ActivatedRoute\" class=\"code-anchor\">ActivatedRoute</a>, resolver: <a href=\"api/core/ComponentFactoryResolver\" class=\"code-anchor\">ComponentFactoryResolver</a>): void</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>activatedRoute</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/router/ActivatedRoute\" class=\"code-anchor\">ActivatedRoute</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>resolver</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/core/ComponentFactoryResolver\" class=\"code-anchor\">ComponentFactoryResolver</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>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=\"deactivate\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"deactivate\">\n deactivate()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/RouterOutletContract#deactivate\"><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/directives/router_outlet.ts?message=docs(router)%3A%20describe%20your%20change...#L54-L61\" 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/directives/router_outlet.ts#L54-L61\" 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 request to destroy the currently activated component.</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\">deactivate</span>(): void</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-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>When a <code><a href=\"api/router/RouteReuseStrategy\" class=\"code-anchor\">RouteReuseStrategy</a></code> indicates that an <code><a href=\"api/router/ActivatedRoute\" class=\"code-anchor\">ActivatedRoute</a></code> should be removed but stored for\nlater re-use rather than destroyed, the <code><a href=\"api/router/Router\" class=\"code-anchor\">Router</a></code> will call <code>detach</code> instead.</p>\n\n </td>\n </tr>\n\n \n </tbody>\n</table>\n\n \n <a id=\"detach\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"detach\">\n detach()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/RouterOutletContract#detach\"><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/directives/router_outlet.ts?message=docs(router)%3A%20describe%20your%20change...#L62-L69\" 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/directives/router_outlet.ts#L62-L69\" 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>Called when the <code><a href=\"api/router/RouteReuseStrategy\" class=\"code-anchor\">RouteReuseStrategy</a></code> instructs to detach the subtree.</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\">detach</span>(): <a href=\"api/core/ComponentRef\" class=\"code-anchor\">ComponentRef</a><unknown></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-2\">Parameters</h6>\n <p>There are no parameters.</p>\n\n \n <h6 class=\"no-anchor\" id=\"returns-2\">Returns</h6>\n <p><code><a href=\"api/core/ComponentRef\" class=\"code-anchor\">ComponentRef</a><unknown></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>This is similar to <code>deactivate</code>, but the activated component should <em>not</em> be destroyed.\nInstead, it is returned so that it can be reattached later via the <code>attach</code> method.</p>\n\n </td>\n </tr>\n\n \n </tbody>\n</table>\n\n \n <a id=\"attach\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"attach\">\n attach()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/RouterOutletContract#attach\"><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/directives/router_outlet.ts?message=docs(router)%3A%20describe%20your%20change...#L70-L74\" 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/directives/router_outlet.ts#L70-L74\" 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>Called when the <code><a href=\"api/router/RouteReuseStrategy\" class=\"code-anchor\">RouteReuseStrategy</a></code> instructs to re-attach a previously detached subtree.</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\">attach</span>(ref: <a href=\"api/core/ComponentRef\" class=\"code-anchor\">ComponentRef</a><unknown>, activatedRoute: <a href=\"api/router/ActivatedRoute\" class=\"code-anchor\">ActivatedRoute</a>): void</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>ref</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/core/ComponentRef\" class=\"code-anchor\">ComponentRef</a><unknown></unknown></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>activatedRoute</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/router/ActivatedRoute\" class=\"code-anchor\">ActivatedRoute</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>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</section>\n\n\n \n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/router\n - api/router/ChildrenOutletContexts\n - api/router/OutletContext\n-->\n<!-- links from this doc:\n - /api\n - api/core/ComponentFactoryResolver\n - api/core/ComponentRef\n - api/router\n - api/router/ActivatedRoute\n - api/router/ChildrenOutletContexts\n - api/router/Data\n - api/router/Route\n - api/router/RouteReuseStrategy\n - api/router/Router\n - api/router/RouterOutlet\n - api/router/RouterOutletContract#activateWith\n - api/router/RouterOutletContract#activatedRoute\n - api/router/RouterOutletContract#activatedRouteData\n - api/router/RouterOutletContract#activatewith\n - api/router/RouterOutletContract#attach\n - api/router/RouterOutletContract#class-implementations\n - api/router/RouterOutletContract#component\n - api/router/RouterOutletContract#deactivate\n - api/router/RouterOutletContract#description\n - api/router/RouterOutletContract#detach\n - api/router/RouterOutletContract#isActivated\n - api/router/RouterOutletContract#methods\n - api/router/RouterOutletContract#properties\n - api/router/RouterOutletContract#routeroutletcontract\n - api/router/RouterOutletContract#see-also\n - https://github.com/angular/angular/edit/master/packages/router/src/directives/router_outlet.ts?message=docs(router)%3A%20describe%20your%20change...#L15-L75\n - https://github.com/angular/angular/edit/master/packages/router/src/directives/router_outlet.ts?message=docs(router)%3A%20describe%20your%20change...#L49-L53\n - https://github.com/angular/angular/edit/master/packages/router/src/directives/router_outlet.ts?message=docs(router)%3A%20describe%20your%20change...#L54-L61\n - https://github.com/angular/angular/edit/master/packages/router/src/directives/router_outlet.ts?message=docs(router)%3A%20describe%20your%20change...#L62-L69\n - https://github.com/angular/angular/edit/master/packages/router/src/directives/router_outlet.ts?message=docs(router)%3A%20describe%20your%20change...#L70-L74\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/directives/router_outlet.ts#L15-L75\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/directives/router_outlet.ts#L49-L53\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/directives/router_outlet.ts#L54-L61\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/directives/router_outlet.ts#L62-L69\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/directives/router_outlet.ts#L70-L74\n-->"
|
|
} |