5 lines
137 KiB
JSON
5 lines
137 KiB
JSON
{
|
|
"id": "api/router/ChildrenOutletContexts",
|
|
"title": "ChildrenOutletContexts",
|
|
"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/ChildrenOutletContexts\", \"name\": \"ChildrenOutletContexts\" } }\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_outlet_context.ts?message=docs(router)%3A%20describe%20your%20change...#L27-L84\" 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_outlet_context.ts#L27-L84\" 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=\"childrenoutletcontexts\">ChildrenOutletContexts<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/ChildrenOutletContexts#childrenoutletcontexts\"><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>Store contextual information about the children (= nested) <code><a href=\"api/router/RouterOutlet\" class=\"code-anchor\">RouterOutlet</a></code></p>\n\n \n </section>\n \n \n \n <section class=\"class-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\nclass <a href=\"api/router/ChildrenOutletContexts\" class=\"code-anchor\">ChildrenOutletContexts</a> {\n <a class=\"code-anchor\" href=\"api/router/ChildrenOutletContexts#onChildOutletCreated\"><span class=\"member-name\">onChildOutletCreated</span>(childName: string, outlet: RouterOutletContract): void</a>\n <a class=\"code-anchor\" href=\"api/router/ChildrenOutletContexts#onChildOutletDestroyed\"><span class=\"member-name\">onChildOutletDestroyed</span>(childName: string): void</a>\n <a class=\"code-anchor\" href=\"api/router/ChildrenOutletContexts#onOutletDeactivated\"><span class=\"member-name\">onOutletDeactivated</span>(): Map<string, OutletContext></a>\n <a class=\"code-anchor\" href=\"api/router/ChildrenOutletContexts#onOutletReAttached\"><span class=\"member-name\">onOutletReAttached</span>(contexts: Map<string, OutletContext>)</a>\n <a class=\"code-anchor\" href=\"api/router/ChildrenOutletContexts#getOrCreateContext\"><span class=\"member-name\">getOrCreateContext</span>(childName: string): OutletContext</a>\n <a class=\"code-anchor\" href=\"api/router/ChildrenOutletContexts#getContext\"><span class=\"member-name\">getContext</span>(childName: string): OutletContext | null</a>\n}\n</code-example>\n\n \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/ChildrenOutletContexts#methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"onChildOutletCreated\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"onchildoutletcreated\">\n onChildOutletCreated()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/ChildrenOutletContexts#onchildoutletcreated\"><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/router_outlet_context.ts?message=docs(router)%3A%20describe%20your%20change...#L36-L42\" 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_outlet_context.ts#L36-L42\" 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 a <code><a href=\"api/router/RouterOutlet\" class=\"code-anchor\">RouterOutlet</a></code> directive is instantiated</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\">onChildOutletCreated</span>(childName: string, outlet: <a href=\"api/router/RouterOutletContract\" class=\"code-anchor\">RouterOutletContract</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>childName</code>\n </td>\n <td class=\"param-type\"><code>string</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>outlet</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/router/RouterOutletContract\" class=\"code-anchor\">RouterOutletContract</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=\"onChildOutletDestroyed\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"onchildoutletdestroyed\">\n onChildOutletDestroyed()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/ChildrenOutletContexts#onchildoutletdestroyed\"><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/router_outlet_context.ts?message=docs(router)%3A%20describe%20your%20change...#L43-L54\" 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_outlet_context.ts#L43-L54\" 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 a <code><a href=\"api/router/RouterOutlet\" class=\"code-anchor\">RouterOutlet</a></code> directive is destroyed.\nWe need to keep the context as the outlet could be destroyed inside a NgIf and might be\nre-created 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\"><span class=\"member-name\">onChildOutletDestroyed</span>(childName: string): 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>childName</code>\n </td>\n <td class=\"param-type\"><code>string</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=\"onOutletDeactivated\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"onoutletdeactivated\">\n onOutletDeactivated()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/ChildrenOutletContexts#onoutletdeactivated\"><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/router_outlet_context.ts?message=docs(router)%3A%20describe%20your%20change...#L55-L64\" 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_outlet_context.ts#L55-L64\" 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 corresponding route is deactivated during navigation.\nBecause the component get destroyed, all children outlet are destroyed.</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\">onOutletDeactivated</span>(): Map<string, <a href=\"api/router/OutletContext\" class=\"code-anchor\">OutletContext</a>></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>Map<string, <a href=\"api/router/OutletContext\" class=\"code-anchor\">OutletContext</a>></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=\"onOutletReAttached\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"onoutletreattached\">\n onOutletReAttached()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/ChildrenOutletContexts#onoutletreattached\"><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/router_outlet_context.ts?message=docs(router)%3A%20describe%20your%20change...#L65-L68\" 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_outlet_context.ts#L65-L68\" 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 \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\">onOutletReAttached</span>(contexts: Map<string, <a href=\"api/router/OutletContext\" class=\"code-anchor\">OutletContext</a>>)</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>contexts</code>\n </td>\n <td class=\"param-type\"><code>Map<string, outletcontext=\"\"></string,></code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n </tbody>\n</table>\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=\"getOrCreateContext\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"getorcreatecontext\">\n getOrCreateContext()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/ChildrenOutletContexts#getorcreatecontext\"><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/router_outlet_context.ts?message=docs(router)%3A%20describe%20your%20change...#L69-L79\" 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_outlet_context.ts#L69-L79\" 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 \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\">getOrCreateContext</span>(childName: string): <a href=\"api/router/OutletContext\" class=\"code-anchor\">OutletContext</a></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>childName</code>\n </td>\n <td class=\"param-type\"><code>string</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/OutletContext\" class=\"code-anchor\">OutletContext</a></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=\"getContext\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"getcontext\">\n getContext()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/ChildrenOutletContexts#getcontext\"><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/router_outlet_context.ts?message=docs(router)%3A%20describe%20your%20change...#L80-L83\" 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_outlet_context.ts#L80-L83\" 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 \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\"><a href=\"api/core/global/ngGetContext\" class=\"code-anchor\">getContext</a></span>(childName: string): <a href=\"api/router/OutletContext\" class=\"code-anchor\">OutletContext</a> | null</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-5\">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>childName</code>\n </td>\n <td class=\"param-type\"><code>string</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><a href=\"api/router/OutletContext\" class=\"code-anchor\">OutletContext</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</section>\n\n\n\n \n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/router\n - api/router/OutletContext\n - api/router/Router\n - api/router/RouterOutletContract\n - api/router/testing/RouterTestingModule\n - api/router/testing/setupTestingRouter\n-->\n<!-- links from this doc:\n - /api\n - api/core/global/ngGetContext\n - api/router\n - api/router/ChildrenOutletContexts#childrenoutletcontexts\n - api/router/ChildrenOutletContexts#getContext\n - api/router/ChildrenOutletContexts#getOrCreateContext\n - api/router/ChildrenOutletContexts#getcontext\n - api/router/ChildrenOutletContexts#getorcreatecontext\n - api/router/ChildrenOutletContexts#methods\n - api/router/ChildrenOutletContexts#onChildOutletCreated\n - api/router/ChildrenOutletContexts#onChildOutletDestroyed\n - api/router/ChildrenOutletContexts#onOutletDeactivated\n - api/router/ChildrenOutletContexts#onOutletReAttached\n - api/router/ChildrenOutletContexts#onchildoutletcreated\n - api/router/ChildrenOutletContexts#onchildoutletdestroyed\n - api/router/ChildrenOutletContexts#onoutletdeactivated\n - api/router/ChildrenOutletContexts#onoutletreattached\n - api/router/OutletContext\n - api/router/RouterOutlet\n - api/router/RouterOutletContract\n - https://github.com/angular/angular/edit/master/packages/router/src/router_outlet_context.ts?message=docs(router)%3A%20describe%20your%20change...#L27-L84\n - https://github.com/angular/angular/edit/master/packages/router/src/router_outlet_context.ts?message=docs(router)%3A%20describe%20your%20change...#L36-L42\n - https://github.com/angular/angular/edit/master/packages/router/src/router_outlet_context.ts?message=docs(router)%3A%20describe%20your%20change...#L43-L54\n - https://github.com/angular/angular/edit/master/packages/router/src/router_outlet_context.ts?message=docs(router)%3A%20describe%20your%20change...#L55-L64\n - https://github.com/angular/angular/edit/master/packages/router/src/router_outlet_context.ts?message=docs(router)%3A%20describe%20your%20change...#L65-L68\n - https://github.com/angular/angular/edit/master/packages/router/src/router_outlet_context.ts?message=docs(router)%3A%20describe%20your%20change...#L69-L79\n - https://github.com/angular/angular/edit/master/packages/router/src/router_outlet_context.ts?message=docs(router)%3A%20describe%20your%20change...#L80-L83\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/router_outlet_context.ts#L27-L84\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/router_outlet_context.ts#L36-L42\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/router_outlet_context.ts#L43-L54\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/router_outlet_context.ts#L55-L64\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/router_outlet_context.ts#L65-L68\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/router_outlet_context.ts#L69-L79\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/router_outlet_context.ts#L80-L83\n-->"
|
|
} |