@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 > ListComponent</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="#readme" role="tab" id="readme-tab" data-toggle="tab" data-link="readme">README</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/list/list.component.ts</code> </p> <p class="comment"> <h3>Description</h3> </p> <p class="comment"> <p>The list of todos component</p> <p>Can filter types of todos :</p> <table class="table table-bordered compodoc-table"> <thead> <tr> <th>Type</th> <th>API</th> </tr> </thead> <tbody> <tr> <td>completed</td> <td>displayCompleted</td> </tr> <tr> <td>all</td> <td>displayAll</td> </tr> <tr> <td>remaining</td> <td>displayRemaining</td> </tr> </tbody> </table> </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>list</code></td> </tr> <tr> <td class="col-md-3">templateUrl</td> <td class="col-md-9"><code>./list.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="#todos" >todos</a> </li> <li> <a href="#todoStore" >todoStore</a> </li> <li> <a href="#watchTest" >watchTest</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="32" class="link-to-prism">src/app/list/list.component.ts:32</a></div> </td> </tr> <tr> <td class="col-md-4"> <div> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>todoStore</td> <td> <code><a href="../injectables/TodoStore.html" target="_self" >TodoStore</a></code> </td> <td> No </td> </tr> </tbody> </table> </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="todos"></a> <span class="name"> <span ><b>todos</b></span> <a href="#todos"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="../classes/Todo.html" target="_self" >Array<Todo></a></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/list/list.component.ts:31</a></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="30" class="link-to-prism">src/app/list/list.component.ts:30</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> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="watchTest"></a> <span class="name"> <span ><b>watchTest</b></span> <a href="#watchTest"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="32" class="link-to-prism">src/app/list/list.component.ts:32</a></div> </td> </tr> </tbody> </table> </section> </div> <div class="tab-pane fade " id="c-readme"> <p><h1 id="list-component">List component</h1> <p>It display the lines of todos.</p> </p> </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 { Observable } from 'rxjs/Rx'; import { TodoStore } from '../shared/services/todo.store'; import { EmitterService } from '../shared/services/emitter.service'; import { Todo } from '../shared/models/todo.model'; /** * The list of todos component * * Can filter types of todos : * * | Type | API | * | --- | --- | * | completed | displayCompleted | * | all | displayAll | * | remaining | displayRemaining | */ @Component({ selector: 'list', providers: [], templateUrl: './list.component.html' }) export class ListComponent { /** * Local reference of TodoStore */ todoStore: TodoStore; todos: Array<Todo>; watchTest; constructor(todoStore: TodoStore) { let that = this; this.todoStore = todoStore; this.todos = todoStore.getAll(); this.watchTest = Observable.of(todoStore.todos); EmitterService.get('FooterComponent').subscribe(value => { console.log(value); switch (value) { case 'displayCompleted': that.todos = todoStore.getCompleted(); break; case 'displayAll': that.todos = todoStore.getAll(); break; case 'displayRemaining': that.todos = todoStore.getRemaining(); break; } }); this.watchTest.subscribe(data => { console.log(data); }); } } </code></pre> </div> <div class="tab-pane fade " id="c-templateData"> <pre class="line-numbers"><code class="language-html"><input class="toggle-all" type="checkbox" *ngIf="todoStore.todos.length" #toggleall [checked]="todoStore.allCompleted()" (click)="todoStore.setAllTo(toggleall.checked)"> <div *ngIf="todoStore.todos.length > 0"> <ul class="todo-list" > <todo *ngFor="let todo of todos" [todo]='todo'></todo> </ul> </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><input class="toggle-all" type="checkbox" *ngIf="todoStore.todos.length" #toggleall [checked]="todoStore.allCompleted()" (click)="todoStore.setAllTo(toggleall.checked)"><div *ngIf="todoStore.todos.length > 0"> <ul class="todo-list" > <todo *ngFor="let todo of todos" [todo]=\'todo\'></todo> </ul></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': 'ListComponent'}; </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 = 'ListComponent.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>