@compodoc/compodoc
Version:
The missing documentation tool for your Angular application
540 lines (469 loc) • 25 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">
<button type="button"
class="search-input-clear"
aria-label="Clear search"
data-search-input-clear>×</button>
</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="io-file io-file-path" data-compodoc="entity-file-path">
<span class="icon ion-ios-document" aria-hidden="true"></span>
<code>test/fixtures/sample-files/app.module.ts</code>
</div>
<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="895pt" height="284pt"
viewBox="0.00 0.00 895.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 891,-280 891,4 -4,4"/>
<text text-anchor="start" x="422.51" y="-42.4" font-family="Times-12" font-weight="bold" font-size="14.00">Legend</text>
<polygon fill="#ffffb3" stroke="transparent" points="209.5,-10 209.5,-30 229.5,-30 229.5,-10 209.5,-10"/>
<text text-anchor="start" x="233.13" y="-15.4" font-family="Times-12" font-size="14.00">  Declarations</text>
<polygon fill="#8dd3c7" stroke="transparent" points="322.5,-10 322.5,-30 342.5,-30 342.5,-10 322.5,-10"/>
<text text-anchor="start" x="346.23" y="-15.4" font-family="Times-12" font-size="14.00">  Module</text>
<polygon fill="#80b1d3" stroke="transparent" points="408.5,-10 408.5,-30 428.5,-30 428.5,-10 408.5,-10"/>
<text text-anchor="start" x="432.28" y="-15.4" font-family="Times-12" font-size="14.00">  Bootstrap</text>
<polygon fill="#fdb462" stroke="transparent" points="505.5,-10 505.5,-30 525.5,-30 525.5,-10 505.5,-10"/>
<text text-anchor="start" x="529.17" y="-15.4" font-family="Times-12" font-size="14.00">  Providers</text>
<polygon fill="#fb8072" stroke="transparent" points="601.5,-10 601.5,-30 621.5,-30 621.5,-10 601.5,-10"/>
<text text-anchor="start" x="625.23" 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 879,-268 879,-70 8,-70"/>
</g>
<g id="clust2" class="cluster">
<title>cluster_AppModule_declarations</title>
<polygon fill="none" stroke="black" points="354,-78 354,-130 871,-130 871,-78 354,-78"/>
</g>
<g id="clust10" class="cluster">
<title>cluster_AppModule_providers</title>
<polygon fill="none" stroke="black" points="220,-78 220,-130 346,-130 346,-78 220,-78"/>
</g>
<g id="clust7" class="cluster">
<title>cluster_AppModule_imports</title>
<polygon fill="none" stroke="black" points="16,-78 16,-130 212,-130 212,-78 16,-78"/>
</g>
<g id="clust9" class="cluster">
<title>cluster_AppModule_bootstrap</title>
<polygon fill="none" stroke="black" points="346,-208 346,-260 468,-260 468,-208 346,-208"/>
</g>
<!-- BarComponent -->
<g id="node1" class="node"><a xlink:href="../components/BarComponent.html" href="../components/BarComponent.html" target="_top">
<title>BarComponent</title>
<polygon fill="#ffffb3" stroke="black" points="862.55,-122 761.45,-122 761.45,-86 862.55,-86 862.55,-122"/>
<text text-anchor="middle" x="812" y="-99.8" font-family="Times,serif" font-size="14.00">BarComponent</text>
</a></g>
<!-- AppModule -->
<g id="node5" class="node"><a xlink:href="../modules/AppModule.html" href="../modules/AppModule.html" target="_top">
<title>AppModule</title>
<polygon fill="#8dd3c7" stroke="black" points="448.66,-187 445.66,-191 424.66,-191 421.66,-187 365.34,-187 365.34,-151 448.66,-151 448.66,-187"/>
<text text-anchor="middle" x="407" y="-164.8" font-family="Times,serif" font-size="14.00">AppModule</text>
</a></g>
<!-- BarComponent->AppModule -->
<g id="edge1" class="edge">
<title>BarComponent->AppModule</title>
<path fill="none" stroke="black" d="M812,-122.29C812,-144.21 812,-178 812,-178 812,-178 458.82,-178 458.82,-178"/>
<polygon fill="black" stroke="black" points="458.82,-174.5 448.82,-178 458.82,-181.5 458.82,-174.5"/>
</g>
<!-- ExampleTagComponent -->
<g id="node2" class="node"><a xlink:href="../components/ExampleTagComponent.html" href="../components/ExampleTagComponent.html" target="_top">
<title>ExampleTagComponent</title>
<polygon fill="#ffffb3" stroke="black" points="743.36,-122 590.64,-122 590.64,-86 743.36,-86 743.36,-122"/>
<text text-anchor="middle" x="667" y="-99.8" font-family="Times,serif" font-size="14.00">ExampleTagComponent</text>
</a></g>
<!-- ExampleTagComponent->AppModule -->
<g id="edge2" class="edge">
<title>ExampleTagComponent->AppModule</title>
<path fill="none" stroke="black" d="M667,-122.11C667,-141.34 667,-169 667,-169 667,-169 458.77,-169 458.77,-169"/>
<polygon fill="black" stroke="black" points="458.77,-165.5 448.77,-169 458.77,-172.5 458.77,-165.5"/>
</g>
<!-- FooComponent -->
<g id="node3" class="node"><a xlink:href="../components/FooComponent.html" href="../components/FooComponent.html" target="_top">
<title>FooComponent</title>
<polygon fill="#ffffb3" stroke="black" points="572.62,-122 469.38,-122 469.38,-86 572.62,-86 572.62,-122"/>
<text text-anchor="middle" x="521" y="-99.8" font-family="Times,serif" font-size="14.00">FooComponent</text>
</a></g>
<!-- FooComponent->AppModule -->
<g id="edge3" class="edge">
<title>FooComponent->AppModule</title>
<path fill="none" stroke="black" d="M521,-122.03C521,-138.4 521,-160 521,-160 521,-160 458.8,-160 458.8,-160"/>
<polygon fill="black" stroke="black" points="458.8,-156.5 448.8,-160 458.8,-163.5 458.8,-156.5"/>
</g>
<!-- FooDirective -->
<g id="node4" class="node"><a xlink:href="../directives/FooDirective.html" href="../directives/FooDirective.html" target="_top">
<title>FooDirective</title>
<polygon fill="#ffffb3" stroke="black" points="451.87,-122 362.13,-122 362.13,-86 451.87,-86 451.87,-122"/>
<text text-anchor="middle" x="407" y="-99.8" font-family="Times,serif" font-size="14.00">FooDirective</text>
</a></g>
<!-- FooDirective->AppModule -->
<g id="edge4" class="edge">
<title>FooDirective->AppModule</title>
<path fill="none" stroke="black" d="M407,-122.11C407,-122.11 407,-140.99 407,-140.99"/>
<polygon fill="black" stroke="black" points="403.5,-140.99 407,-150.99 410.5,-140.99 403.5,-140.99"/>
</g>
<!-- FooComponent -->
<g id="node8" class="node"><a xlink:href="../components/FooComponent.html" href="../components/FooComponent.html" target="_top">
<title>FooComponent </title>
<polygon fill="#80b1d3" stroke="black" points="460.12,-252 353.88,-252 353.88,-216 460.12,-216 460.12,-252"/>
<text text-anchor="middle" x="407" y="-229.8" font-family="Times,serif" font-size="14.00">FooComponent </text>
</a></g>
<!-- AppModule->FooComponent -->
<g id="edge7" class="edge">
<title>AppModule->FooComponent </title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M407,-187.11C407,-187.11 407,-205.99 407,-205.99"/>
<polygon fill="black" stroke="black" points="403.5,-205.99 407,-215.99 410.5,-205.99 403.5,-205.99"/>
</g>
<!-- BarModule -->
<g id="node6" class="node"><a xlink:href="../modules/BarModule.html" href="../modules/BarModule.html" target="_top">
<title>BarModule</title>
<polygon fill="#8dd3c7" stroke="black" points="203.76,-122 200.76,-126 179.76,-126 176.76,-122 124.24,-122 124.24,-86 203.76,-86 203.76,-122"/>
<text text-anchor="middle" x="164" y="-99.8" font-family="Times,serif" font-size="14.00">BarModule</text>
</a></g>
<!-- BarModule->AppModule -->
<g id="edge5" class="edge">
<title>BarModule->AppModule</title>
<path fill="none" stroke="black" d="M164,-122.11C164,-141.34 164,-169 164,-169 164,-169 355.23,-169 355.23,-169"/>
<polygon fill="black" stroke="black" points="355.23,-172.5 365.23,-169 355.23,-165.5 355.23,-172.5"/>
</g>
<!-- FooModule -->
<g id="node7" class="node"><a xlink:href="../modules/FooModule.html" href="../modules/FooModule.html" target="_top">
<title>FooModule</title>
<polygon fill="#8dd3c7" stroke="black" points="105.83,-122 102.83,-126 81.83,-126 78.83,-122 24.17,-122 24.17,-86 105.83,-86 105.83,-122"/>
<text text-anchor="middle" x="65" y="-99.8" font-family="Times,serif" font-size="14.00">FooModule</text>
</a></g>
<!-- FooModule->AppModule -->
<g id="edge6" class="edge">
<title>FooModule->AppModule</title>
<path fill="none" stroke="black" d="M65,-122.29C65,-144.21 65,-178 65,-178 65,-178 355.06,-178 355.06,-178"/>
<polygon fill="black" stroke="black" points="355.06,-181.5 365.06,-178 355.06,-174.5 355.06,-181.5"/>
</g>
<!-- FooService -->
<g id="node9" class="node"><a xlink:href="../injectables/FooService.html" href="../injectables/FooService.html" target="_top">
<title>FooService</title>
<ellipse fill="#fdb462" stroke="black" cx="283" cy="-104" rx="55.03" ry="18"/>
<text text-anchor="middle" x="283" y="-99.8" font-family="Times,serif" font-size="14.00">FooService</text>
</a></g>
<!-- FooService->AppModule -->
<g id="edge8" class="edge">
<title>FooService->AppModule</title>
<path fill="none" stroke="black" d="M283,-122.03C283,-138.4 283,-160 283,-160 283,-160 355.02,-160 355.02,-160"/>
<polygon fill="black" stroke="black" points="355.02,-163.5 365.02,-160 355.02,-156.5 355.02,-163.5"/>
</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>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/ExampleTagComponent.html">ExampleTagComponent</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>
<section data-compodoc="block-relationships">
<h3>Relationships</h3>
<div class="row pt-3">
<div class="col-sm-6">
<h4>Used by</h4>
<p class="comment"><i>No results matching.</i></p>
</div>
<div class="col-sm-6">
<h4>Depends on</h4>
<ul class="list-unstyled relationships-list">
<li>
<code><a href="../modules/BarModule.html" target="_self" >BarModule</a></code>
</li>
<li>
<code><a href="../modules/FooModule.html" target="_self" >FooModule</a></code>
</li>
<li>
<code><a href="../components/BarComponent.html" target="_self" >BarComponent</a></code>
</li>
<li>
<code><a href="../components/ExampleTagComponent.html" target="_self" >ExampleTagComponent</a></code>
</li>
<li>
<code><a href="../components/FooComponent.html" target="_self" >FooComponent</a></code>
</li>
<li>
<code><a href="../directives/FooDirective.html" target="_self" >FooDirective</a></code>
</li>
<li>
<code><a href="../injectables/FooService.html" target="_self" >FooService</a></code>
</li>
</ul>
</div>
</div>
</section>
</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';
import { ExampleTagComponent } from './example-tag.component';
/**
* AppModule description
*
* See {@link BarComponent}
*/
@NgModule({
declarations: [FooDirective, FooComponent, BarComponent, ExampleTagComponent],
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');
var updateDarkModeSwitchOffset = function () {
var content = document.querySelector('.content');
var scrollbarWidth = 0;
if (content) {
scrollbarWidth = Math.max(0, content.offsetWidth - content.clientWidth);
}
document.documentElement.style.setProperty(
'--content-scrollbar-width',
scrollbarWidth + 'px'
);
};
updateDarkModeSwitchOffset();
requestAnimationFrame(updateDarkModeSwitchOffset);
window.addEventListener('resize', updateDarkModeSwitchOffset);
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 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>