UNPKG

carbon-components-angular

Version:
1,171 lines (972 loc) 44.3 kB
<!doctype html> <html class="no-js" lang=""> <head> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <title>carbon-components-angular documentation</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="icon" type="image/x-icon" href="../images/favicon.ico"> <link rel="stylesheet" href="../styles/style.css"> <link rel="stylesheet" href="../styles/dark.css"> <style> footer.carbon { position: absolute; bottom: 0; width: 100%; z-index: 9999; } #root > div { /* * Subtracting the height of the footer to prevent * overlaying the footer ontop of content */ height: calc(100vh - 48px); } </style> </head> <body> <script> // Blocking script to avoid flickering dark mode // Dark mode toggle button var useDark = window.matchMedia('(prefers-color-scheme: dark)'); var darkModeState = useDark.matches; var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input'); var $darkModeToggles = document.querySelectorAll('.dark-mode-switch'); var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state'); function checkToggle(check) { for (var i = 0; i < $darkModeToggleSwitchers.length; i++) { $darkModeToggleSwitchers[i].checked = check; } } function toggleDarkMode(state) { if (window.localStorage) { localStorage.setItem('compodoc_darkmode-state', state); } checkToggle(state); const hasClass = document.body.classList.contains('dark'); if (state) { for (var i = 0; i < $darkModeToggles.length; i++) { $darkModeToggles[i].classList.add('dark'); } if (!hasClass) { document.body.classList.add('dark'); } } else { for (var i = 0; i < $darkModeToggles.length; i++) { $darkModeToggles[i].classList.remove('dark'); } if (hasClass) { document.body.classList.remove('dark'); } } } useDark.addEventListener('change', function (evt) { toggleDarkMode(evt.matches); }); if (darkModeStateLocal) { darkModeState = darkModeStateLocal === 'true'; } toggleDarkMode(darkModeState); </script> <div class="navbar navbar-default navbar-fixed-top d-md-none p-0"> <div class="d-flex"> <a href="../" class="navbar-brand">carbon-components-angular documentation</a> <button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button> </div> </div> <div class="xs-menu menu" id="mobile-menu"> <div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu> </div> <div class="container-fluid main"> <div class="row main"> <div class="d-none d-md-block menu"> <compodoc-menu mode="normal"></compodoc-menu> </div> <!-- START CONTENT --> <div class="content injectable"> <div class="content-data"> <ol class="breadcrumb"> <li class="breadcrumb-item">Injectables</li> <li class="breadcrumb-item" >PlaceholderService</li> </ol> <ul class="nav nav-tabs" role="tablist"> <li class="nav-item"> <a href="#info" class="nav-link" class="nav-link active" role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a> </li> <li class="nav-item"> <a href="#source" class="nav-link" role="tab" id="source-tab" data-bs-toggle="tab" data-link="source">Source</a> </li> </ul> <div class="tab-content"> <div class="tab-pane fade active in" id="info"> <p class="comment"> <h3>File</h3> </p> <p class="comment"> <code>src/placeholder/placeholder.service.ts</code> </p> <p class="comment"> <h3>Description</h3> </p> <p class="comment"> <p>Singleton service used to register the container for out-of-flow components to insert into. Also used to insert/remove components from that view.</p> </p> <section data-compodoc="block-index"> <h3 id="index">Index</h3> <table class="table table-sm table-bordered index-table"> <tbody> <tr> <td class="col-md-4"> <h6><b>Properties</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <span class="modifier">Protected</span> <a href="#viewContainerMap" >viewContainerMap</a> </li> <li> <span class="modifier">Protected</span> <a href="#viewContainerRef" >viewContainerRef</a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>Methods</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#appendElement" >appendElement</a> </li> <li> <a href="#createComponent" >createComponent</a> </li> <li> <a href="#destroyComponent" >destroyComponent</a> </li> <li> <a href="#hasComponentRef" >hasComponentRef</a> </li> <li> <a href="#hasElement" >hasElement</a> </li> <li> <a href="#hasPlaceholderRef" >hasPlaceholderRef</a> </li> <li> <a href="#registerViewContainerRef" >registerViewContainerRef</a> </li> <li> <a href="#removeElement" >removeElement</a> </li> </ul> </td> </tr> </tbody> </table> </section> <section data-compodoc="block-methods"> <h3 id="methods"> Methods </h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="appendElement"></a> <span class="name"> <span ><b>appendElement</b></span> <a href="#appendElement"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>appendElement(element: HTMLElement, id?: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="83" class="link-to-prism">src/placeholder/placeholder.service.ts:83</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>element</td> <td> <code>HTMLElement</code> </td> <td> No </td> </tr> <tr> <td>id</td> <td> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code> </td> <td> Yes </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code>HTMLElement</code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="createComponent"></a> <span class="name"> <span ><b>createComponent</b></span> <a href="#createComponent"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>createComponent(component: ComponentRef<any>, injector: Injector, id?: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>, environment: EnvironmentInjector)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="38" class="link-to-prism">src/placeholder/placeholder.service.ts:38</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Creates and returns component in the view.</p> </div> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> <td>Default value</td> </tr> </thead> <tbody> <tr> <td>component</td> <td> <code>ComponentRef&lt;any&gt;</code> </td> <td> No </td> <td> </td> </tr> <tr> <td>injector</td> <td> <code>Injector</code> </td> <td> No </td> <td> </td> </tr> <tr> <td>id</td> <td> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code> </td> <td> Yes </td> <td> </td> </tr> <tr> <td>environment</td> <td> <code>EnvironmentInjector</code> </td> <td> No </td> <td> <code>undefined</code> </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code>ComponentRef&lt;any&gt;</code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="destroyComponent"></a> <span class="name"> <span ><b>destroyComponent</b></span> <a href="#destroyComponent"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>destroyComponent(component: ComponentRef<any>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="64" class="link-to-prism">src/placeholder/placeholder.service.ts:64</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>component</td> <td> <code>ComponentRef&lt;any&gt;</code> </td> <td> No </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="hasComponentRef"></a> <span class="name"> <span ><b>hasComponentRef</b></span> <a href="#hasComponentRef"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>hasComponentRef(component: ComponentRef<any>, id?: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="68" class="link-to-prism">src/placeholder/placeholder.service.ts:68</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>component</td> <td> <code>ComponentRef&lt;any&gt;</code> </td> <td> No </td> </tr> <tr> <td>id</td> <td> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code> </td> <td> Yes </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="hasElement"></a> <span class="name"> <span ><b>hasElement</b></span> <a href="#hasElement"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>hasElement(element: HTMLElement, id?: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="97" class="link-to-prism">src/placeholder/placeholder.service.ts:97</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>element</td> <td> <code>HTMLElement</code> </td> <td> No </td> </tr> <tr> <td>id</td> <td> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code> </td> <td> Yes </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="hasPlaceholderRef"></a> <span class="name"> <span ><b>hasPlaceholderRef</b></span> <a href="#hasPlaceholderRef"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>hasPlaceholderRef(id?: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="76" class="link-to-prism">src/placeholder/placeholder.service.ts:76</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>id</td> <td> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code> </td> <td> Yes </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="registerViewContainerRef"></a> <span class="name"> <span ><b>registerViewContainerRef</b></span> <a href="#registerViewContainerRef"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>registerViewContainerRef(vcRef: ViewContainerRef, id?: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="27" class="link-to-prism">src/placeholder/placeholder.service.ts:27</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Used by <code>Placeholder</code> to register view-container reference.</p> </div> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>vcRef</td> <td> <code>ViewContainerRef</code> </td> <td> No </td> </tr> <tr> <td>id</td> <td> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code> </td> <td> Yes </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="removeElement"></a> <span class="name"> <span ><b>removeElement</b></span> <a href="#removeElement"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>removeElement(element: HTMLElement, id?: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="90" class="link-to-prism">src/placeholder/placeholder.service.ts:90</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>element</td> <td> <code>HTMLElement</code> </td> <td> No </td> </tr> <tr> <td>id</td> <td> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code> </td> <td> Yes </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code>HTMLElement</code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> </section> <section data-compodoc="block-properties"> <h3 id="inputs"> Properties </h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="viewContainerMap"></a> <span class="name"> <span class="modifier">Protected</span> <span ><b>viewContainerMap</b></span> <a href="#viewContainerMap"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>Map&lt;any | ViewContainerRef&gt;</code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>new Map()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="23" class="link-to-prism">src/placeholder/placeholder.service.ts:23</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Map of id&#39;s to secondary <code>ViewContainerRef</code>s</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="viewContainerRef"></a> <span class="name"> <span class="modifier">Protected</span> <span ><b>viewContainerRef</b></span> <a href="#viewContainerRef"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>ViewContainerRef</code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>null</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="19" class="link-to-prism">src/placeholder/placeholder.service.ts:19</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Main <code>ViewContainerRef</code> to insert components into</p> </div> </td> </tr> </tbody> </table> </section> </div> <div class="tab-pane fade tab-source-code" id="source"> <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { ComponentRef, ViewContainerRef, Injector, EnvironmentInjector, inject } from &quot;@angular/core&quot;; import { Injectable } from &quot;@angular/core&quot;; /** * Singleton service used to register the container for out-of-flow components to insert into. * Also used to insert/remove components from that view. */ @Injectable() export class PlaceholderService { /** * Main &#x60;ViewContainerRef&#x60; to insert components into */ protected viewContainerRef: ViewContainerRef &#x3D; null; /** * Map of id&#x27;s to secondary &#x60;ViewContainerRef&#x60;s */ protected viewContainerMap: Map&lt;any, ViewContainerRef&gt; &#x3D; new Map(); /** * Used by &#x60;Placeholder&#x60; to register view-container reference. */ registerViewContainerRef(vcRef: ViewContainerRef, id?: any): void { if (id) { this.viewContainerMap.set(id, vcRef); } else { this.viewContainerRef &#x3D; vcRef; } } /** * Creates and returns component in the view. */ createComponent( component: ComponentRef&lt;any&gt;, injector: Injector, id?: any, environment: EnvironmentInjector &#x3D; undefined ): ComponentRef&lt;any&gt; { if (id) { if (!this.viewContainerMap.has(id)) { console.error(&#x60;No view container with id ${id} found&#x60;); return; } return this.viewContainerMap.get(id).createComponent(component as any, { index: this.viewContainerMap.size, injector }); } if (!this.viewContainerRef) { console.error(&quot;No view container defined! Likely due to a missing &#x60;cds-placeholder&#x60;&quot;); return; } return this.viewContainerRef.createComponent(component as any, { index: this.viewContainerRef.length, injector, environmentInjector: environment } ); } destroyComponent(component: ComponentRef&lt;any&gt;) { component.destroy(); } hasComponentRef(component: ComponentRef&lt;any&gt;, id?: any) { if (id) { return !(this.viewContainerMap.get(id).indexOf(component.hostView) &lt; 0); } return !(this.viewContainerRef.indexOf(component.hostView) &lt; 0); } hasPlaceholderRef(id?: any) { if (id) { return this.viewContainerMap.has(id); } return !!this.viewContainerRef; } appendElement(element: HTMLElement, id?: any): HTMLElement { if (id) { return this.viewContainerMap.get(id).element.nativeElement.appendChild(element); } return this.viewContainerRef.element.nativeElement.appendChild(element); } removeElement(element: HTMLElement, id?: any): HTMLElement { if (id) { return this.viewContainerMap.get(id).element.nativeElement.removeChild(element); } return this.viewContainerRef.element.nativeElement.removeChild(element); } hasElement(element: HTMLElement, id?: any): boolean { if (id) { return this.viewContainerMap.get(id).element.nativeElement.contains(element); } return this.viewContainerRef.element.nativeElement.contains(element); } } </code></pre> </div> </div> </div><div class="search-results"> <div class="has-results"> <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1> <ul class="search-results-list"></ul> </div> <div class="no-results"> <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1> </div> </div> </div> <!-- END CONTENT --> </div> </div> <label class="dark-mode-switch"> <input type="checkbox"> <span class="slider"> <svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg"> <path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path> </svg> </span> </label> <script> var COMPODOC_CURRENT_PAGE_DEPTH = 1; var COMPODOC_CURRENT_PAGE_CONTEXT = 'injectable'; var COMPODOC_CURRENT_PAGE_URL = 'PlaceholderService.html'; var MAX_SEARCH_RESULTS = 15; </script> <script> $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input'); checkToggle(darkModeState); if ($darkModeToggleSwitchers.length > 0) { for (var i = 0; i < $darkModeToggleSwitchers.length; i++) { $darkModeToggleSwitchers[i].addEventListener('change', function (event) { darkModeState = !darkModeState; toggleDarkMode(darkModeState); }); } } </script> <script src="../js/libs/custom-elements.min.js"></script> <script src="../js/libs/lit-html.js"></script> <script src="../js/menu-wc.js" defer></script> <script nomodule src="../js/menu-wc_es5.js" defer></script> <script src="../js/libs/bootstrap-native.js"></script> <script src="../js/libs/es6-shim.min.js"></script> <script src="../js/libs/EventDispatcher.js"></script> <script src="../js/libs/promise.min.js"></script> <script src="../js/libs/zepto.min.js"></script> <script src="../js/compodoc.js"></script> <script src="../js/tabs.js"></script> <script src="../js/menu.js"></script> <script src="../js/libs/clipboard.min.js"></script> <script src="../js/libs/prism.js"></script> <script src="../js/sourceCode.js"></script> <script src="../js/search/search.js"></script> <script src="../js/search/lunr.min.js"></script> <script src="../js/search/search-lunr.js"></script> <script src="../js/search/search_index.js"></script> <script src="../js/lazy-load-graphs.js"></script> <footer class="carbon"> <dds-footer-container key="footer" disable-locale-button="true" size="micro" /> </footer> <script key="8" type="module" src="https://1.www.s81c.com/common/carbon-for-ibm-dotcom/tag/v1/latest/footer.min.js"> </script> <!-- Storybook override --> <script> document.title = "Carbon Components Angular"; </script> <script src="//1.www.s81c.com/common/stats/ibm-common.js" type="text/javascript" async="async"> </script> </body> </html>