@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 > TodoComponent</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> <li > <a href="#example" role="tab" id="example-tab" data-toggle="tab" data-link="example">Examples</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/todo/todo.component.ts</code> </p> <p class="comment"> <h3>Description</h3> </p> <p class="comment"> <p>The todo component</p> <div><pre class="line-numbers"><code class="language-html"><todo> [todo]="todo" </todo></code></pre></div><p><example-url>/demo/mysample.component.html</example-url></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>todo</code></td> </tr> <tr> <td class="col-md-3">templateUrl</td> <td class="col-md-9"><code>./todo.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="#todoStore" >todoStore</a> </li> <li> <a href="#unionVariable" >unionVariable</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="#cancelEditingTodo" >cancelEditingTodo</a> </li> <li> <a href="#editTodo" >editTodo</a> </li> <li> <span class="modifier">Public</span> <a href="#filter" >filter</a> </li> <li> <a href="#remove" >remove</a> </li> <li> <a href="#stopEditing" >stopEditing</a> </li> <li> <a href="#toggleCompletion" >toggleCompletion</a> </li> <li> <a href="#updateEditingTodo" >updateEditingTodo</a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>Inputs</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#todo" >todo</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="34" class="link-to-prism">src/app/list/todo/todo.component.ts:34</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">Inputs</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="todo"></a> <b>todo</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="../classes/Todo.html" target="_self" >Todo</a></code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="25" class="link-to-prism">src/app/list/todo/todo.component.ts:25</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>The entry todo from the parent list</p> </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="cancelEditingTodo"></a> <span class="name"> <span ><b>cancelEditingTodo</b></span> <a href="#cancelEditingTodo"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>cancelEditingTodo(todo: <a href="../classes/Todo.html" target="_self">Todo</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="57" class="link-to-prism">src/app/list/todo/todo.component.ts:57</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>todo</td> <td> <code><a href="../classes/Todo.html" target="_self" >Todo</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> <div> </div> <div class="io-description"> <b>Returns : </b> <code><a href="../miscellaneous/variables.html#id" target="_self" >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="editTodo"></a> <span class="name"> <span ><b>editTodo</b></span> <a href="#editTodo"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>editTodo(todo: <a href="../classes/Todo.html" target="_self">Todo</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="48" class="link-to-prism">src/app/list/todo/todo.component.ts:48</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>todo</td> <td> <code><a href="../classes/Todo.html" target="_self" >Todo</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> <div> </div> <div class="io-description"> <b>Returns : </b> <code><a href="../miscellaneous/variables.html#id" target="_self" >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="filter"></a> <span class="name"> <span class="modifier">Public</span> <span ><b>filter</b></span> <a href="#filter"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>filter(term: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, fields?: (string | number)[])</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="29" class="link-to-prism">src/app/list/todo/todo.component.ts:29</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>term</td> <td> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> </td> <td> No </td> </tr> <tr> <td>fields</td> <td> <code>(string | number)[]</code> </td> <td> Yes </td> </tr> </tbody> </table> </div> <div> </div> <div class="io-description"> <b>Returns : </b> <code><a href="../miscellaneous/variables.html#id" target="_self" >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="remove"></a> <span class="name"> <span ><b>remove</b></span> <a href="#remove"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>remove(todo: <a href="../classes/Todo.html" target="_self">Todo</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="40" class="link-to-prism">src/app/list/todo/todo.component.ts:40</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>todo</td> <td> <code><a href="../classes/Todo.html" target="_self" >Todo</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> <div> </div> <div class="io-description"> <b>Returns : </b> <code><a href="../miscellaneous/variables.html#id" target="_self" >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="stopEditing"></a> <span class="name"> <span ><b>stopEditing</b></span> <a href="#stopEditing"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>stopEditing(todo: <a href="../classes/Todo.html" target="_self">Todo</a>, editedTitle: <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"> <div class="io-line">Defined in <a href="" data-line="52" class="link-to-prism">src/app/list/todo/todo.component.ts:52</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>todo</td> <td> <code><a href="../classes/Todo.html" target="_self" >Todo</a></code> </td> <td> No </td> </tr> <tr> <td>editedTitle</td> <td> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> <div> </div> <div class="io-description"> <b>Returns : </b> <code><a href="../miscellaneous/variables.html#id" target="_self" >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="toggleCompletion"></a> <span class="name"> <span ><b>toggleCompletion</b></span> <a href="#toggleCompletion"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>toggleCompletion(todo: <a href="../classes/Todo.html" target="_self">Todo</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="44" class="link-to-prism">src/app/list/todo/todo.component.ts:44</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>todo</td> <td> <code><a href="../classes/Todo.html" target="_self" >Todo</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> <div> </div> <div class="io-description"> <b>Returns : </b> <code><a href="../miscellaneous/variables.html#id" target="_self" >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="updateEditingTodo"></a> <span class="name"> <span ><b>updateEditingTodo</b></span> <a href="#updateEditingTodo"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>updateEditingTodo(todo: <a href="../classes/Todo.html" target="_self">Todo</a>, editedTitle: <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"> <div class="io-line">Defined in <a href="" data-line="61" class="link-to-prism">src/app/list/todo/todo.component.ts:61</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>todo</td> <td> <code><a href="../classes/Todo.html" target="_self" >Todo</a></code> </td> <td> No </td> </tr> <tr> <td>editedTitle</td> <td> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> <div> </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> </section> <section> <h3 id="inputs"> Properties </h3> <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="34" class="link-to-prism">src/app/list/todo/todo.component.ts:34</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="unionVariable"></a> <span class="name"> <span ><b>unionVariable</b></span> <a href="#unionVariable"><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" >string[] | Todo</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/app/list/todo/todo.component.ts:27</a></div> </td> </tr> </tbody> </table> </section> </div> <div class="tab-pane fade " id="c-readme"> <p><h1 id="todo-component">Todo component</h1> <p>This is the core component of the application.</p> <p><img src="screenshots/todo/todo.png" alt="Screenshot-1" class="img-responsive"></p> <p>It display the line of one todo task, and APIs for edition & delete</p> <p>This is an extract of these APIs</p> <div><pre class="line-numbers"><code class="language-typescript">export class TodoComponent { ... editTodo(todo: Todo) { todo.editing = true; } ... }</code></pre></div></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, Input } from '@angular/core'; import { Todo } from '../../shared/models/todo.model'; import { TodoStore } from '../../shared/services/todo.store'; /** * The todo component * ```html * <todo> * [todo]="todo" * </todo> * ``` * * <example-url>/demo/mysample.component.html</example-url> */ @Component({ selector: 'todo', templateUrl: './todo.component.html' }) export class TodoComponent { /** * The entry todo from the parent list */ @Input() todo: Todo; unionVariable: string[] | Todo; public filter(term: string, fields?: (string | number)[]): void; /** * Local reference of TodoStore */ todoStore: TodoStore; constructor(todoStore: TodoStore) { this.todoStore = todoStore; } remove(todo: Todo) { this.todoStore.remove(todo); } toggleCompletion(todo: Todo) { this.todoStore.toggleCompletion(todo); } editTodo(todo: Todo) { todo.editing = true; } stopEditing(todo: Todo, editedTitle: string) { todo.title = editedTitle; todo.editing = false; } cancelEditingTodo(todo: Todo) { todo.editing = false; } updateEditingTodo(todo: Todo, editedTitle: string) { editedTitle = editedTitle.trim(); todo.editing = false; if (editedTitle.length === 0) { return this.todoStore.remove(todo); } todo.title = editedTitle; this.todoStore.update(); } } </code></pre> </div> <div class="tab-pane fade " id="c-templateData"> <pre class="line-numbers"><code class="language-html"><li [class.completed]="todo.completed" [class.editing]="todo.editing"> <div class="view"> <input class="toggle" type="checkbox" (click)="toggleCompletion(todo)" [checked]="todo.completed"> <label (dblclick)="editTodo(todo)" donothing>{{todo.title | firstUpper}}</label> <button class="destroy" (click)="remove(todo)"></button> </div> <input class="edit" *ngIf="todo.editing" [value]="todo.title" #editedtodo (blur)="stopEditing(todo, editedtodo.value)" (keyup.enter)="updateEditingTodo(todo, editedtodo.value)" (keyup.escape)="cancelEditingTodo(todo)"> </li> </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 class="tab-pane fade " id="c-example"> <iframe class="exampleContainer" src="/demo/mysample.component.html"> <p>no-iframes</p> </iframe> </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><li [class.completed]="todo.completed" [class.editing]="todo.editing"> <div class="view"> <input class="toggle" type="checkbox" (click)="toggleCompletion(todo)" [checked]="todo.completed"> <label (dblclick)="editTodo(todo)" donothing>{{todo.title | firstUpper}}</label> <button class="destroy" (click)="remove(todo)"></button> </div> <input class="edit" *ngIf="todo.editing" [value]="todo.title" #editedtodo (blur)="stopEditing(todo, editedtodo.value)" (keyup.enter)="updateEditingTodo(todo, editedtodo.value)" (keyup.escape)="cancelEditingTodo(todo)"></li></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': 'TodoComponent'}; </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 = 'TodoComponent.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>