@compodoc/compodoc
Version:
The missing documentation tool for your Angular application
311 lines (260 loc) • 11.4 kB
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>
<!-- START CONTENT -->
<div class="content module">
<div class="content-data">
<ol class="breadcrumb">
<li>Modules</li>
<li >ListModule</li>
</ol>
<div class="text-center module-graph-container">
<div id="module-graph-svg">
<!-- Generated by graphviz version 2.47.3 (20210619.1520)
-->
<!-- Title: dependencies Pages: 1 -->
<svg width="274pt" height="247pt"
viewBox="0.00 0.00 274.00 246.80" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 242.8)">
<title>dependencies</title>
<polygon fill="white" stroke="transparent" points="-4,4 -4,-242.8 270,-242.8 270,4 -4,4"/>
<text text-anchor="middle" x="133" y="-8.2" font-family="sans-serif" font-size="14.00">dependencies</text>
<g id="clust1" class="cluster">
<title>cluster_ListModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="8,-32.8 8,-230.8 258,-230.8 258,-32.8 8,-32.8"/>
</g>
<g id="clust4" class="cluster">
<title>cluster_ListModule_imports</title>
<polygon fill="none" stroke="black" points="144,-40.8 144,-92.8 250,-92.8 250,-40.8 144,-40.8"/>
</g>
<g id="clust5" class="cluster">
<title>cluster_ListModule_exports</title>
<polygon fill="none" stroke="black" points="72,-170.8 72,-222.8 194,-222.8 194,-170.8 72,-170.8"/>
</g>
<g id="clust2" class="cluster">
<title>cluster_ListModule_declarations</title>
<polygon fill="none" stroke="black" points="16,-40.8 16,-92.8 136,-92.8 136,-40.8 16,-40.8"/>
</g>
<!-- ListComponent -->
<g id="node1" class="node">
<title>ListComponent</title>
<polygon fill="#ffffb3" stroke="black" points="127.61,-84.8 24.39,-84.8 24.39,-48.8 127.61,-48.8 127.61,-84.8"/>
<text text-anchor="middle" x="76" y="-62.6" font-family="Times,serif" font-size="14.00">ListComponent</text>
</g>
<!-- ListModule -->
<g id="node2" class="node">
<title>ListModule</title>
<polygon fill="#8dd3c7" stroke="black" points="173.83,-149.8 170.83,-153.8 149.83,-153.8 146.83,-149.8 92.17,-149.8 92.17,-113.8 173.83,-113.8 173.83,-149.8"/>
<text text-anchor="middle" x="133" y="-127.6" font-family="Times,serif" font-size="14.00">ListModule</text>
</g>
<!-- ListComponent->ListModule -->
<g id="edge1" class="edge">
<title>ListComponent->ListModule</title>
<path fill="none" stroke="black" d="M109.95,-84.91C109.95,-84.91 109.95,-103.79 109.95,-103.79"/>
<polygon fill="black" stroke="black" points="106.45,-103.79 109.95,-113.79 113.45,-103.79 106.45,-103.79"/>
</g>
<!-- ListComponent -->
<g id="node4" class="node">
<title>ListComponent </title>
<polygon fill="#fb8072" stroke="black" points="186.11,-214.8 79.89,-214.8 79.89,-178.8 186.11,-178.8 186.11,-214.8"/>
<text text-anchor="middle" x="133" y="-192.6" font-family="Times,serif" font-size="14.00">ListComponent </text>
</g>
<!-- ListModule->ListComponent -->
<g id="edge3" class="edge">
<title>ListModule->ListComponent </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M133,-149.91C133,-149.91 133,-168.79 133,-168.79"/>
<polygon fill="black" stroke="black" points="129.5,-168.79 133,-178.79 136.5,-168.79 129.5,-168.79"/>
</g>
<!-- TodoModule -->
<g id="node3" class="node">
<title>TodoModule</title>
<polygon fill="#8dd3c7" stroke="black" points="241.6,-84.8 238.6,-88.8 217.6,-88.8 214.6,-84.8 152.4,-84.8 152.4,-48.8 241.6,-48.8 241.6,-84.8"/>
<text text-anchor="middle" x="197" y="-62.6" font-family="Times,serif" font-size="14.00">TodoModule</text>
</g>
<!-- TodoModule->ListModule -->
<g id="edge2" class="edge">
<title>TodoModule->ListModule</title>
<path fill="none" stroke="black" d="M163.06,-84.91C163.06,-84.91 163.06,-103.79 163.06,-103.79"/>
<polygon fill="black" stroke="black" points="159.56,-103.79 163.06,-113.79 166.56,-103.79 159.56,-103.79"/>
</g>
</g>
</svg>
</div>
<i id="fullscreen" class="icon ion-ios-resize module-graph-fullscreen-btn" aria-hidden="true"></i>
<div class="btn-group size-buttons">
<button id="zoom-in" class="btn btn-default btn-sm">Zoom in</button>
<button id="reset" class="btn btn-default btn-sm">Reset</button>
<button id="zoom-out" class="btn btn-default btn-sm">Zoom out</button>
</div>
</div>
<script src="../js/libs/svg-pan-zoom.min.js"></script>
<script src="../js/svg-pan-zoom.controls.js"></script>
<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>
</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.module.ts</code>
</p>
<p class="comment">
<h3>Description</h3>
</p>
<p class="comment">
<p>The list of todos module</p>
<p>Contains list component which 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>
<div class="container-fluid module">
<div class="row">
<div class="col-sm-3">
<h3>Declarations<a href="https://angular.io/api/core/NgModule#declarations" target="_blank"
title="Official documentation about module declarations"><span class="icon ion-ios-information-circle-outline"></span></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../components/ListComponent.html">ListComponent</a>
</li>
</ul>
</div>
<div class="col-sm-3">
<h3>Imports<a href="https://angular.io/api/core/NgModule#imports" target="_blank" title="Official documentation about module imports"><span
class="icon ion-ios-information-circle-outline"></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../modules/TodoModule.html">TodoModule</a>
</li>
</ul>
</div>
<div class="col-sm-3">
<h3>Exports<a href="https://angular.io/api/core/NgModule#exports" target="_blank" title="Official documentation about module exports"><span
class="icon ion-ios-information-circle-outline"></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../components/ListComponent.html">ListComponent</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { ListComponent } from './list.component';
import { TodoModule } from './todo/';
const MODULES = [TodoModule, BrowserModule];
/**
* The list of todos module
*
* Contains list component which can filter types of todos :
*
* | Type | API |
* | --- | --- |
* | completed | displayCompleted |
* | all | displayAll |
* | remaining | displayRemaining |
*/
@NgModule({
imports: [MODULES],
declarations: [ListComponent],
exports: [ListComponent]
})
export class ListModule {}
</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>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'module';
var COMPODOC_CURRENT_PAGE_URL = 'ListModule.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>