carbon-components-angular
Version:
Next generation components
475 lines (408 loc) • 19.7 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" >PanelModule</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_PanelModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="31.5,-70 31.5,-268 464.5,-268 464.5,-70 31.5,-70"/>
</g>
<g id="clust2" class="cluster">
<title>cluster_PanelModule_declarations</title>
<polygon fill="none" stroke="black" points="149.5,-78 149.5,-130 456.5,-130 456.5,-78 149.5,-78"/>
</g>
<g id="clust7" class="cluster">
<title>cluster_PanelModule_exports</title>
<polygon fill="none" stroke="black" points="90.5,-208 90.5,-260 404.5,-260 404.5,-208 90.5,-208"/>
</g>
<g id="clust6" class="cluster">
<title>cluster_PanelModule_imports</title>
<polygon fill="none" stroke="black" points="39.5,-78 39.5,-130 141.5,-130 141.5,-78 39.5,-78"/>
</g>
<!-- Panel -->
<g id="node1" class="node">
<title>Panel</title>
<polygon fill="#ffffb3" stroke="black" points="448.5,-122 394.5,-122 394.5,-86 448.5,-86 448.5,-122"/>
<text text-anchor="middle" x="421.5" y="-99.8" font-family="Times,serif" font-size="14.00">Panel</text>
</g>
<!-- PanelModule -->
<g id="node4" class="node">
<title>PanelModule</title>
<polygon fill="#8dd3c7" stroke="black" points="323.65,-187 320.65,-191 299.65,-191 296.65,-187 233.35,-187 233.35,-151 323.65,-151 323.65,-187"/>
<text text-anchor="middle" x="278.5" y="-164.8" font-family="Times,serif" font-size="14.00">PanelModule</text>
</g>
<!-- Panel->PanelModule -->
<g id="edge1" class="edge">
<title>Panel->PanelModule</title>
<path fill="none" stroke="black" d="M422.5,-122.02C422.5,-139.37 422.5,-163 422.5,-163 422.5,-163 333.67,-163 333.67,-163"/>
<polygon fill="black" stroke="black" points="333.67,-159.5 323.67,-163 333.67,-166.5 333.67,-159.5"/>
</g>
<!-- SwitcherList -->
<g id="node2" class="node">
<title>SwitcherList</title>
<polygon fill="#ffffb3" stroke="black" points="376.04,-122 288.96,-122 288.96,-86 376.04,-86 376.04,-122"/>
<text text-anchor="middle" x="332.5" y="-99.8" font-family="Times,serif" font-size="14.00">SwitcherList</text>
</g>
<!-- SwitcherList->PanelModule -->
<g id="edge2" class="edge">
<title>SwitcherList->PanelModule</title>
<path fill="none" stroke="black" d="M306.28,-122.11C306.28,-122.11 306.28,-140.99 306.28,-140.99"/>
<polygon fill="black" stroke="black" points="302.78,-140.99 306.28,-150.99 309.78,-140.99 302.78,-140.99"/>
</g>
<!-- SwitcherListItem -->
<g id="node3" class="node">
<title>SwitcherListItem</title>
<polygon fill="#ffffb3" stroke="black" points="271.2,-122 157.8,-122 157.8,-86 271.2,-86 271.2,-122"/>
<text text-anchor="middle" x="214.5" y="-99.8" font-family="Times,serif" font-size="14.00">SwitcherListItem</text>
</g>
<!-- SwitcherListItem->PanelModule -->
<g id="edge3" class="edge">
<title>SwitcherListItem->PanelModule</title>
<path fill="none" stroke="black" d="M252.14,-122.11C252.14,-122.11 252.14,-140.99 252.14,-140.99"/>
<polygon fill="black" stroke="black" points="248.64,-140.99 252.14,-150.99 255.64,-140.99 248.64,-140.99"/>
</g>
<!-- Panel -->
<g id="node6" class="node">
<title>Panel </title>
<polygon fill="#fb8072" stroke="black" points="396.5,-252 342.5,-252 342.5,-216 396.5,-216 396.5,-252"/>
<text text-anchor="middle" x="369.5" y="-229.8" font-family="Times,serif" font-size="14.00">Panel </text>
</g>
<!-- PanelModule->Panel -->
<g id="edge5" class="edge">
<title>PanelModule->Panel </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M323.67,-175C342.2,-175 359.38,-175 359.38,-175 359.38,-175 359.38,-205.98 359.38,-205.98"/>
<polygon fill="black" stroke="black" points="355.88,-205.98 359.38,-215.98 362.88,-205.98 355.88,-205.98"/>
</g>
<!-- SwitcherList -->
<g id="node7" class="node">
<title>SwitcherList </title>
<polygon fill="#fb8072" stroke="black" points="324.04,-252 232.96,-252 232.96,-216 324.04,-216 324.04,-252"/>
<text text-anchor="middle" x="278.5" y="-229.8" font-family="Times,serif" font-size="14.00">SwitcherList </text>
</g>
<!-- PanelModule->SwitcherList -->
<g id="edge6" class="edge">
<title>PanelModule->SwitcherList </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M278.5,-187.11C278.5,-187.11 278.5,-205.99 278.5,-205.99"/>
<polygon fill="black" stroke="black" points="275,-205.99 278.5,-215.99 282,-205.99 275,-205.99"/>
</g>
<!-- SwitcherListItem -->
<g id="node8" class="node">
<title>SwitcherListItem </title>
<polygon fill="#fb8072" stroke="black" points="214.7,-252 98.3,-252 98.3,-216 214.7,-216 214.7,-252"/>
<text text-anchor="middle" x="156.5" y="-229.8" font-family="Times,serif" font-size="14.00">SwitcherListItem </text>
</g>
<!-- PanelModule->SwitcherListItem -->
<g id="edge7" class="edge">
<title>PanelModule->SwitcherListItem </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M233.25,-175C209.95,-175 186.38,-175 186.38,-175 186.38,-175 186.38,-205.98 186.38,-205.98"/>
<polygon fill="black" stroke="black" points="182.88,-205.98 186.38,-215.98 189.88,-205.98 182.88,-205.98"/>
</g>
<!-- I18nModule -->
<g id="node5" class="node">
<title>I18nModule</title>
<polygon fill="#8dd3c7" stroke="black" points="133.21,-122 130.21,-126 109.21,-126 106.21,-122 47.79,-122 47.79,-86 133.21,-86 133.21,-122"/>
<text text-anchor="middle" x="90.5" y="-99.8" font-family="Times,serif" font-size="14.00">I18nModule</text>
</g>
<!-- I18nModule->PanelModule -->
<g id="edge4" class="edge">
<title>I18nModule->PanelModule</title>
<path fill="none" stroke="black" d="M115.63,-122.02C115.63,-139.37 115.63,-163 115.63,-163 115.63,-163 223.13,-163 223.13,-163"/>
<polygon fill="black" stroke="black" points="223.13,-166.5 233.13,-163 223.13,-159.5 223.13,-166.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>File</h3>
</p>
<p class="comment">
<code>src/ui-shell/panel/panel.module.ts</code>
</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/Panel.html">Panel</a>
</li>
<li class="list-group-item">
<a href="../components/SwitcherList.html">SwitcherList</a>
</li>
<li class="list-group-item">
<a href="../components/SwitcherListItem.html">SwitcherListItem</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/I18nModule.html">I18nModule</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="../components/Panel.html">Panel</a>
</li>
<li class="list-group-item">
<a href="../components/SwitcherList.html">SwitcherList</a>
</li>
<li class="list-group-item">
<a href="../components/SwitcherListItem.html">SwitcherListItem</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 { Panel } from "./panel.component";
import { SwitcherList } from "./switcher-list.component";
import { SwitcherListItem } from "./switcher-list-item.component";
export {
Panel,
SwitcherList,
SwitcherListItem
};
@NgModule({
declarations: [
Panel,
SwitcherList,
SwitcherListItem
],
imports: [CommonModule, I18nModule],
exports: [
Panel,
SwitcherList,
SwitcherListItem
]
})
export class PanelModule { }
</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 = 'PanelModule.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>