carbon-components-angular
Version:
Next generation components
460 lines (394 loc) • 19.1 kB
HTML
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>carbon-components-angular 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">
<style>
footer.carbon {
position: absolute;
bottom: 0;
width: 100%;
z-index: 9999;
}
#root > div {
/*
* Subtracting the height of the footer to prevent
* overlaying the footer ontop of content
*/
height: calc(100vh - 48px);
}
</style>
</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>
<div class="navbar navbar-default navbar-fixed-top d-md-none p-0">
<div class="d-flex">
<a href="../" class="navbar-brand">carbon-components-angular 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" >UIShellModule</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="504pt" height="284pt"
viewBox="0.00 0.00 504.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 500,-280 500,4 -4,4"/>
<text text-anchor="start" x="227.01" y="-42.4" font-family="Times-12" font-weight="bold" font-size="14.00">Legend</text>
<polygon fill="#ffffb3" stroke="transparent" points="14,-10 14,-30 34,-30 34,-10 14,-10"/>
<text text-anchor="start" x="37.63" y="-15.4" font-family="Times-12" font-size="14.00">  Declarations</text>
<polygon fill="#8dd3c7" stroke="transparent" points="127,-10 127,-30 147,-30 147,-10 127,-10"/>
<text text-anchor="start" x="150.73" y="-15.4" font-family="Times-12" font-size="14.00">  Module</text>
<polygon fill="#80b1d3" stroke="transparent" points="213,-10 213,-30 233,-30 233,-10 213,-10"/>
<text text-anchor="start" x="236.78" y="-15.4" font-family="Times-12" font-size="14.00">  Bootstrap</text>
<polygon fill="#fdb462" stroke="transparent" points="310,-10 310,-30 330,-30 330,-10 310,-10"/>
<text text-anchor="start" x="333.67" y="-15.4" font-family="Times-12" font-size="14.00">  Providers</text>
<polygon fill="#fb8072" stroke="transparent" points="406,-10 406,-30 426,-30 426,-10 406,-10"/>
<text text-anchor="start" x="429.73" y="-15.4" font-family="Times-12" font-size="14.00">  Exports</text>
<g id="clust1" class="cluster">
<title>cluster_UIShellModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="13,-70 13,-268 483,-268 483,-70 13,-70"/>
</g>
<g id="clust4" class="cluster">
<title>cluster_UIShellModule_exports</title>
<polygon fill="none" stroke="black" points="67,-208 67,-260 429,-260 429,-208 67,-208"/>
</g>
<g id="clust3" class="cluster">
<title>cluster_UIShellModule_imports</title>
<polygon fill="none" stroke="black" points="21,-78 21,-130 475,-130 475,-78 21,-78"/>
</g>
<!-- HeaderModule -->
<g id="node1" class="node">
<title>HeaderModule</title>
<polygon fill="#8dd3c7" stroke="black" points="466.96,-122 463.96,-126 442.96,-126 439.96,-122 367.04,-122 367.04,-86 466.96,-86 466.96,-122"/>
<text text-anchor="middle" x="417" y="-99.8" font-family="Times,serif" font-size="14.00">HeaderModule</text>
</g>
<!-- UIShellModule -->
<g id="node5" class="node">
<title>UIShellModule</title>
<polygon fill="#8dd3c7" stroke="black" points="303.6,-187 300.6,-191 279.6,-191 276.6,-187 200.4,-187 200.4,-151 303.6,-151 303.6,-187"/>
<text text-anchor="middle" x="252" y="-164.8" font-family="Times,serif" font-size="14.00">UIShellModule</text>
</g>
<!-- HeaderModule->UIShellModule -->
<g id="edge1" class="edge">
<title>HeaderModule->UIShellModule</title>
<path fill="none" stroke="black" d="M393.88,-122.02C393.88,-139.37 393.88,-163 393.88,-163 393.88,-163 313.62,-163 313.62,-163"/>
<polygon fill="black" stroke="black" points="313.62,-159.5 303.62,-163 313.62,-166.5 313.62,-159.5"/>
</g>
<!-- I18nModule -->
<g id="node2" class="node">
<title>I18nModule</title>
<polygon fill="#8dd3c7" stroke="black" points="348.71,-122 345.71,-126 324.71,-126 321.71,-122 263.29,-122 263.29,-86 348.71,-86 348.71,-122"/>
<text text-anchor="middle" x="306" y="-99.8" font-family="Times,serif" font-size="14.00">I18nModule</text>
</g>
<!-- I18nModule->UIShellModule -->
<g id="edge2" class="edge">
<title>I18nModule->UIShellModule</title>
<path fill="none" stroke="black" d="M283.47,-122.11C283.47,-122.11 283.47,-140.99 283.47,-140.99"/>
<polygon fill="black" stroke="black" points="279.97,-140.99 283.47,-150.99 286.97,-140.99 279.97,-140.99"/>
</g>
<!-- PanelModule -->
<g id="node3" class="node">
<title>PanelModule</title>
<polygon fill="#8dd3c7" stroke="black" points="245.15,-122 242.15,-126 221.15,-126 218.15,-122 154.85,-122 154.85,-86 245.15,-86 245.15,-122"/>
<text text-anchor="middle" x="200" y="-99.8" font-family="Times,serif" font-size="14.00">PanelModule</text>
</g>
<!-- PanelModule->UIShellModule -->
<g id="edge3" class="edge">
<title>PanelModule->UIShellModule</title>
<path fill="none" stroke="black" d="M222.89,-122.11C222.89,-122.11 222.89,-140.99 222.89,-140.99"/>
<polygon fill="black" stroke="black" points="219.39,-140.99 222.89,-150.99 226.39,-140.99 219.39,-140.99"/>
</g>
<!-- SideNavModule -->
<g id="node4" class="node">
<title>SideNavModule</title>
<polygon fill="#8dd3c7" stroke="black" points="136.76,-122 133.76,-126 112.76,-126 109.76,-122 29.24,-122 29.24,-86 136.76,-86 136.76,-122"/>
<text text-anchor="middle" x="83" y="-99.8" font-family="Times,serif" font-size="14.00">SideNavModule</text>
</g>
<!-- SideNavModule->UIShellModule -->
<g id="edge4" class="edge">
<title>SideNavModule->UIShellModule</title>
<path fill="none" stroke="black" d="M106.12,-122.02C106.12,-139.37 106.12,-163 106.12,-163 106.12,-163 190.16,-163 190.16,-163"/>
<polygon fill="black" stroke="black" points="190.16,-166.5 200.16,-163 190.16,-159.5 190.16,-166.5"/>
</g>
<!-- HeaderModule -->
<g id="node6" class="node">
<title>HeaderModule </title>
<polygon fill="#fb8072" stroke="black" points="420.96,-252 317.04,-252 317.04,-216 420.96,-216 420.96,-252"/>
<text text-anchor="middle" x="369" y="-229.8" font-family="Times,serif" font-size="14.00">HeaderModule </text>
</g>
<!-- UIShellModule->HeaderModule -->
<g id="edge5" class="edge">
<title>UIShellModule->HeaderModule </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M303.72,-175C319.58,-175 332.94,-175 332.94,-175 332.94,-175 332.94,-205.98 332.94,-205.98"/>
<polygon fill="black" stroke="black" points="329.44,-205.98 332.94,-215.98 336.44,-205.98 329.44,-205.98"/>
</g>
<!-- PanelModule -->
<g id="node7" class="node">
<title>PanelModule </title>
<polygon fill="#fb8072" stroke="black" points="299.15,-252 204.85,-252 204.85,-216 299.15,-216 299.15,-252"/>
<text text-anchor="middle" x="252" y="-229.8" font-family="Times,serif" font-size="14.00">PanelModule </text>
</g>
<!-- UIShellModule->PanelModule -->
<g id="edge6" class="edge">
<title>UIShellModule->PanelModule </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M252,-187.11C252,-187.11 252,-205.99 252,-205.99"/>
<polygon fill="black" stroke="black" points="248.5,-205.99 252,-215.99 255.5,-205.99 248.5,-205.99"/>
</g>
<!-- SideNavModule -->
<g id="node8" class="node">
<title>SideNavModule </title>
<polygon fill="#fb8072" stroke="black" points="186.76,-252 75.24,-252 75.24,-216 186.76,-216 186.76,-252"/>
<text text-anchor="middle" x="131" y="-229.8" font-family="Times,serif" font-size="14.00">SideNavModule </text>
</g>
<!-- UIShellModule->SideNavModule -->
<g id="edge7" class="edge">
<title>UIShellModule->SideNavModule </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M200.02,-175C184.08,-175 170.65,-175 170.65,-175 170.65,-175 170.65,-205.98 170.65,-205.98"/>
<polygon fill="black" stroke="black" points="167.15,-205.98 170.65,-215.98 174.15,-205.98 167.15,-205.98"/>
</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>src/ui-shell/ui-shell.module.ts</code>
</p>
<div class="container-fluid module">
<div class="row">
<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/HeaderModule.html">HeaderModule</a>
</li>
<li class="list-group-item">
<a href="../modules/I18nModule.html">I18nModule</a>
</li>
<li class="list-group-item">
<a href="../modules/PanelModule.html">PanelModule</a>
</li>
<li class="list-group-item">
<a href="../modules/SideNavModule.html">SideNavModule</a>
</li>
</ul>
</div>
<div class="col-sm-3">
<h3>Exports<a href="https://angular.io/api/core/NgModule#exports" target="_blank" rel="noopener noreferrer"
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="../modules/HeaderModule.html">HeaderModule</a>
</li>
<li class="list-group-item">
<a href="../modules/PanelModule.html">PanelModule</a>
</li>
<li class="list-group-item">
<a href="../modules/SideNavModule.html">SideNavModule</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 } from "@angular/core";
import { CommonModule } from "@angular/common";
import { I18nModule } from "carbon-components-angular/i18n";
import { HeaderModule } from "./header/header.module";
import { SideNavModule } from "./sidenav/sidenav.module";
import { PanelModule } from "./panel/panel.module";
@NgModule({
imports: [
CommonModule,
I18nModule,
HeaderModule,
SideNavModule,
PanelModule
],
exports: [
HeaderModule,
SideNavModule,
PanelModule
]
})
export class UIShellModule { }
</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 = 'UIShellModule.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/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>
<footer class="carbon">
<dds-footer-container key="footer" disable-locale-button="true" size="micro" />
</footer>
<script
key="8"
type="module"
src="https://1.www.s81c.com/common/carbon-for-ibm-dotcom/tag/v1/latest/footer.min.js">
</script>
<!-- Storybook override -->
<script>
document.title = "Carbon Components Angular";
</script>
<script
src="//1.www.s81c.com/common/stats/ibm-common.js"
type="text/javascript"
async="async">
</script>
</body>
</html>