carbon-components-angular
Version:
Next generation components
486 lines (420 loc) • 20.4 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" >ButtonModule</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="544pt" height="284pt"
viewBox="0.00 0.00 544.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 540,-280 540,4 -4,4"/>
<text text-anchor="start" x="247.01" y="-42.4" font-family="Times-12" font-weight="bold" font-size="14.00">Legend</text>
<polygon fill="#ffffb3" stroke="transparent" points="34,-10 34,-30 54,-30 54,-10 34,-10"/>
<text text-anchor="start" x="57.63" y="-15.4" font-family="Times-12" font-size="14.00">  Declarations</text>
<polygon fill="#8dd3c7" stroke="transparent" points="147,-10 147,-30 167,-30 167,-10 147,-10"/>
<text text-anchor="start" x="170.73" y="-15.4" font-family="Times-12" font-size="14.00">  Module</text>
<polygon fill="#80b1d3" stroke="transparent" points="233,-10 233,-30 253,-30 253,-10 233,-10"/>
<text text-anchor="start" x="256.78" y="-15.4" font-family="Times-12" font-size="14.00">  Bootstrap</text>
<polygon fill="#fdb462" stroke="transparent" points="330,-10 330,-30 350,-30 350,-10 330,-10"/>
<text text-anchor="start" x="353.67" y="-15.4" font-family="Times-12" font-size="14.00">  Providers</text>
<polygon fill="#fb8072" stroke="transparent" points="426,-10 426,-30 446,-30 446,-10 426,-10"/>
<text text-anchor="start" x="449.73" y="-15.4" font-family="Times-12" font-size="14.00">  Exports</text>
<g id="clust1" class="cluster">
<title>cluster_ButtonModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="8,-70 8,-268 528,-268 528,-70 8,-70"/>
</g>
<g id="clust2" class="cluster">
<title>cluster_ButtonModule_declarations</title>
<polygon fill="none" stroke="black" points="140,-78 140,-130 520,-130 520,-78 140,-78"/>
</g>
<g id="clust8" class="cluster">
<title>cluster_ButtonModule_exports</title>
<polygon fill="none" stroke="black" points="134,-208 134,-260 402,-260 402,-208 134,-208"/>
</g>
<g id="clust7" class="cluster">
<title>cluster_ButtonModule_imports</title>
<polygon fill="none" stroke="black" points="16,-78 16,-130 132,-130 132,-78 16,-78"/>
</g>
<!-- BaseIconButton -->
<g id="node1" class="node">
<title>BaseIconButton</title>
<polygon fill="#ffffb3" stroke="black" points="512.2,-122 405.8,-122 405.8,-86 512.2,-86 512.2,-122"/>
<text text-anchor="middle" x="459" y="-99.8" font-family="Times,serif" font-size="14.00">BaseIconButton</text>
</g>
<!-- ButtonModule -->
<g id="node5" class="node">
<title>ButtonModule</title>
<polygon fill="#8dd3c7" stroke="black" points="328.67,-187 325.67,-191 304.67,-191 301.67,-187 231.33,-187 231.33,-151 328.67,-151 328.67,-187"/>
<text text-anchor="middle" x="280" y="-164.8" font-family="Times,serif" font-size="14.00">ButtonModule</text>
</g>
<!-- BaseIconButton->ButtonModule -->
<g id="edge1" class="edge">
<title>BaseIconButton->ButtonModule</title>
<path fill="none" stroke="black" d="M459,-122.11C459,-141.34 459,-169 459,-169 459,-169 338.91,-169 338.91,-169"/>
<polygon fill="black" stroke="black" points="338.91,-165.5 328.91,-169 338.91,-172.5 338.91,-165.5"/>
</g>
<!-- Button -->
<g id="node2" class="node">
<title>Button</title>
<polygon fill="#ffffb3" stroke="black" points="388.12,-122 333.88,-122 333.88,-86 388.12,-86 388.12,-122"/>
<text text-anchor="middle" x="361" y="-99.8" font-family="Times,serif" font-size="14.00">Button</text>
</g>
<!-- Button->ButtonModule -->
<g id="edge2" class="edge">
<title>Button->ButtonModule</title>
<path fill="none" stroke="black" d="M333.79,-104C327.4,-104 322.42,-104 322.42,-104 322.42,-104 322.42,-140.89 322.42,-140.89"/>
<polygon fill="black" stroke="black" points="318.92,-140.89 322.42,-150.89 325.92,-140.89 318.92,-140.89"/>
</g>
<!-- ButtonSet -->
<g id="node3" class="node">
<title>ButtonSet</title>
<polygon fill="#ffffb3" stroke="black" points="316.01,-122 243.99,-122 243.99,-86 316.01,-86 316.01,-122"/>
<text text-anchor="middle" x="280" y="-99.8" font-family="Times,serif" font-size="14.00">ButtonSet</text>
</g>
<!-- ButtonSet->ButtonModule -->
<g id="edge3" class="edge">
<title>ButtonSet->ButtonModule</title>
<path fill="none" stroke="black" d="M280,-122.11C280,-122.11 280,-140.99 280,-140.99"/>
<polygon fill="black" stroke="black" points="276.5,-140.99 280,-150.99 283.5,-140.99 276.5,-140.99"/>
</g>
<!-- IconButton -->
<g id="node4" class="node">
<title>IconButton</title>
<polygon fill="#ffffb3" stroke="black" points="226.49,-122 147.51,-122 147.51,-86 226.49,-86 226.49,-122"/>
<text text-anchor="middle" x="187" y="-99.8" font-family="Times,serif" font-size="14.00">IconButton</text>
</g>
<!-- IconButton->ButtonModule -->
<g id="edge4" class="edge">
<title>IconButton->ButtonModule</title>
<path fill="none" stroke="black" d="M226.85,-104C233.12,-104 237.58,-104 237.58,-104 237.58,-104 237.58,-140.89 237.58,-140.89"/>
<polygon fill="black" stroke="black" points="234.08,-140.89 237.58,-150.89 241.08,-140.89 234.08,-140.89"/>
</g>
<!-- Button -->
<g id="node7" class="node">
<title>Button </title>
<polygon fill="#fb8072" stroke="black" points="393.62,-252 336.38,-252 336.38,-216 393.62,-216 393.62,-252"/>
<text text-anchor="middle" x="365" y="-229.8" font-family="Times,serif" font-size="14.00">Button </text>
</g>
<!-- ButtonModule->Button -->
<g id="edge6" class="edge">
<title>ButtonModule->Button </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M323.29,-187.11C323.29,-206.34 323.29,-234 323.29,-234 323.29,-234 326.03,-234 326.03,-234"/>
<polygon fill="black" stroke="black" points="326.03,-237.5 336.03,-234 326.03,-230.5 326.03,-237.5"/>
</g>
<!-- ButtonSet -->
<g id="node8" class="node">
<title>ButtonSet </title>
<polygon fill="#fb8072" stroke="black" points="317.51,-252 242.49,-252 242.49,-216 317.51,-216 317.51,-252"/>
<text text-anchor="middle" x="280" y="-229.8" font-family="Times,serif" font-size="14.00">ButtonSet </text>
</g>
<!-- ButtonModule->ButtonSet -->
<g id="edge7" class="edge">
<title>ButtonModule->ButtonSet </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M280,-187.11C280,-187.11 280,-205.99 280,-205.99"/>
<polygon fill="black" stroke="black" points="276.5,-205.99 280,-215.99 283.5,-205.99 276.5,-205.99"/>
</g>
<!-- IconButton -->
<g id="node9" class="node">
<title>IconButton </title>
<polygon fill="#fb8072" stroke="black" points="224.49,-252 141.51,-252 141.51,-216 224.49,-216 224.49,-252"/>
<text text-anchor="middle" x="183" y="-229.8" font-family="Times,serif" font-size="14.00">IconButton </text>
</g>
<!-- ButtonModule->IconButton -->
<g id="edge8" class="edge">
<title>ButtonModule->IconButton </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M236.71,-187.11C236.71,-206.34 236.71,-234 236.71,-234 236.71,-234 234.25,-234 234.25,-234"/>
<polygon fill="black" stroke="black" points="234.25,-230.5 224.25,-234 234.25,-237.5 234.25,-230.5"/>
</g>
<!-- TooltipModule -->
<g id="node6" class="node">
<title>TooltipModule</title>
<polygon fill="#8dd3c7" stroke="black" points="124.27,-122 121.27,-126 100.27,-126 97.27,-122 23.73,-122 23.73,-86 124.27,-86 124.27,-122"/>
<text text-anchor="middle" x="74" y="-99.8" font-family="Times,serif" font-size="14.00">TooltipModule</text>
</g>
<!-- TooltipModule->ButtonModule -->
<g id="edge5" class="edge">
<title>TooltipModule->ButtonModule</title>
<path fill="none" stroke="black" d="M74,-122.11C74,-141.34 74,-169 74,-169 74,-169 221.18,-169 221.18,-169"/>
<polygon fill="black" stroke="black" points="221.18,-172.5 231.18,-169 221.18,-165.5 221.18,-172.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/button/button.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/BaseIconButton.html">BaseIconButton</a>
</li>
<li class="list-group-item">
<a href="../directives/Button.html">Button</a>
</li>
<li class="list-group-item">
<a href="../components/ButtonSet.html">ButtonSet</a>
</li>
<li class="list-group-item">
<a href="../components/IconButton.html">IconButton</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/TooltipModule.html">TooltipModule</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="../directives/Button.html">Button</a>
</li>
<li class="list-group-item">
<a href="../components/ButtonSet.html">ButtonSet</a>
</li>
<li class="list-group-item">
<a href="../components/IconButton.html">IconButton</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 { Button } from "./button.directive";
import { ButtonSet } from "./button-set.component";
import { BaseIconButton } from "./base-icon-button.component";
import { IconButton } from "./icon-button.component";
import { TooltipModule } from "carbon-components-angular/tooltip";
@NgModule({
declarations: [
Button,
ButtonSet,
BaseIconButton,
IconButton
],
exports: [
Button,
ButtonSet,
IconButton
],
imports: [CommonModule, TooltipModule]
})
export class ButtonModule { }
</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 = 'ButtonModule.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>