carbon-components-angular
Version:
Next generation components
517 lines (452 loc) • 23.3 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" >ContextMenuModule</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="1026pt" height="349pt"
viewBox="0.00 0.00 1026.00 349.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 345)">
<title>dependencies</title>
<polygon fill="white" stroke="transparent" points="-4,4 -4,-345 1022,-345 1022,4 -4,4"/>
<text text-anchor="start" x="488.01" y="-42.4" font-family="Times-12" font-weight="bold" font-size="14.00">Legend</text>
<polygon fill="#ffffb3" stroke="transparent" points="275,-10 275,-30 295,-30 295,-10 275,-10"/>
<text text-anchor="start" x="298.63" y="-15.4" font-family="Times-12" font-size="14.00">  Declarations</text>
<polygon fill="#8dd3c7" stroke="transparent" points="388,-10 388,-30 408,-30 408,-10 388,-10"/>
<text text-anchor="start" x="411.73" y="-15.4" font-family="Times-12" font-size="14.00">  Module</text>
<polygon fill="#80b1d3" stroke="transparent" points="474,-10 474,-30 494,-30 494,-10 474,-10"/>
<text text-anchor="start" x="497.78" y="-15.4" font-family="Times-12" font-size="14.00">  Bootstrap</text>
<polygon fill="#fdb462" stroke="transparent" points="571,-10 571,-30 591,-30 591,-10 571,-10"/>
<text text-anchor="start" x="594.67" y="-15.4" font-family="Times-12" font-size="14.00">  Providers</text>
<polygon fill="#fb8072" stroke="transparent" points="667,-10 667,-30 687,-30 687,-10 667,-10"/>
<text text-anchor="start" x="690.73" y="-15.4" font-family="Times-12" font-size="14.00">  Exports</text>
<g id="clust1" class="cluster">
<title>cluster_ContextMenuModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="8,-70 8,-333 1010,-333 1010,-70 8,-70"/>
</g>
<g id="clust5" class="cluster">
<title>cluster_ContextMenuModule_ContextMenuGroupComponent_providers</title>
<polygon fill="none" stroke="black" points="728,-78 728,-195 1002,-195 1002,-78 728,-78"/>
</g>
<g id="clust2" class="cluster">
<title>cluster_ContextMenuModule_declarations</title>
<polygon fill="none" stroke="black" points="124,-143 124,-195 720,-195 720,-143 124,-143"/>
</g>
<g id="clust8" class="cluster">
<title>cluster_ContextMenuModule_exports</title>
<polygon fill="none" stroke="black" points="69,-273 69,-325 891,-325 891,-273 69,-273"/>
</g>
<g id="clust7" class="cluster">
<title>cluster_ContextMenuModule_imports</title>
<polygon fill="none" stroke="black" points="16,-143 16,-195 116,-195 116,-143 16,-143"/>
</g>
<!-- ContextMenuComponent -->
<g id="node1" class="node">
<title>ContextMenuComponent</title>
<polygon fill="#ffffb3" stroke="black" points="712.32,-187 553.68,-187 553.68,-151 712.32,-151 712.32,-187"/>
<text text-anchor="middle" x="633" y="-164.8" font-family="Times,serif" font-size="14.00">ContextMenuComponent</text>
</g>
<!-- ContextMenuModule -->
<g id="node5" class="node">
<title>ContextMenuModule</title>
<polygon fill="#8dd3c7" stroke="black" points="503.04,-252 500.04,-256 479.04,-256 476.04,-252 366.96,-252 366.96,-216 503.04,-216 503.04,-252"/>
<text text-anchor="middle" x="435" y="-229.8" font-family="Times,serif" font-size="14.00">ContextMenuModule</text>
</g>
<!-- ContextMenuComponent->ContextMenuModule -->
<g id="edge1" class="edge">
<title>ContextMenuComponent->ContextMenuModule</title>
<path fill="none" stroke="black" d="M628.57,-187.03C628.57,-203.4 628.57,-225 628.57,-225 628.57,-225 513.24,-225 513.24,-225"/>
<polygon fill="black" stroke="black" points="513.24,-221.5 503.24,-225 513.24,-228.5 513.24,-221.5"/>
</g>
<!-- ContextMenuDividerComponent -->
<g id="node2" class="node">
<title>ContextMenuDividerComponent</title>
<polygon fill="#ffffb3" stroke="black" points="535.59,-187 334.41,-187 334.41,-151 535.59,-151 535.59,-187"/>
<text text-anchor="middle" x="435" y="-164.8" font-family="Times,serif" font-size="14.00">ContextMenuDividerComponent</text>
</g>
<!-- ContextMenuDividerComponent->ContextMenuModule -->
<g id="edge2" class="edge">
<title>ContextMenuDividerComponent->ContextMenuModule</title>
<path fill="none" stroke="black" d="M435,-187.11C435,-187.11 435,-205.99 435,-205.99"/>
<polygon fill="black" stroke="black" points="431.5,-205.99 435,-215.99 438.5,-205.99 431.5,-205.99"/>
</g>
<!-- ContextMenuGroupComponent -->
<g id="node3" class="node">
<title>ContextMenuGroupComponent</title>
<polygon fill="#ffffb3" stroke="black" points="946.09,-187 751.91,-187 751.91,-151 946.09,-151 946.09,-187"/>
<text text-anchor="middle" x="849" y="-164.8" font-family="Times,serif" font-size="14.00">ContextMenuGroupComponent</text>
</g>
<!-- ContextMenuGroupComponent->ContextMenuModule -->
<g id="edge3" class="edge">
<title>ContextMenuGroupComponent->ContextMenuModule</title>
<path fill="none" stroke="black" d="M817.43,-187.11C817.43,-206.34 817.43,-234 817.43,-234 817.43,-234 513.37,-234 513.37,-234"/>
<polygon fill="black" stroke="black" points="513.37,-230.5 503.37,-234 513.37,-237.5 513.37,-230.5"/>
</g>
<!-- ContextMenuItemComponent -->
<g id="node4" class="node">
<title>ContextMenuItemComponent</title>
<polygon fill="#ffffb3" stroke="black" points="315.98,-187 132.02,-187 132.02,-151 315.98,-151 315.98,-187"/>
<text text-anchor="middle" x="224" y="-164.8" font-family="Times,serif" font-size="14.00">ContextMenuItemComponent</text>
</g>
<!-- ContextMenuItemComponent->ContextMenuModule -->
<g id="edge5" class="edge">
<title>ContextMenuItemComponent->ContextMenuModule</title>
<path fill="none" stroke="black" d="M299.6,-187.03C299.6,-203.4 299.6,-225 299.6,-225 299.6,-225 356.9,-225 356.9,-225"/>
<polygon fill="black" stroke="black" points="356.9,-228.5 366.9,-225 356.9,-221.5 356.9,-228.5"/>
</g>
<!-- ContextMenuComponent -->
<g id="node8" class="node">
<title>ContextMenuComponent </title>
<polygon fill="#fb8072" stroke="black" points="882.82,-317 721.18,-317 721.18,-281 882.82,-281 882.82,-317"/>
<text text-anchor="middle" x="802" y="-294.8" font-family="Times,serif" font-size="14.00">ContextMenuComponent </text>
</g>
<!-- ContextMenuModule->ContextMenuComponent -->
<g id="edge7" class="edge">
<title>ContextMenuModule->ContextMenuComponent </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M503.08,-243C589.79,-243 728.53,-243 728.53,-243 728.53,-243 728.53,-270.97 728.53,-270.97"/>
<polygon fill="black" stroke="black" points="725.03,-270.97 728.53,-280.97 732.03,-270.97 725.03,-270.97"/>
</g>
<!-- ContextMenuDividerComponent -->
<g id="node9" class="node">
<title>ContextMenuDividerComponent </title>
<polygon fill="#fb8072" stroke="black" points="703.09,-317 498.91,-317 498.91,-281 703.09,-281 703.09,-317"/>
<text text-anchor="middle" x="601" y="-294.8" font-family="Times,serif" font-size="14.00">ContextMenuDividerComponent </text>
</g>
<!-- ContextMenuModule->ContextMenuDividerComponent -->
<g id="edge8" class="edge">
<title>ContextMenuModule->ContextMenuDividerComponent </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M489.75,-252.11C489.75,-271.34 489.75,-299 489.75,-299 489.75,-299 490.66,-299 490.66,-299"/>
<polygon fill="black" stroke="black" points="488.86,-302.5 498.86,-299 488.85,-295.5 488.86,-302.5"/>
</g>
<!-- ContextMenuGroupComponent -->
<g id="node10" class="node">
<title>ContextMenuGroupComponent </title>
<polygon fill="#fb8072" stroke="black" points="480.59,-317 283.41,-317 283.41,-281 480.59,-281 480.59,-317"/>
<text text-anchor="middle" x="382" y="-294.8" font-family="Times,serif" font-size="14.00">ContextMenuGroupComponent </text>
</g>
<!-- ContextMenuModule->ContextMenuGroupComponent -->
<g id="edge9" class="edge">
<title>ContextMenuModule->ContextMenuGroupComponent </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M423.76,-252.11C423.76,-252.11 423.76,-270.99 423.76,-270.99"/>
<polygon fill="black" stroke="black" points="420.26,-270.99 423.76,-280.99 427.26,-270.99 420.26,-270.99"/>
</g>
<!-- ContextMenuItemComponent -->
<g id="node11" class="node">
<title>ContextMenuItemComponent </title>
<polygon fill="#fb8072" stroke="black" points="264.98,-317 77.02,-317 77.02,-281 264.98,-281 264.98,-317"/>
<text text-anchor="middle" x="171" y="-294.8" font-family="Times,serif" font-size="14.00">ContextMenuItemComponent </text>
</g>
<!-- ContextMenuModule->ContextMenuItemComponent -->
<g id="edge10" class="edge">
<title>ContextMenuModule->ContextMenuItemComponent </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M366.88,-243C296.97,-243 198.38,-243 198.38,-243 198.38,-243 198.38,-270.97 198.38,-270.97"/>
<polygon fill="black" stroke="black" points="194.88,-270.97 198.38,-280.97 201.88,-270.97 194.88,-270.97"/>
</g>
<!-- ContextMenuSelectionService -->
<g id="node6" class="node">
<title>ContextMenuSelectionService</title>
<ellipse fill="#fdb462" stroke="black" cx="865" cy="-104" rx="129.07" ry="18"/>
<text text-anchor="middle" x="865" y="-99.8" font-family="Times,serif" font-size="14.00">ContextMenuSelectionService</text>
</g>
<!-- ContextMenuSelectionService->ContextMenuGroupComponent -->
<g id="edge4" class="edge">
<title>ContextMenuSelectionService->ContextMenuGroupComponent</title>
<path fill="none" stroke="black" d="M849,-122.11C849,-122.11 849,-140.99 849,-140.99"/>
<polygon fill="black" stroke="black" points="845.5,-140.99 849,-150.99 852.5,-140.99 845.5,-140.99"/>
</g>
<!-- IconModule -->
<g id="node7" class="node">
<title>IconModule</title>
<polygon fill="#8dd3c7" stroke="black" points="108.43,-187 105.43,-191 84.43,-191 81.43,-187 23.57,-187 23.57,-151 108.43,-151 108.43,-187"/>
<text text-anchor="middle" x="66" y="-164.8" font-family="Times,serif" font-size="14.00">IconModule</text>
</g>
<!-- IconModule->ContextMenuModule -->
<g id="edge6" class="edge">
<title>IconModule->ContextMenuModule</title>
<path fill="none" stroke="black" d="M92.74,-187.11C92.74,-206.34 92.74,-234 92.74,-234 92.74,-234 356.56,-234 356.56,-234"/>
<polygon fill="black" stroke="black" points="356.56,-237.5 366.56,-234 356.56,-230.5 356.56,-237.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/context-menu/context-menu.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/ContextMenuComponent.html">ContextMenuComponent</a>
</li>
<li class="list-group-item">
<a href="../components/ContextMenuDividerComponent.html">ContextMenuDividerComponent</a>
</li>
<li class="list-group-item">
<a href="../components/ContextMenuGroupComponent.html">ContextMenuGroupComponent</a>
</li>
<li class="list-group-item">
<a href="../components/ContextMenuItemComponent.html">ContextMenuItemComponent</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/ContextMenuComponent.html">ContextMenuComponent</a>
</li>
<li class="list-group-item">
<a href="../components/ContextMenuDividerComponent.html">ContextMenuDividerComponent</a>
</li>
<li class="list-group-item">
<a href="../components/ContextMenuGroupComponent.html">ContextMenuGroupComponent</a>
</li>
<li class="list-group-item">
<a href="../components/ContextMenuItemComponent.html">ContextMenuItemComponent</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 { CommonModule } from "@angular/common";
import { NgModule } from "@angular/core";
import { IconModule } from "carbon-components-angular/icon";
import { ContextMenuDividerComponent } from "./context-menu-divider.component";
import { ContextMenuGroupComponent } from "./context-menu-group.component";
import { ContextMenuItemComponent } from "./context-menu-item.component";
import { ContextMenuComponent } from "./context-menu.component";
@NgModule({
declarations: [
ContextMenuDividerComponent,
ContextMenuGroupComponent,
ContextMenuItemComponent,
ContextMenuComponent
],
exports: [
ContextMenuDividerComponent,
ContextMenuGroupComponent,
ContextMenuItemComponent,
ContextMenuComponent
],
imports: [CommonModule, IconModule]
})
export class ContextMenuModule { }
</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 = 'ContextMenuModule.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>