@compodoc/compodoc

<!doctype html> <html class="no-js" lang=""> <head> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <title>sample-files 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" media="(prefers-color-scheme: dark)"> </head> <body> <div class="navbar navbar-default navbar-fixed-top visible-xs"> <a href="../" class="navbar-brand">sample-files documentation</a> <button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button> </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="hidden-xs menu"> <compodoc-menu mode="normal"></compodoc-menu> </div>  <div class="content component"> <div class="content-data"> <ol class="breadcrumb"> <li>Components</li> <li > FooterComponent</li> </ol> <ul class="nav nav-tabs" role="tablist"> <li class="active"> <a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a> </li> <li > <a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a> </li> <li > <a href="#templateData" role="tab" id="templateData-tab" data-toggle="tab" data-link="template">Template</a> </li> <li > <a href="#tree" role="tab" id="tree-tab" data-toggle="tab" data-link="dom-tree">DOM Tree</a> </li> </ul> <div class="tab-content"> <div class="tab-pane fade active in" id="c-info"><p class="comment"> <h3>File</h3> </p> <p class="comment"> <code>src/app/footer/footer.component.ts</code> </p> <p class="comment"> <h3>Description</h3> </p> <p class="comment"> <p>The footer component</p> </p> <section> <h3>Metadata</h3> <table class="table table-sm table-hover"> <tbody> <tr> <td class="col-md-3">selector</td> <td class="col-md-9"><code>footer</code></td> </tr> <tr> <td class="col-md-3">templateUrl</td> <td class="col-md-9"><code>./footer.component.html</code></td> </tr> </tbody> </table> </section> <section> <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> <a href="#currentFilter" >currentFilter</a> </li> <li> <a href="#id" >id</a> </li> <li> <a href="#todoStore" >todoStore</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="#displayAll" >displayAll</a> </li> <li> <a href="#displayCompleted" >displayCompleted</a> </li> <li> <a href="#displayRemaining" >displayRemaining</a> </li> <li> <a href="#removeCompleted" >removeCompleted</a> </li> </ul> </td> </tr> </tbody> </table> </section> <section> <h3 id="constructor">Constructor</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <code>constructor(todoStore: <a href="../injectables/TodoStore.html" target="_self">TodoStore</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="37" class="link-to-prism">src/app/footer/footer.component.ts:37</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>The "constructor"</p> </div> <div> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td>todoStore</td> <td> <code><a href="../injectables/TodoStore.html" target="_self" >TodoStore</a></code> </td> <td> No </td> <td> <p>A TodoStore -> see <a href="../injectables/TodoStore.html">TodoStore</a></p> </td> </tr> </tbody> </table> </div> </td> </tr> </tbody> </table> </section> <section> <h3 id="methods"> Methods </h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="displayAll"></a> <span class="name"> <span ><b>displayAll</b></span> <a href="#displayAll"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>displayAll()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="75" class="link-to-prism">src/app/footer/footer.component.ts:75</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Display all todos</p> </div> <div class="io-description"> <b>Returns : </b> <code><a href="../miscellaneous/variables.html#id" target="_self" >void</a></code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="displayCompleted"></a> <span class="name"> <span ><b>displayCompleted</b></span> <a href="#displayCompleted"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>displayCompleted()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="59" class="link-to-prism">src/app/footer/footer.component.ts:59</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Display only completed todos</p> </div> <div class="io-description"> <b>Returns : </b> <code><a href="../miscellaneous/variables.html#id" target="_self" >void</a></code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="displayRemaining"></a> <span class="name"> <span ><b>displayRemaining</b></span> <a href="#displayRemaining"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>displayRemaining()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="67" class="link-to-prism">src/app/footer/footer.component.ts:67</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Display only remaining todos</p> </div> <div class="io-description"> <b>Returns : </b> <code><a href="../miscellaneous/variables.html#id" target="_self" >void</a></code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="removeCompleted"></a> <span class="name"> <span ><b>removeCompleted</b></span> <a href="#removeCompleted"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>removeCompleted()</code> </td> </tr> <tr> <td class="col-md-4"> <b>Decorators : </b> <br /> <code>@LogMethod()<br /></code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="52" class="link-to-prism">src/app/footer/footer.component.ts:52</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Removes all the completed todos</p> </div> <div class="io-description"> <b>Returns : </b> <code><a href="../miscellaneous/variables.html#id" target="_self" >void</a></code> </div> </td> </tr> </tbody> </table> </section> <section> <h3 id="inputs"> Properties </h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="currentFilter"></a> <span class="name"> <span ><b>currentFilter</b></span> <a href="#currentFilter"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>'all'</code> </td> </tr> <tr> <td class="col-md-4"> <b>Decorators : </b> <br /> <code> @LogPropertyWithArgs('theCurrentFilter')<br /> </code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="37" class="link-to-prism">src/app/footer/footer.component.ts:37</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Starting filter param</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="id"></a> <span class="name"> <span ><b>id</b></span> <a href="#id"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>'FooterComponent'</code> </td> </tr> <tr> <td class="col-md-4"> <b>Decorators : </b> <br /> <code> @LogProperty()<br /> </code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="31" class="link-to-prism">src/app/footer/footer.component.ts:31</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Local id for EmitterService</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="todoStore"></a> <span class="name"> <span ><b>todoStore</b></span> <a href="#todoStore"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="../injectables/TodoStore.html" target="_self" >TodoStore</a></code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="26" class="link-to-prism">src/app/footer/footer.component.ts:26</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Local reference of TodoStore</p> </div> </td> </tr> </tbody> </table> </section> </div> <div class="tab-pane fade tab-source-code" id="c-source"> <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { Component } from '@angular/core'; import { TodoStore } from '../shared/services/todo.store'; import { EmitterService } from '../shared/services/emitter.service'; import { LogMethod, LogProperty, LogPropertyWithArgs, LogClass, LogClassWithArgs } from '../shared/decorators/log.decorator'; import { FooterComponentSchema } from './footer-component.metadata'; /** * The footer component */ @LogClassWithArgs('toto') @Component(FooterComponentSchema) export class FooterComponent { /** * Local reference of TodoStore */ todoStore: TodoStore; /** * Local id for EmitterService */ @LogProperty id: string = 'FooterComponent'; /** * Starting filter param */ @LogPropertyWithArgs('theCurrentFilter') currentFilter: string = 'all'; /** * The "constructor" * * @param {TodoStore} todoStore A TodoStore -> see {@link TodoStore} */ constructor(todoStore: TodoStore) { this.todoStore = todoStore; } /** * Removes all the completed todos */ @LogMethod removeCompleted() { this.todoStore.removeCompleted(); } /** * Display only completed todos */ displayCompleted() { this.currentFilter = 'completed'; EmitterService.get(this.id).emit('displayCompleted'); } /** * Display only remaining todos */ displayRemaining() { this.currentFilter = 'remaining'; EmitterService.get(this.id).emit('displayRemaining'); } /** * Display all todos */ displayAll() { this.currentFilter = 'all'; EmitterService.get(this.id).emit('displayAll'); } } </code></pre> </div> <div class="tab-pane fade " id="c-templateData"> <pre class="line-numbers"><code class="language-html"><div class="footer" *ngIf="todoStore.todos.length > 0"> <span class="todo-count"><strong>{{todoStore.getRemaining().length}}</strong> {{todoStore.getRemaining().length == 1 ? 'item' : 'items'}} left</span> <ul class="filters"> <li> <a class="selected btn-filter" [class.selected]="currentFilter === 'all'" (click)="displayAll()">All</a> </li> <li> <a class="btn-filter" [class.selected]="currentFilter === 'remaining'" (click)="displayRemaining()">Active</a> </li> <li> <a class="btn-filter" [class.selected]="currentFilter === 'completed'" (click)="displayCompleted()">Completed</a> </li> </ul> <button class="clear-completed" *ngIf="todoStore.getCompleted().length > 0" (click)="removeCompleted()">Clear completed</button> </div> </code></pre> </div> <div class="tab-pane fade " id="c-tree"> <div id="tree-container"></div> <div class="tree-legend"> <div class="title"> <b>Legend</b> </div> <div> <div class="color htmlelement"></div><span>Html element</span> </div> <div> <div class="color component"></div><span>Component</span> </div> <div> <div class="color directive"></div><span>Html element with directive</span> </div> </div> </div> </div> <script src="../js/libs/vis.min.js"></script> <script src="../js/libs/htmlparser.js"></script> <script src="../js/libs/deep-iterator.js"></script> <script> var COMPONENT_TEMPLATE = '<div><div class="footer" *ngIf="todoStore.todos.length > 0"> <span class="todo-count"><strong>{{todoStore.getRemaining().length}}</strong> {{todoStore.getRemaining().length == 1 ? \'item\' : \'items\'}} left</span> <ul class="filters"> <li> <a class="selected btn-filter" [class.selected]="currentFilter === \'all\'" (click)="displayAll()">All</a> </li> <li> <a class="btn-filter" [class.selected]="currentFilter === \'remaining\'" (click)="displayRemaining()">Active</a> </li> <li> <a class="btn-filter" [class.selected]="currentFilter === \'completed\'" (click)="displayCompleted()">Completed</a> </li> </ul> <button class="clear-completed" *ngIf="todoStore.getCompleted().length > 0" (click)="removeCompleted()">Clear completed</button></div></div>' var COMPONENTS = [{'name': 'AboutComponent', 'selector': 'about'},{'name': 'AboutComponent2', 'selector': 'about'},{'name': 'AppComponent', 'selector': 'app-root'},{'name': 'CompodocComponent', 'selector': 'compodoc'},{'name': 'DumbComponent', 'selector': 'cp-dumb'},{'name': 'FooterComponent', 'selector': 'footer'},{'name': 'GenericComponent', 'selector': 'app-generic'},{'name': 'GrandsonComponent', 'selector': ''},{'name': 'HeaderComponent', 'selector': 'header'},{'name': 'HomeComponent', 'selector': 'home'},{'name': 'InheritDirComponent', 'selector': ''},{'name': 'JigsawTab', 'selector': 'jigsaw-tab'},{'name': 'ListComponent', 'selector': 'list'},{'name': 'MotherComponent', 'selector': ''},{'name': 'SonComponent', 'selector': ''},{'name': 'TodoComponent', 'selector': 'todo'},{'name': 'TodoMVCComponent', 'selector': 'todomvc'}]; var DIRECTIVES = [{'name': 'BaseDirective', 'selector': ''},{'name': 'DoNothingDirective', 'selector': '[donothing]'},{'name': 'DoNothingDirective2', 'selector': '[donothing]'}]; var ACTUAL_COMPONENT = {'name': 'FooterComponent'}; </script> <script src="../js/tree.js"></script> </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>  </div> </div> <script> var COMPODOC_CURRENT_PAGE_DEPTH = 1; var COMPODOC_CURRENT_PAGE_CONTEXT = 'component'; var COMPODOC_CURRENT_PAGE_URL = 'FooterComponent.html'; var MAX_SEARCH_RESULTS = 15; </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> </body> </html>