carbon-components-angular
Version:
Next generation components
530 lines (465 loc) • 23.2 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" >StructuredListModule</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="1099pt" height="396pt"
viewBox="0.00 0.00 1099.00 395.59" 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 391.59)">
<title>dependencies</title>
<polygon fill="white" stroke="transparent" points="-4,4 -4,-391.59 1095,-391.59 1095,4 -4,4"/>
<text text-anchor="start" x="524.51" y="-42.4" font-family="Times-12" font-weight="bold" font-size="14.00">Legend</text>
<polygon fill="#ffffb3" stroke="transparent" points="311.5,-10 311.5,-30 331.5,-30 331.5,-10 311.5,-10"/>
<text text-anchor="start" x="335.13" y="-15.4" font-family="Times-12" font-size="14.00">  Declarations</text>
<polygon fill="#8dd3c7" stroke="transparent" points="424.5,-10 424.5,-30 444.5,-30 444.5,-10 424.5,-10"/>
<text text-anchor="start" x="448.23" y="-15.4" font-family="Times-12" font-size="14.00">  Module</text>
<polygon fill="#80b1d3" stroke="transparent" points="510.5,-10 510.5,-30 530.5,-30 530.5,-10 510.5,-10"/>
<text text-anchor="start" x="534.28" y="-15.4" font-family="Times-12" font-size="14.00">  Bootstrap</text>
<polygon fill="#fdb462" stroke="transparent" points="607.5,-10 607.5,-30 627.5,-30 627.5,-10 607.5,-10"/>
<text text-anchor="start" x="631.17" y="-15.4" font-family="Times-12" font-size="14.00">  Providers</text>
<polygon fill="#fb8072" stroke="transparent" points="703.5,-10 703.5,-30 723.5,-30 723.5,-10 703.5,-10"/>
<text text-anchor="start" x="727.23" y="-15.4" font-family="Times-12" font-size="14.00">  Exports</text>
<g id="clust1" class="cluster">
<title>cluster_StructuredListModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="8,-70 8,-379.59 1083,-379.59 1083,-70 8,-70"/>
</g>
<g id="clust6" class="cluster">
<title>cluster_StructuredListModule_StructuredList_providers</title>
<polygon fill="none" stroke="black" points="409,-78 409,-241.59 1075,-241.59 1075,-78 409,-78"/>
</g>
<g id="clust2" class="cluster">
<title>cluster_StructuredListModule_declarations</title>
<polygon fill="none" stroke="black" points="124,-189.59 124,-241.59 401,-241.59 401,-189.59 124,-189.59"/>
</g>
<g id="clust8" class="cluster">
<title>cluster_StructuredListModule_exports</title>
<polygon fill="none" stroke="black" points="55,-319.59 55,-371.59 461,-371.59 461,-319.59 55,-319.59"/>
</g>
<g id="clust7" class="cluster">
<title>cluster_StructuredListModule_imports</title>
<polygon fill="none" stroke="black" points="16,-189.59 16,-241.59 116,-241.59 116,-189.59 16,-189.59"/>
</g>
<!-- ListColumn -->
<g id="node1" class="node">
<title>ListColumn</title>
<polygon fill="#ffffb3" stroke="black" points="393.4,-233.59 310.6,-233.59 310.6,-197.59 393.4,-197.59 393.4,-233.59"/>
<text text-anchor="middle" x="352" y="-211.39" font-family="Times,serif" font-size="14.00">ListColumn</text>
</g>
<!-- StructuredListModule -->
<g id="node5" class="node">
<title>StructuredListModule</title>
<polygon fill="#8dd3c7" stroke="black" points="322.64,-298.59 319.64,-302.59 298.64,-302.59 295.64,-298.59 183.36,-298.59 183.36,-262.59 322.64,-262.59 322.64,-298.59"/>
<text text-anchor="middle" x="253" y="-276.39" font-family="Times,serif" font-size="14.00">StructuredListModule</text>
</g>
<!-- ListColumn->StructuredListModule -->
<g id="edge1" class="edge">
<title>ListColumn->StructuredListModule</title>
<path fill="none" stroke="black" d="M316.69,-233.7C316.69,-233.7 316.69,-252.58 316.69,-252.58"/>
<polygon fill="black" stroke="black" points="313.19,-252.58 316.69,-262.58 320.19,-252.58 313.19,-252.58"/>
</g>
<!-- ListHeader -->
<g id="node2" class="node">
<title>ListHeader</title>
<polygon fill="#ffffb3" stroke="black" points="292.19,-233.59 213.81,-233.59 213.81,-197.59 292.19,-197.59 292.19,-233.59"/>
<text text-anchor="middle" x="253" y="-211.39" font-family="Times,serif" font-size="14.00">ListHeader</text>
</g>
<!-- ListHeader->StructuredListModule -->
<g id="edge2" class="edge">
<title>ListHeader->StructuredListModule</title>
<path fill="none" stroke="black" d="M253,-233.7C253,-233.7 253,-252.58 253,-252.58"/>
<polygon fill="black" stroke="black" points="249.5,-252.58 253,-262.58 256.5,-252.58 249.5,-252.58"/>
</g>
<!-- ListRow -->
<g id="node3" class="node">
<title>ListRow</title>
<polygon fill="#ffffb3" stroke="black" points="196.22,-233.59 131.78,-233.59 131.78,-197.59 196.22,-197.59 196.22,-233.59"/>
<text text-anchor="middle" x="164" y="-211.39" font-family="Times,serif" font-size="14.00">ListRow</text>
</g>
<!-- ListRow->StructuredListModule -->
<g id="edge3" class="edge">
<title>ListRow->StructuredListModule</title>
<path fill="none" stroke="black" d="M189.64,-233.7C189.64,-233.7 189.64,-252.58 189.64,-252.58"/>
<polygon fill="black" stroke="black" points="186.14,-252.58 189.64,-262.58 193.14,-252.58 186.14,-252.58"/>
</g>
<!-- StructuredList -->
<g id="node4" class="node">
<title>StructuredList</title>
<polygon fill="#ffffb3" stroke="black" points="651.09,-233.59 554.91,-233.59 554.91,-197.59 651.09,-197.59 651.09,-233.59"/>
<text text-anchor="middle" x="603" y="-211.39" font-family="Times,serif" font-size="14.00">StructuredList</text>
</g>
<!-- StructuredList->StructuredListModule -->
<g id="edge4" class="edge">
<title>StructuredList->StructuredListModule</title>
<path fill="none" stroke="black" d="M603,-233.61C603,-250.96 603,-274.59 603,-274.59 603,-274.59 332.99,-274.59 332.99,-274.59"/>
<polygon fill="black" stroke="black" points="332.99,-271.09 322.99,-274.59 332.99,-278.09 332.99,-271.09"/>
</g>
<!-- ListColumn -->
<g id="node8" class="node">
<title>ListColumn </title>
<polygon fill="#fb8072" stroke="black" points="453.4,-363.59 366.6,-363.59 366.6,-327.59 453.4,-327.59 453.4,-363.59"/>
<text text-anchor="middle" x="410" y="-341.39" font-family="Times,serif" font-size="14.00">ListColumn </text>
</g>
<!-- StructuredListModule->ListColumn -->
<g id="edge7" class="edge">
<title>StructuredListModule->ListColumn </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M322.88,-286.59C352.42,-286.59 380.12,-286.59 380.12,-286.59 380.12,-286.59 380.12,-317.57 380.12,-317.57"/>
<polygon fill="black" stroke="black" points="376.63,-317.57 380.12,-327.57 383.63,-317.57 376.63,-317.57"/>
</g>
<!-- ListHeader -->
<g id="node9" class="node">
<title>ListHeader </title>
<polygon fill="#fb8072" stroke="black" points="348.69,-363.59 267.31,-363.59 267.31,-327.59 348.69,-327.59 348.69,-363.59"/>
<text text-anchor="middle" x="308" y="-341.39" font-family="Times,serif" font-size="14.00">ListHeader </text>
</g>
<!-- StructuredListModule->ListHeader -->
<g id="edge8" class="edge">
<title>StructuredListModule->ListHeader </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M294.99,-298.7C294.99,-298.7 294.99,-317.58 294.99,-317.58"/>
<polygon fill="black" stroke="black" points="291.49,-317.58 294.99,-327.58 298.49,-317.58 291.49,-317.58"/>
</g>
<!-- ListRow -->
<g id="node10" class="node">
<title>ListRow </title>
<polygon fill="#fb8072" stroke="black" points="248.72,-363.59 181.28,-363.59 181.28,-327.59 248.72,-327.59 248.72,-363.59"/>
<text text-anchor="middle" x="215" y="-341.39" font-family="Times,serif" font-size="14.00">ListRow </text>
</g>
<!-- StructuredListModule->ListRow -->
<g id="edge9" class="edge">
<title>StructuredListModule->ListRow </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M216.02,-298.7C216.02,-298.7 216.02,-317.58 216.02,-317.58"/>
<polygon fill="black" stroke="black" points="212.52,-317.58 216.02,-327.58 219.52,-317.58 212.52,-317.58"/>
</g>
<!-- StructuredList -->
<g id="node11" class="node">
<title>StructuredList </title>
<polygon fill="#fb8072" stroke="black" points="162.59,-363.59 63.41,-363.59 63.41,-327.59 162.59,-327.59 162.59,-363.59"/>
<text text-anchor="middle" x="113" y="-341.39" font-family="Times,serif" font-size="14.00">StructuredList </text>
</g>
<!-- StructuredListModule->StructuredList -->
<g id="edge10" class="edge">
<title>StructuredListModule->StructuredList </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M183.11,-286.59C163.46,-286.59 147.34,-286.59 147.34,-286.59 147.34,-286.59 147.34,-317.57 147.34,-317.57"/>
<polygon fill="black" stroke="black" points="143.84,-317.57 147.34,-327.57 150.84,-317.57 143.84,-317.57"/>
</g>
<!-- {
   provide: NG_VALUE_ACCESSOR, useExisting: StructuredList, multi: true
} -->
<g id="node6" class="node">
<title>{
   provide: NG_VALUE_ACCESSOR, useExisting: StructuredList, multi: true
}</title>
<ellipse fill="#fdb462" stroke="black" cx="742" cy="-127.3" rx="325.07" ry="41.09"/>
<text text-anchor="middle" x="742" y="-139.9" font-family="Times,serif" font-size="14.00">{</text>
<text text-anchor="middle" x="742" y="-123.1" font-family="Times,serif" font-size="14.00">    provide: NG_VALUE_ACCESSOR, useExisting: StructuredList, multi: true</text>
<text text-anchor="middle" x="742" y="-106.3" font-family="Times,serif" font-size="14.00">}</text>
</g>
<!-- {
   provide: NG_VALUE_ACCESSOR, useExisting: StructuredList, multi: true
}->StructuredList -->
<g id="edge5" class="edge">
<title>{
   provide: NG_VALUE_ACCESSOR, useExisting: StructuredList, multi: true
}->StructuredList</title>
<path fill="none" stroke="black" d="M603,-164.74C603,-164.74 603,-187.34 603,-187.34"/>
<polygon fill="black" stroke="black" points="599.5,-187.34 603,-197.34 606.5,-187.34 599.5,-187.34"/>
</g>
<!-- IconModule -->
<g id="node7" class="node">
<title>IconModule</title>
<polygon fill="#8dd3c7" stroke="black" points="108.43,-233.59 105.43,-237.59 84.43,-237.59 81.43,-233.59 23.57,-233.59 23.57,-197.59 108.43,-197.59 108.43,-233.59"/>
<text text-anchor="middle" x="66" y="-211.39" font-family="Times,serif" font-size="14.00">IconModule</text>
</g>
<!-- IconModule->StructuredListModule -->
<g id="edge6" class="edge">
<title>IconModule->StructuredListModule</title>
<path fill="none" stroke="black" d="M85.71,-233.61C85.71,-250.96 85.71,-274.59 85.71,-274.59 85.71,-274.59 173.02,-274.59 173.02,-274.59"/>
<polygon fill="black" stroke="black" points="173.02,-278.09 183.02,-274.59 173.02,-271.09 173.02,-278.09"/>
</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/structured-list/structured-list.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/ListColumn.html">ListColumn</a>
</li>
<li class="list-group-item">
<a href="../components/ListHeader.html">ListHeader</a>
</li>
<li class="list-group-item">
<a href="../components/ListRow.html">ListRow</a>
</li>
<li class="list-group-item">
<a href="../components/StructuredList.html">StructuredList</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/IconModule.html">IconModule</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/ListColumn.html">ListColumn</a>
</li>
<li class="list-group-item">
<a href="../components/ListHeader.html">ListHeader</a>
</li>
<li class="list-group-item">
<a href="../components/ListRow.html">ListRow</a>
</li>
<li class="list-group-item">
<a href="../components/StructuredList.html">StructuredList</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 { StructuredList } from "./structured-list.component";
import { ListRow } from "./list-row.component";
import { ListHeader } from "./list-header.component";
import { ListColumn } from "./list-column.component";
import { IconModule } from "carbon-components-angular/icon";
@NgModule({
declarations: [
StructuredList,
ListRow,
ListHeader,
ListColumn
],
exports: [
StructuredList,
ListRow,
ListHeader,
ListColumn
],
imports: [
CommonModule,
IconModule
]
})
export class StructuredListModule { }
</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 = 'StructuredListModule.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>