carbon-components-angular
Version:
Next generation components
535 lines (469 loc) • 23.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" >ToggletipModule</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="763pt" height="284pt"
viewBox="0.00 0.00 763.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 759,-280 759,4 -4,4"/>
<text text-anchor="start" x="356.51" y="-42.4" font-family="Times-12" font-weight="bold" font-size="14.00">Legend</text>
<polygon fill="#ffffb3" stroke="transparent" points="143.5,-10 143.5,-30 163.5,-30 163.5,-10 143.5,-10"/>
<text text-anchor="start" x="167.13" y="-15.4" font-family="Times-12" font-size="14.00">  Declarations</text>
<polygon fill="#8dd3c7" stroke="transparent" points="256.5,-10 256.5,-30 276.5,-30 276.5,-10 256.5,-10"/>
<text text-anchor="start" x="280.23" y="-15.4" font-family="Times-12" font-size="14.00">  Module</text>
<polygon fill="#80b1d3" stroke="transparent" points="342.5,-10 342.5,-30 362.5,-30 362.5,-10 342.5,-10"/>
<text text-anchor="start" x="366.28" y="-15.4" font-family="Times-12" font-size="14.00">  Bootstrap</text>
<polygon fill="#fdb462" stroke="transparent" points="439.5,-10 439.5,-30 459.5,-30 459.5,-10 439.5,-10"/>
<text text-anchor="start" x="463.17" y="-15.4" font-family="Times-12" font-size="14.00">  Providers</text>
<polygon fill="#fb8072" stroke="transparent" points="535.5,-10 535.5,-30 555.5,-30 555.5,-10 535.5,-10"/>
<text text-anchor="start" x="559.23" y="-15.4" font-family="Times-12" font-size="14.00">  Exports</text>
<g id="clust1" class="cluster">
<title>cluster_ToggletipModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="8,-70 8,-268 747,-268 747,-70 8,-70"/>
</g>
<g id="clust9" class="cluster">
<title>cluster_ToggletipModule_exports</title>
<polygon fill="none" stroke="black" points="72,-208 72,-260 682,-260 682,-208 72,-208"/>
</g>
<g id="clust2" class="cluster">
<title>cluster_ToggletipModule_declarations</title>
<polygon fill="none" stroke="black" points="146,-78 146,-130 739,-130 739,-78 146,-78"/>
</g>
<g id="clust8" class="cluster">
<title>cluster_ToggletipModule_imports</title>
<polygon fill="none" stroke="black" points="16,-78 16,-130 138,-130 138,-78 16,-78"/>
</g>
<!-- Toggletip -->
<g id="node1" class="node">
<title>Toggletip</title>
<polygon fill="#ffffb3" stroke="black" points="731.44,-122 660.56,-122 660.56,-86 731.44,-86 731.44,-122"/>
<text text-anchor="middle" x="696" y="-99.8" font-family="Times,serif" font-size="14.00">Toggletip</text>
</g>
<!-- ToggletipModule -->
<g id="node6" class="node">
<title>ToggletipModule</title>
<polygon fill="#8dd3c7" stroke="black" points="452.99,-187 449.99,-191 428.99,-191 425.99,-187 339.01,-187 339.01,-151 452.99,-151 452.99,-187"/>
<text text-anchor="middle" x="396" y="-164.8" font-family="Times,serif" font-size="14.00">ToggletipModule</text>
</g>
<!-- Toggletip->ToggletipModule -->
<g id="edge1" class="edge">
<title>Toggletip->ToggletipModule</title>
<path fill="none" stroke="black" d="M667.38,-122.27C667.38,-140.56 667.38,-166 667.38,-166 667.38,-166 463.22,-166 463.22,-166"/>
<polygon fill="black" stroke="black" points="463.22,-162.5 453.22,-166 463.22,-169.5 463.22,-162.5"/>
</g>
<!-- ToggletipAction -->
<g id="node2" class="node">
<title>ToggletipAction</title>
<polygon fill="#ffffb3" stroke="black" points="643.04,-122 534.96,-122 534.96,-86 643.04,-86 643.04,-122"/>
<text text-anchor="middle" x="589" y="-99.8" font-family="Times,serif" font-size="14.00">ToggletipAction</text>
</g>
<!-- ToggletipAction->ToggletipModule -->
<g id="edge2" class="edge">
<title>ToggletipAction->ToggletipModule</title>
<path fill="none" stroke="black" d="M558.38,-122.01C558.38,-138.05 558.38,-159 558.38,-159 558.38,-159 463.25,-159 463.25,-159"/>
<polygon fill="black" stroke="black" points="463.25,-155.5 453.25,-159 463.25,-162.5 463.25,-155.5"/>
</g>
<!-- ToggletipButton -->
<g id="node3" class="node">
<title>ToggletipButton</title>
<polygon fill="#ffffb3" stroke="black" points="516.06,-122 407.94,-122 407.94,-86 516.06,-86 516.06,-122"/>
<text text-anchor="middle" x="462" y="-99.8" font-family="Times,serif" font-size="14.00">ToggletipButton</text>
</g>
<!-- ToggletipButton->ToggletipModule -->
<g id="edge3" class="edge">
<title>ToggletipButton->ToggletipModule</title>
<path fill="none" stroke="black" d="M430.36,-122.11C430.36,-122.11 430.36,-140.99 430.36,-140.99"/>
<polygon fill="black" stroke="black" points="426.86,-140.99 430.36,-150.99 433.86,-140.99 426.86,-140.99"/>
</g>
<!-- ToggletipContent -->
<g id="node4" class="node">
<title>ToggletipContent</title>
<polygon fill="#ffffb3" stroke="black" points="389.27,-122 274.73,-122 274.73,-86 389.27,-86 389.27,-122"/>
<text text-anchor="middle" x="332" y="-99.8" font-family="Times,serif" font-size="14.00">ToggletipContent</text>
</g>
<!-- ToggletipContent->ToggletipModule -->
<g id="edge4" class="edge">
<title>ToggletipContent->ToggletipModule</title>
<path fill="none" stroke="black" d="M364.2,-122.11C364.2,-122.11 364.2,-140.99 364.2,-140.99"/>
<polygon fill="black" stroke="black" points="360.7,-140.99 364.2,-150.99 367.7,-140.99 360.7,-140.99"/>
</g>
<!-- ToggletipLabel -->
<g id="node5" class="node">
<title>ToggletipLabel</title>
<polygon fill="#ffffb3" stroke="black" points="256.31,-122 153.69,-122 153.69,-86 256.31,-86 256.31,-122"/>
<text text-anchor="middle" x="205" y="-99.8" font-family="Times,serif" font-size="14.00">ToggletipLabel</text>
</g>
<!-- ToggletipLabel->ToggletipModule -->
<g id="edge5" class="edge">
<title>ToggletipLabel->ToggletipModule</title>
<path fill="none" stroke="black" d="M230.01,-122.01C230.01,-138.05 230.01,-159 230.01,-159 230.01,-159 328.88,-159 328.88,-159"/>
<polygon fill="black" stroke="black" points="328.88,-162.5 338.88,-159 328.88,-155.5 328.88,-162.5"/>
</g>
<!-- Toggletip -->
<g id="node8" class="node">
<title>Toggletip </title>
<polygon fill="#fb8072" stroke="black" points="673.94,-252 600.06,-252 600.06,-216 673.94,-216 673.94,-252"/>
<text text-anchor="middle" x="637" y="-229.8" font-family="Times,serif" font-size="14.00">Toggletip </text>
</g>
<!-- ToggletipModule->Toggletip -->
<g id="edge7" class="edge">
<title>ToggletipModule->Toggletip </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M453.23,-173C520.08,-173 621.65,-173 621.65,-173 621.65,-173 621.65,-205.7 621.65,-205.7"/>
<polygon fill="black" stroke="black" points="618.15,-205.7 621.65,-215.7 625.15,-205.7 618.15,-205.7"/>
</g>
<!-- ToggletipAction -->
<g id="node9" class="node">
<title>ToggletipAction </title>
<polygon fill="#fb8072" stroke="black" points="582.04,-252 469.96,-252 469.96,-216 582.04,-216 582.04,-252"/>
<text text-anchor="middle" x="526" y="-229.8" font-family="Times,serif" font-size="14.00">ToggletipAction </text>
</g>
<!-- ToggletipModule->ToggletipAction -->
<g id="edge8" class="edge">
<title>ToggletipModule->ToggletipAction </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M453.06,-180C474.2,-180 493.13,-180 493.13,-180 493.13,-180 493.13,-205.72 493.13,-205.72"/>
<polygon fill="black" stroke="black" points="489.63,-205.72 493.13,-215.72 496.63,-205.72 489.63,-205.72"/>
</g>
<!-- ToggletipButton -->
<g id="node10" class="node">
<title>ToggletipButton </title>
<polygon fill="#fb8072" stroke="black" points="452.06,-252 339.94,-252 339.94,-216 452.06,-216 452.06,-252"/>
<text text-anchor="middle" x="396" y="-229.8" font-family="Times,serif" font-size="14.00">ToggletipButton </text>
</g>
<!-- ToggletipModule->ToggletipButton -->
<g id="edge9" class="edge">
<title>ToggletipModule->ToggletipButton </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M396,-187.11C396,-187.11 396,-205.99 396,-205.99"/>
<polygon fill="black" stroke="black" points="392.5,-205.99 396,-215.99 399.5,-205.99 392.5,-205.99"/>
</g>
<!-- ToggletipContent -->
<g id="node11" class="node">
<title>ToggletipContent </title>
<polygon fill="#fb8072" stroke="black" points="322.27,-252 203.73,-252 203.73,-216 322.27,-216 322.27,-252"/>
<text text-anchor="middle" x="263" y="-229.8" font-family="Times,serif" font-size="14.00">ToggletipContent </text>
</g>
<!-- ToggletipModule->ToggletipContent -->
<g id="edge10" class="edge">
<title>ToggletipModule->ToggletipContent </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M338.93,-180C317.56,-180 298.38,-180 298.38,-180 298.38,-180 298.38,-205.72 298.38,-205.72"/>
<polygon fill="black" stroke="black" points="294.88,-205.72 298.38,-215.72 301.88,-205.72 294.88,-205.72"/>
</g>
<!-- ToggletipLabel -->
<g id="node12" class="node">
<title>ToggletipLabel </title>
<polygon fill="#fb8072" stroke="black" points="185.81,-252 80.19,-252 80.19,-216 185.81,-216 185.81,-252"/>
<text text-anchor="middle" x="133" y="-229.8" font-family="Times,serif" font-size="14.00">ToggletipLabel </text>
</g>
<!-- ToggletipModule->ToggletipLabel -->
<g id="edge11" class="edge">
<title>ToggletipModule->ToggletipLabel </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M338.94,-173C271.95,-173 169.88,-173 169.88,-173 169.88,-173 169.88,-205.7 169.88,-205.7"/>
<polygon fill="black" stroke="black" points="166.38,-205.7 169.88,-215.7 173.38,-205.7 166.38,-205.7"/>
</g>
<!-- PopoverModule -->
<g id="node7" class="node">
<title>PopoverModule</title>
<polygon fill="#8dd3c7" stroke="black" points="130.21,-122 127.21,-126 106.21,-126 103.21,-122 23.79,-122 23.79,-86 130.21,-86 130.21,-122"/>
<text text-anchor="middle" x="77" y="-99.8" font-family="Times,serif" font-size="14.00">PopoverModule</text>
</g>
<!-- PopoverModule->ToggletipModule -->
<g id="edge6" class="edge">
<title>PopoverModule->ToggletipModule</title>
<path fill="none" stroke="black" d="M105.1,-122.27C105.1,-140.56 105.1,-166 105.1,-166 105.1,-166 328.87,-166 328.87,-166"/>
<polygon fill="black" stroke="black" points="328.87,-169.5 338.87,-166 328.87,-162.5 328.87,-169.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/toggletip/toggletip.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/Toggletip.html">Toggletip</a>
</li>
<li class="list-group-item">
<a href="../directives/ToggletipAction.html">ToggletipAction</a>
</li>
<li class="list-group-item">
<a href="../directives/ToggletipButton.html">ToggletipButton</a>
</li>
<li class="list-group-item">
<a href="../directives/ToggletipContent.html">ToggletipContent</a>
</li>
<li class="list-group-item">
<a href="../directives/ToggletipLabel.html">ToggletipLabel</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/PopoverModule.html">PopoverModule</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/Toggletip.html">Toggletip</a>
</li>
<li class="list-group-item">
<a href="../directives/ToggletipAction.html">ToggletipAction</a>
</li>
<li class="list-group-item">
<a href="../directives/ToggletipButton.html">ToggletipButton</a>
</li>
<li class="list-group-item">
<a href="../directives/ToggletipContent.html">ToggletipContent</a>
</li>
<li class="list-group-item">
<a href="../directives/ToggletipLabel.html">ToggletipLabel</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 { PopoverModule } from "carbon-components-angular/popover";
import { ToggletipLabel } from "./toggletip-label.directive";
import { ToggletipAction } from "./toggletip-action.directive";
import { Toggletip } from "./toggletip.component";
import { ToggletipButton } from "./toggletip-button.directive";
import { ToggletipContent } from "./toggletip-content.directive";
@NgModule({
declarations: [
Toggletip,
ToggletipLabel,
ToggletipAction,
ToggletipButton,
ToggletipContent
],
exports: [
Toggletip,
ToggletipLabel,
ToggletipAction,
ToggletipButton,
ToggletipContent
],
imports: [CommonModule, PopoverModule]
})
export class ToggletipModule {}
</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 = 'ToggletipModule.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>