carbon-components-angular
Version:
Next generation components
2,534 lines • 102 kB
HTML
<!doctype 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 directive">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Directives</li>
<li class="breadcrumb-item" >OverflowMenuDirective</li>
</ol>
<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/dialog/overflow-menu/overflow-menu.directive.ts</code>
</p>
<p class="comment">
<h3>Description</h3>
</p>
<p class="comment">
<p>Directive for extending <code>Dialog</code> to create overflow menus.</p>
<p>class: OverflowMenuDirective (extends DialogDirective)</p>
<p>selector: <code>cdsOverflowMenu</code></p>
<b>Example :</b><div><pre class="line-numbers"><code class="language-html"><div [cdsOverflowMenu]="templateRef"></div>
<ng-template #templateRef>
<!-- overflow menu options here -->
</ng-template></code></pre></div><b>Example :</b><div><pre class="line-numbers"><code class="language-html"><div [cdsOverflowMenu]="templateRef" [customPane]="true"></div>
<ng-template #templateRef>
<!-- custom content goes here -->
</ng-template></code></pre></div>
</p>
<p class="comment">
<h3>Extends</h3>
</p>
<p class="comment">
<code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</p>
<section data-compodoc="block-metadata">
<h3>Metadata</h3>
<table class="table table-sm table-hover metadata">
<tbody>
<tr>
<td class="col-md-3">Providers</td>
<td class="col-md-9">
<code>
DialogService
</code>
</td>
</tr>
<tr>
<td class="col-md-3">Selector</td>
<td class="col-md-9"><code>[cdsOverflowMenu], [ibmOverflowMenu]</code></td>
</tr>
<tr>
<td class="col-md-3">exportAs</td>
<td class="col-md-9"><code>overflowMenu</code></td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-index">
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<h6><b>Properties</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#dialogConfig" >dialogConfig</a>
</li>
<li>
<span class="modifier">Static</span>
<a href="#dialogCounter" >dialogCounter</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#dialogRef" >dialogRef</a>
</li>
<li>
<span class="modifier"></span>
<a href="#hasPopup" >hasPopup</a>
</li>
<li>
<span class="modifier"></span>
<a href="#role" >role</a>
</li>
<li>
<span class="modifier">Private</span>
<a href="#subscriptions" >subscriptions</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Methods</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier"></span>
<a href="#hostkeys" >hostkeys</a>
</li>
<li>
<a href="#open" >open</a>
</li>
<li>
<a href="#updateConfig" >updateConfig</a>
</li>
<li>
<a href="#close" >close</a>
</li>
<li>
<a href="#ngOnChanges" >ngOnChanges</a>
</li>
<li>
<a href="#ngOnDestroy" >ngOnDestroy</a>
</li>
<li>
<a href="#ngOnInit" >ngOnInit</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#onDialogChanges" >onDialogChanges</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#onDialogInit" >onDialogInit</a>
</li>
<li>
<a href="#toggle" >toggle</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Inputs</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#cdsOverflowMenu" >cdsOverflowMenu</a>
</li>
<li>
<a href="#customPane" >customPane</a>
</li>
<li>
<a href="#flip" >flip</a>
</li>
<li>
<a href="#ibmOverflowMenu" class="deprecated-name">ibmOverflowMenu</a>
</li>
<li>
<a href="#offset" >offset</a>
</li>
<li>
<a href="#wrapperClass" >wrapperClass</a>
</li>
<li>
<a href="#appendInline" >appendInline</a>
</li>
<li>
<a href="#cdsDialog" >cdsDialog</a>
</li>
<li>
<a href="#closeTrigger" >closeTrigger</a>
</li>
<li>
<a href="#data" >data</a>
</li>
<li>
<a href="#disabled" >disabled</a>
</li>
<li>
<a href="#gap" >gap</a>
</li>
<li>
<a href="#ibmDialog" class="deprecated-name">ibmDialog</a>
</li>
<li>
<a href="#isOpen" >isOpen</a>
</li>
<li>
<a href="#placement" >placement</a>
</li>
<li>
<a href="#shouldClose" >shouldClose</a>
</li>
<li>
<a href="#title" >title</a>
</li>
<li>
<a href="#trigger" >trigger</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Outputs</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#isOpenChange" >isOpenChange</a>
</li>
<li>
<a href="#onClose" >onClose</a>
</li>
<li>
<a href="#onOpen" >onOpen</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>HostBindings</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#attr.aria-haspopup" >attr.aria-haspopup</a>
</li>
<li>
<a href="#attr.aria-owns" >attr.aria-owns</a>
</li>
<li>
<a href="#attr.role" >attr.role</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>HostListeners</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#keydown" >keydown</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Accessors</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#ibmOverflowMenu" >ibmOverflowMenu</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-constructor">
<h3 id="constructor">Constructor</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<code>constructor(elementRef: ElementRef, viewContainerRef: ViewContainerRef, dialogService: <a href="../injectables/DialogService.html" target="_self">DialogService</a>, eventService: <a href="../injectables/EventService.html" target="_self">EventService</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="71" class="link-to-prism">src/dialog/overflow-menu/overflow-menu.directive.ts:71</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Creates an instance of <code>OverflowMenuDirective</code>.</p>
</div>
<div>
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>elementRef</td>
<td>
<code>ElementRef</code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>viewContainerRef</td>
<td>
<code>ViewContainerRef</code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>dialogService</td>
<td>
<code><a href="../injectables/DialogService.html" target="_self" >DialogService</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>eventService</td>
<td>
<code><a href="../injectables/EventService.html" target="_self" >EventService</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-inputs">
<h3 id="inputs">Inputs</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="cdsOverflowMenu"></a>
<b>cdsOverflowMenu</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>TemplateRef<any></code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="55" class="link-to-prism">src/dialog/overflow-menu/overflow-menu.directive.ts:55</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="customPane"></a>
<b>customPane</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="71" class="link-to-prism">src/dialog/overflow-menu/overflow-menu.directive.ts:71</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Set to true to for custom content</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="flip"></a>
<b>flip</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="59" class="link-to-prism">src/dialog/overflow-menu/overflow-menu.directive.ts:59</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Controls wether the overflow menu is flipped</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ibmOverflowMenu"></a>
<b>ibmOverflowMenu</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>TemplateRef<any></code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="51" class="link-to-prism">src/dialog/overflow-menu/overflow-menu.directive.ts:51</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="offset"></a>
<b>offset</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>literal type</code>
</td>
</tr>
<tr>
<td class="col-md-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:63</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>This specifies any vertical and horizontal offset for the position of the dialog</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="wrapperClass"></a>
<b>wrapperClass</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>""</code>
</td>
</tr>
<tr>
<td class="col-md-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:67</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Classes to add to the dialog container</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="appendInline"></a>
<b>appendInline</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false</code>
</td>
</tr>
<tr>
<td class="col-md-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:86</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Set to <code>true</code> to open the dialog next to the triggering component</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="cdsDialog"></a>
<b>cdsDialog</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>string | TemplateRef<any></code>
</td>
</tr>
<tr>
<td class="col-md-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:52</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="closeTrigger"></a>
<b>closeTrigger</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"mouseout" | "mouseleave"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"mouseleave"</code>
</td>
</tr>
<tr>
<td class="col-md-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:66</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Defines how the Dialog close event is triggered.</p>
<p><a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/mouseleave_event">See here</a>
for more on the difference between <code>mouseleave</code> and <code>mouseout</code>.</p>
<p>Defaults to <code>click</code> when <code>trigger</code> is set to <code>click</code>.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="data"></a>
<b>data</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>{}</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>{}</code>
</td>
</tr>
<tr>
<td class="col-md-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:90</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Optional data for templates</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="disabled"></a>
<b>disabled</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false</code>
</td>
</tr>
<tr>
<td class="col-md-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:96</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>This prevents the dialog from being toggled</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="gap"></a>
<b>gap</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>0</code>
</td>
</tr>
<tr>
<td class="col-md-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:82</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Spacing between the dialog and it's triggering element</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ibmDialog"></a>
<b>ibmDialog</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>string | TemplateRef</code>
</td>
</tr>
<tr>
<td class="col-md-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:48</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="isOpen"></a>
<b>isOpen</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false</code>
</td>
</tr>
<tr>
<td class="col-md-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:92</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="placement"></a>
<b>placement</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"left"</code>
</td>
</tr>
<tr>
<td class="col-md-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:70</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Placement of the dialog, usually relative to the element the directive is on.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="shouldClose"></a>
<b>shouldClose</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function" target="_blank" >function</a></code>
</td>
</tr>
<tr>
<td class="col-md-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:100</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>This input allows explicit control over how the dialog should close</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="title"></a>
<b>title</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>""</code>
</td>
</tr>
<tr>
<td class="col-md-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:43</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Title for the dialog</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="trigger"></a>
<b>trigger</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"click" | "hover" | "mouseenter"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"click"</code>
</td>
</tr>
<tr>
<td class="col-md-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:57</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Defines how the Dialog is triggered.(Hover and click behave the same on mobile - both respond to a single tap).
Do not add focusable elements if trigger is <code>hover</code> or <code>mouseenter</code>.</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-outputs">
<h3 id="outputs">Outputs</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="isOpenChange"></a>
<b>isOpenChange</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>EventEmitter</code>
</td>
</tr>
<tr>
<td class="col-md-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:116</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Emits an event when the state of <code>isOpen</code> changes. Allows <code>isOpen</code> to be double bound</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="onClose"></a>
<b>onClose</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>EventEmitter<any></code>
</td>
</tr>
<tr>
<td class="col-md-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:108</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Emits an event when the dialog is closed</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="onOpen"></a>
<b>onOpen</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>EventEmitter<any></code>
</td>
</tr>
<tr>
<td class="col-md-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:112</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Emits an event when the dialog is opened</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-properties">
<h3>HostBindings</h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="attr.aria-haspopup"></a>
<span class="name">
<span ><b>attr.aria-haspopup</b></span>
<a href="#attr.aria-haspopup"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>true</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:119</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="attr.aria-owns"></a>
<span class="name">
<span ><b>attr.aria-owns</b></span>
<a href="#attr.aria-owns"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:120</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="attr.role"></a>
<span class="name">
<span ><b>attr.role</b></span>
<a href="#attr.role"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"button"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:118</a></code>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-host-listener">
<h3>HostListeners</h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="keydown"></a>
<span class="name">
<b>
keydown
</b>
<a href="#keydown"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Arguments : </i><code>'$event' </code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="93"
class="link-to-prism">src/dialog/overflow-menu/overflow-menu.directive.ts:93</a></div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-methods">
<h3 id="methods">
Methods
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="hostkeys"></a>
<span class="name">
<span class="modifier"></span>
<span ><b>hostkeys</b></span>
<a href="#hostkeys"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>hostkeys(event: KeyboardEvent)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<b>Decorators : </b>
<br />
<code>@HostListener('keydown', ['$event'])<br /></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="93"
class="link-to-prism">src/dialog/overflow-menu/overflow-menu.directive.ts:93</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>event</td>
<td>
<code>KeyboardEvent</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="open"></a>
<span class="name">
<span ><b>open</b></span>
<a href="#open"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>open()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:102</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="updateConfig"></a>
<span class="name">
<span ><b>updateConfig</b></span>
<a href="#updateConfig"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>updateConfig()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:85</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="close"></a>
<span class="name">
<span ><b>close</b></span>
<a href="#close"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>close(meta: <a href="../interfaces/CloseMeta.html" target="_self">CloseMeta</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:305</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Helper method to close the dialogRef.</p>
</div>
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
<td>Default value</td>
</tr>
</thead>
<tbody>
<tr>
<td>meta</td>
<td>
<code><a href="../interfaces/CloseMeta.html" target="_self" >CloseMeta</a></code>
</td>
<td>
No
</td>
<td>
<code>{ reason: CloseReasons.interaction }</code>
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ngOnChanges"></a>
<span class="name">
<span ><b>ngOnChanges</b></span>
<a href="#ngOnChanges"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>ngOnChanges(changes: SimpleChanges)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:148</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>changes</td>
<td>
<code>SimpleChanges</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ngOnDestroy"></a>
<span class="name">
<span ><b>ngOnDestroy</b></span>
<a href="#ngOnDestroy"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>ngOnDestroy()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:252</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>When the host dies, kill the popover.</p>
<ul>
<li>Useful for use in a modal or similar.</li>
</ul>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ngOnInit"></a>
<span class="name">
<span ><b>ngOnInit</b></span>
<a href="#ngOnInit"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>ngOnInit()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:185</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Sets the config object and binds events for hovering or clicking before
running code from child class.</p>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="onDialogChanges"></a>
<span class="name">
<span class="modifier">Protected</span>
<span ><b>onDialogChanges</b></span>
<a href="#onDialogChanges"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>onDialogChanges(_changes: SimpleChanges)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:321</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Empty method for child to override and specify additional on changes steps.
run after DialogDirective completes it's ngOnChanges.</p>
</div>
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>_changes</td>
<td>
<code>SimpleChanges</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="onDialogInit"></a>
<span class="name">
<span class="modifier">Protected</span>
<span ><b>onDialogInit</b></span>
<a href="#onDialogInit"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>onDialogInit()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:315</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Empty method for child classes to override and specify additional init steps.
Run after DialogDirective completes it's ngOnInit.</p>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="toggle"></a>
<span class="name">
<span ><b>toggle</b></span>
<a href="#toggle"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>toggle(meta: <a href="../interfaces/CloseMeta.html" target="_self">CloseMeta</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:294</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Helper method to toggle the open state of the dialog</p>
</div>
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
<td>Default value</td>
</tr>
</thead>
<tbody>
<tr>
<td>meta</td>
<td>
<code><a href="../interfaces/CloseMeta.html" target="_self" >CloseMeta</a></code>
</td>
<td>
No
</td>
<td>
<code>{ reason: CloseReasons.interaction }</code>
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-properties">
<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="dialogConfig"></a>
<span class="name">
<span ><b>dialogConfig</b></span>
<a href="#dialogConfig"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../interfaces/DialogConfig.html" target="_self" >DialogConfig</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:104</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Config object passed to the rendered component</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="dialogCounter"></a>
<span class="name">
<span class="modifier">Static</span>
<span ><b>dialogCounter</b></span>
<a href="#dialogCounter"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>0</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:39</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="dialogRef"></a>
<span class="name">
<span class="modifier">Protected</span>
<span ><b>dialogRef</b></span>
<a href="#dialogRef"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../components/Dialog.html" target="_self" >ComponentRef<Dialog></a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:127</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Keeps a reference to the currently opened dialog</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="hasPopup"></a>
<span class="name">
<span class="modifier"></span>
<span ><b>hasPopup</b></span>
<a href="#hasPopup"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>true</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<b>Decorators : </b>
<br />
<code>
@HostBinding('attr.aria-haspopup')<br />
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:119</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="role"></a>
<span class="name">
<span class="modifier"></span>
<span ><b>role</b></span>
<a href="#role"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"button"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<b>Decorators : </b>
<br />
<code>
@HostBinding('attr.role')<br />
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:118</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="subscriptions"></a>
<span class="name">
<span class="modifier">Private</span>
<span ><b>subscriptions</b></span>
<a href="#subscriptions"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>Subscription[]</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>[]</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../directives/DialogDirective.html" target="_self" >DialogDirective</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../directives/DialogDirective.html#source" target="_self" >DialogDirective:129</a></code>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-accessors">
<h3 id="accessors">
Accessors
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ibmOverflowMenu"></a>
<span class="name"><b>ibmOverflowMenu</b><a href="#ibmOverflowMenu"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>set</b><code>ibmOverflowMenu(template: TemplateRef<any>)</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="51" class="link-to-prism">src/dialog/overflow-menu/overflow-menu.directive.ts:51</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Takes a template ref of <code>OverflowMenuOptions</code>s</p>
</div>
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>template</td>
<td>
<code>TemplateRef<any></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
</td>
</tr>
</tbody>
</table>
</section>
</div>
<div class="tab-pane fade tab-source-code" id="source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import {
Directive,
ElementRef,
ViewContainerRef,
Input,
TemplateRef,
HostListener
} from "@angular/core";
import { DialogDirective } from "../dialog.directive";
import { DialogService } from "../dialog.service";
import { OverflowMenuPane } from "./overflow-menu-pane.component";
import { OverflowMenuCustomPane } from "./overflow-menu-custom-pane.component";
import { EventService } from "carbon-components-angular/utils";
/**
* Directive for extending `Dialog` to create overflow menus.
*
* class: OverflowMenuDirective (extends DialogDirective)
*
*
* selector: `cdsOverflowMenu`
*
*
* ```html
* <div [cdsOverflowMenu]="templateRef"></div>
* <ng-template #templateRef>
* <!-- overflow menu options here -->
* </ng-template>
* ```
*
* ```html
* <div [cdsOverflowMenu]="templateRef" [customPane]="true"></div>
* <ng-template #templateRef>
* <!-- custom content goes here -->
* </ng-template>
* ```
*/
@Directive({
selector: "[cdsOverflowMenu], [ibmOverflowMenu]",
exportAs: "overflowMenu",
providers: [
DialogService
]
})
export class OverflowMenuDirective extends DialogDirective {
/**
* @deprecated as of v5
* Takes a template ref of `OverflowMenuOptions`s
*/
@Input() set ibmOverflowMenu(template: TemplateRef<any>) {
this.cdsOverflowMenu = template;
}
@Input() cdsOverflowMenu: TemplateRef<any>;
/**
* Controls wether the overflow menu is flipped
*/
@Input() flip = false;
/**
* This specifies any vertical and horizontal offset for the position of the dialog
*/
@Input() offset: { x: number, y: number };
/**
* Classes to add to the dialog container
*/
@Input() wrapperClass = "";
/**
* Set to true to for custom content
*/
@Input() customPane = false;
/**
* Creates an instance of `OverflowMenuDirective`.
*/
constructor(
protected elementRef: ElementRef,
protected viewContainerRef: ViewContainerRef,
protected dialogService: DialogService,
protected eventService: EventService
) {
super(elementRef, viewContainerRef, dialogService, eventService);
}
updateConfig() {
this.dialogConfig.content = this.cdsOverflowMenu;
this.dialogConfig.flip = this.flip;
this.dialogConfig.offset = this.offset;
this.dialogConfig.wrapperClass = this.wrapperClass;
}
@HostListener("keydown", ["$event"])
hostkeys(event: KeyboardEvent) {
switch (event.key) {
case "Enter":
case " ":
event.preventDefault();
break;
}
}
open() {
return super.open(this.customPane ? OverflowMenuCustomPane : OverflowMenuPane);
}
}
</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 = 'directive';
var COMPODOC_CURRENT_PAGE_URL = 'OverflowMenuDirective.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>