@compodoc/compodoc
Version:
The missing documentation tool for your Angular application
463 lines (400 loc) • 20.3 kB
HTML
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>@compodoc/compodoc 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">
</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>
<script>
// --- Iframe navigation tracking for Template Playground ---
function sendCurrentUrlToParent() {
if (window.parent && window.parent !== window) {
window.parent.postMessage({
type: 'compodoc-iframe-navigate',
url: window.location.pathname + window.location.hash
}, '*');
}
}
window.addEventListener('hashchange', sendCurrentUrlToParent, false);
window.addEventListener('popstate', sendCurrentUrlToParent, false);
window.addEventListener('DOMContentLoaded', sendCurrentUrlToParent, false);
</script>
<div class="navbar navbar-default navbar-fixed-top d-md-none p-0">
<div class="d-flex">
<a href="../" class="navbar-brand">@compodoc/compodoc 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 module">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Modules</li>
<li class="breadcrumb-item" >AppModule</li>
</ol>
<div class="text-center module-graph-container">
<div id="module-graph-svg">
<!-- Generated by graphviz version 2.47.0 (20210316.0004)
-->
<!-- Title: dependencies Pages: 1 -->
<svg width="724pt" height="284pt"
viewBox="0.00 0.00 724.00 284.00" 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 280)">
<title>dependencies</title>
<polygon fill="white" stroke="transparent" points="-4,4 -4,-280 720,-280 720,4 -4,4"/>
<text text-anchor="start" x="337.01" y="-42.4" font-family="Times-12" font-weight="bold" font-size="14.00">Legend</text>
<polygon fill="#ffffb3" stroke="transparent" points="124,-10 124,-30 144,-30 144,-10 124,-10"/>
<text text-anchor="start" x="147.63" y="-15.4" font-family="Times-12" font-size="14.00">  Declarations</text>
<polygon fill="#8dd3c7" stroke="transparent" points="237,-10 237,-30 257,-30 257,-10 237,-10"/>
<text text-anchor="start" x="260.73" y="-15.4" font-family="Times-12" font-size="14.00">  Module</text>
<polygon fill="#80b1d3" stroke="transparent" points="323,-10 323,-30 343,-30 343,-10 323,-10"/>
<text text-anchor="start" x="346.78" y="-15.4" font-family="Times-12" font-size="14.00">  Bootstrap</text>
<polygon fill="#fdb462" stroke="transparent" points="420,-10 420,-30 440,-30 440,-10 420,-10"/>
<text text-anchor="start" x="443.67" y="-15.4" font-family="Times-12" font-size="14.00">  Providers</text>
<polygon fill="#fb8072" stroke="transparent" points="516,-10 516,-30 536,-30 536,-10 516,-10"/>
<text text-anchor="start" x="539.73" y="-15.4" font-family="Times-12" font-size="14.00">  Exports</text>
<g id="clust1" class="cluster">
<title>cluster_AppModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="8,-70 8,-268 708,-268 708,-70 8,-70"/>
</g>
<g id="clust6" class="cluster">
<title>cluster_AppModule_imports</title>
<polygon fill="none" stroke="black" points="504,-78 504,-130 700,-130 700,-78 504,-78"/>
</g>
<g id="clust9" class="cluster">
<title>cluster_AppModule_providers</title>
<polygon fill="none" stroke="black" points="370,-78 370,-130 496,-130 496,-78 370,-78"/>
</g>
<g id="clust8" class="cluster">
<title>cluster_AppModule_bootstrap</title>
<polygon fill="none" stroke="black" points="307,-208 307,-260 429,-260 429,-208 307,-208"/>
</g>
<g id="clust2" class="cluster">
<title>cluster_AppModule_declarations</title>
<polygon fill="none" stroke="black" points="16,-78 16,-130 362,-130 362,-78 16,-78"/>
</g>
<!-- BarComponent -->
<g id="node1" class="node">
<title>BarComponent</title>
<polygon fill="#ffffb3" stroke="black" points="353.55,-122 252.45,-122 252.45,-86 353.55,-86 353.55,-122"/>
<text text-anchor="middle" x="303" y="-99.8" font-family="Times,serif" font-size="14.00">BarComponent</text>
</g>
<!-- AppModule -->
<g id="node4" class="node">
<title>AppModule</title>
<polygon fill="#8dd3c7" stroke="black" points="409.66,-187 406.66,-191 385.66,-191 382.66,-187 326.34,-187 326.34,-151 409.66,-151 409.66,-187"/>
<text text-anchor="middle" x="368" y="-164.8" font-family="Times,serif" font-size="14.00">AppModule</text>
</g>
<!-- BarComponent->AppModule -->
<g id="edge1" class="edge">
<title>BarComponent->AppModule</title>
<path fill="none" stroke="black" d="M339.97,-122.11C339.97,-122.11 339.97,-140.99 339.97,-140.99"/>
<polygon fill="black" stroke="black" points="336.47,-140.99 339.97,-150.99 343.47,-140.99 336.47,-140.99"/>
</g>
<!-- FooComponent -->
<g id="node2" class="node">
<title>FooComponent</title>
<polygon fill="#ffffb3" stroke="black" points="234.62,-122 131.38,-122 131.38,-86 234.62,-86 234.62,-122"/>
<text text-anchor="middle" x="183" y="-99.8" font-family="Times,serif" font-size="14.00">FooComponent</text>
</g>
<!-- FooComponent->AppModule -->
<g id="edge2" class="edge">
<title>FooComponent->AppModule</title>
<path fill="none" stroke="black" d="M183,-122.02C183,-139.37 183,-163 183,-163 183,-163 316.02,-163 316.02,-163"/>
<polygon fill="black" stroke="black" points="316.02,-166.5 326.02,-163 316.02,-159.5 316.02,-166.5"/>
</g>
<!-- FooDirective -->
<g id="node3" class="node">
<title>FooDirective</title>
<polygon fill="#ffffb3" stroke="black" points="113.87,-122 24.13,-122 24.13,-86 113.87,-86 113.87,-122"/>
<text text-anchor="middle" x="69" y="-99.8" font-family="Times,serif" font-size="14.00">FooDirective</text>
</g>
<!-- FooDirective->AppModule -->
<g id="edge3" class="edge">
<title>FooDirective->AppModule</title>
<path fill="none" stroke="black" d="M69,-122.28C69,-143.32 69,-175 69,-175 69,-175 316.11,-175 316.11,-175"/>
<polygon fill="black" stroke="black" points="316.11,-178.5 326.11,-175 316.11,-171.5 316.11,-178.5"/>
</g>
<!-- FooComponent -->
<g id="node7" class="node">
<title>FooComponent </title>
<polygon fill="#80b1d3" stroke="black" points="421.12,-252 314.88,-252 314.88,-216 421.12,-216 421.12,-252"/>
<text text-anchor="middle" x="368" y="-229.8" font-family="Times,serif" font-size="14.00">FooComponent </text>
</g>
<!-- AppModule->FooComponent -->
<g id="edge6" class="edge">
<title>AppModule->FooComponent </title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M368,-187.11C368,-187.11 368,-205.99 368,-205.99"/>
<polygon fill="black" stroke="black" points="364.5,-205.99 368,-215.99 371.5,-205.99 364.5,-205.99"/>
</g>
<!-- BarModule -->
<g id="node5" class="node">
<title>BarModule</title>
<polygon fill="#8dd3c7" stroke="black" points="691.76,-122 688.76,-126 667.76,-126 664.76,-122 612.24,-122 612.24,-86 691.76,-86 691.76,-122"/>
<text text-anchor="middle" x="652" y="-99.8" font-family="Times,serif" font-size="14.00">BarModule</text>
</g>
<!-- BarModule->AppModule -->
<g id="edge4" class="edge">
<title>BarModule->AppModule</title>
<path fill="none" stroke="black" d="M652,-122.28C652,-143.32 652,-175 652,-175 652,-175 419.91,-175 419.91,-175"/>
<polygon fill="black" stroke="black" points="419.91,-171.5 409.91,-175 419.91,-178.5 419.91,-171.5"/>
</g>
<!-- FooModule -->
<g id="node6" class="node">
<title>FooModule</title>
<polygon fill="#8dd3c7" stroke="black" points="593.83,-122 590.83,-126 569.83,-126 566.83,-122 512.17,-122 512.17,-86 593.83,-86 593.83,-122"/>
<text text-anchor="middle" x="553" y="-99.8" font-family="Times,serif" font-size="14.00">FooModule</text>
</g>
<!-- FooModule->AppModule -->
<g id="edge5" class="edge">
<title>FooModule->AppModule</title>
<path fill="none" stroke="black" d="M553,-122.02C553,-139.37 553,-163 553,-163 553,-163 419.98,-163 419.98,-163"/>
<polygon fill="black" stroke="black" points="419.98,-159.5 409.98,-163 419.98,-166.5 419.98,-159.5"/>
</g>
<!-- FooService -->
<g id="node8" class="node">
<title>FooService</title>
<ellipse fill="#fdb462" stroke="black" cx="433" cy="-104" rx="55.03" ry="18"/>
<text text-anchor="middle" x="433" y="-99.8" font-family="Times,serif" font-size="14.00">FooService</text>
</g>
<!-- FooService->AppModule -->
<g id="edge7" class="edge">
<title>FooService->AppModule</title>
<path fill="none" stroke="black" d="M393.91,-116.84C393.91,-116.84 393.91,-140.52 393.91,-140.52"/>
<polygon fill="black" stroke="black" points="390.41,-140.52 393.91,-150.52 397.41,-140.52 390.41,-140.52"/>
</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="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>test/fixtures/sample-files/app.module.ts</code>
</p>
<p class="comment">
<h3>Description</h3>
</p>
<p class="comment">
<p>AppModule description</p>
<p>See <a href="../components/BarComponent.html">BarComponent</a></p>
</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" rel="noopener noreferrer"
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/BarComponent.html">BarComponent</a>
</li>
<li class="list-group-item">
<a href="../components/FooComponent.html">FooComponent</a>
</li>
<li class="list-group-item">
<a href="../directives/FooDirective.html">FooDirective</a>
</li>
</ul>
</div>
<div class="col-sm-3">
<h3>Providers<a href="https://angular.io/api/core/NgModule#providers" target="_blank" rel="noopener noreferrer"
title="Official documentation about module providers"><span class="icon ion-ios-information-circle-outline"></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../injectables/FooService.html">FooService</a>
</li>
</ul>
</div>
<div class="col-sm-3">
<h3>Imports<a href="https://angular.io/api/core/NgModule#imports" target="_blank" rel="noopener noreferrer"
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/BarModule.html">BarModule</a>
</li>
<li class="list-group-item">
<a href="../modules/FooModule.html">FooModule</a>
</li>
</ul>
</div>
<div class="col-sm-3">
<h3>Bootstrap<a href="https://angular.io/api/core/NgModule#bootstrap" target="_blank" rel="noopener noreferrer"
title="Official documentation about module bootstrap"><span class="icon ion-ios-information-circle-outline"></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../components/FooComponent.html">FooComponent</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="tab-pane fade tab-source-code" id="source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { NgModule, BrowserModule } from '@angular/core';
import { FooDirective } from './foo.directive';
import { FooComponent } from './foo.component';
import { BarDirective } from './bar.directive';
import { BarComponent } from './bar.component';
import { FooService } from './foo.service';
import { BarModule } from './bar.module';
import { FooModule } from './foo.module';
/**
* AppModule description
*
* See {@link BarComponent}
*/
@NgModule({
declarations: [FooDirective, FooComponent, BarComponent],
providers: [FooService],
imports: [BarModule, FooModule],
bootstrap: [FooComponent]
})
export class AppModule {}
</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 = 'module';
var COMPODOC_CURRENT_PAGE_URL = 'AppModule.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/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>