carbon-components-angular
Version:
Next generation components
409 lines (345 loc) • 16.5 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" >SkeletonModule</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_SkeletonModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="109,-70 109,-268 387,-268 387,-70 109,-70"/>
</g>
<g id="clust2" class="cluster">
<title>cluster_SkeletonModule_declarations</title>
<polygon fill="none" stroke="black" points="118,-78 118,-130 374,-130 374,-78 118,-78"/>
</g>
<g id="clust6" class="cluster">
<title>cluster_SkeletonModule_exports</title>
<polygon fill="none" stroke="black" points="117,-208 117,-260 379,-260 379,-208 117,-208"/>
</g>
<!-- SkeletonPlaceholder -->
<g id="node1" class="node">
<title>SkeletonPlaceholder</title>
<polygon fill="#ffffb3" stroke="black" points="365.58,-122 234.42,-122 234.42,-86 365.58,-86 365.58,-122"/>
<text text-anchor="middle" x="300" y="-99.8" font-family="Times,serif" font-size="14.00">SkeletonPlaceholder</text>
</g>
<!-- SkeletonModule -->
<g id="node3" class="node">
<title>SkeletonModule</title>
<polygon fill="#8dd3c7" stroke="black" points="290.04,-187 287.04,-191 266.04,-191 263.04,-187 181.96,-187 181.96,-151 290.04,-151 290.04,-187"/>
<text text-anchor="middle" x="236" y="-164.8" font-family="Times,serif" font-size="14.00">SkeletonModule</text>
</g>
<!-- SkeletonPlaceholder->SkeletonModule -->
<g id="edge1" class="edge">
<title>SkeletonPlaceholder->SkeletonModule</title>
<path fill="none" stroke="black" d="M262.37,-122.11C262.37,-122.11 262.37,-140.99 262.37,-140.99"/>
<polygon fill="black" stroke="black" points="258.87,-140.99 262.37,-150.99 265.87,-140.99 258.87,-140.99"/>
</g>
<!-- SkeletonText -->
<g id="node2" class="node">
<title>SkeletonText</title>
<polygon fill="#ffffb3" stroke="black" points="216.15,-122 125.85,-122 125.85,-86 216.15,-86 216.15,-122"/>
<text text-anchor="middle" x="171" y="-99.8" font-family="Times,serif" font-size="14.00">SkeletonText</text>
</g>
<!-- SkeletonText->SkeletonModule -->
<g id="edge2" class="edge">
<title>SkeletonText->SkeletonModule</title>
<path fill="none" stroke="black" d="M199.03,-122.11C199.03,-122.11 199.03,-140.99 199.03,-140.99"/>
<polygon fill="black" stroke="black" points="195.53,-140.99 199.03,-150.99 202.53,-140.99 195.53,-140.99"/>
</g>
<!-- SkeletonPlaceholder -->
<g id="node4" class="node">
<title>SkeletonPlaceholder </title>
<polygon fill="#fb8072" stroke="black" points="371.08,-252 236.92,-252 236.92,-216 371.08,-216 371.08,-252"/>
<text text-anchor="middle" x="304" y="-229.8" font-family="Times,serif" font-size="14.00">SkeletonPlaceholder </text>
</g>
<!-- SkeletonModule->SkeletonPlaceholder -->
<g id="edge3" class="edge">
<title>SkeletonModule->SkeletonPlaceholder </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M263.49,-187.11C263.49,-187.11 263.49,-205.99 263.49,-205.99"/>
<polygon fill="black" stroke="black" points="259.99,-205.99 263.49,-215.99 266.99,-205.99 259.99,-205.99"/>
</g>
<!-- SkeletonText -->
<g id="node5" class="node">
<title>SkeletonText </title>
<polygon fill="#fb8072" stroke="black" points="219.15,-252 124.85,-252 124.85,-216 219.15,-216 219.15,-252"/>
<text text-anchor="middle" x="172" y="-229.8" font-family="Times,serif" font-size="14.00">SkeletonText </text>
</g>
<!-- SkeletonModule->SkeletonText -->
<g id="edge4" class="edge">
<title>SkeletonModule->SkeletonText </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M200.4,-187.11C200.4,-187.11 200.4,-205.99 200.4,-205.99"/>
<polygon fill="black" stroke="black" points="196.9,-205.99 200.4,-215.99 203.9,-205.99 196.9,-205.99"/>
</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/skeleton/skeleton.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/SkeletonPlaceholder.html">SkeletonPlaceholder</a>
</li>
<li class="list-group-item">
<a href="../components/SkeletonText.html">SkeletonText</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/SkeletonPlaceholder.html">SkeletonPlaceholder</a>
</li>
<li class="list-group-item">
<a href="../components/SkeletonText.html">SkeletonText</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 { SkeletonPlaceholder } from "./skeleton-placeholder.component";
import { SkeletonText } from "./skeleton-text.component";
import { NgModule } from "@angular/core";
import { CommonModule } from "@angular/common";
@NgModule({
declarations: [
SkeletonPlaceholder,
SkeletonText
],
exports: [
SkeletonPlaceholder,
SkeletonText
],
imports: [
CommonModule
]
})
export class SkeletonModule { }
</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 = 'SkeletonModule.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>