carbon-components-angular

<!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>  <div class="content component"> <div class="content-data"> <ol class="breadcrumb"> <li class="breadcrumb-item">Components</li> <li class="breadcrumb-item" > MenuButtonComponent</li> </ol> <ul class="nav nav-tabs" role="tablist"> <li class="nav-item"> <a href="#info" 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> <li class="nav-item"> <a href="#tree" class="nav-link" role="tab" id="tree-tab" data-bs-toggle="tab" data-link="dom-tree">DOM Tree</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/menu-button/menu-button.component.ts</code> </p> <p class="comment"> <h3>Implements</h3> </p> <p class="comment"> <code>OnChanges</code> <code>AfterViewInit</code> <code>OnDestroy</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">changeDetection</td> <td class="col-md-9"><code>ChangeDetectionStrategy.OnPush</code></td> </tr> <tr> <td class="col-md-3">selector</td> <td class="col-md-9"><code>cds-menu-button</code></td> </tr> <tr> <td class="col-md-3">template</td> <td class="col-md-9"><pre class="line-numbers"><code class="language-html"><button #reference class="cds--menu-button__trigger" [ngClass]="{'cds--menu-button__trigger--open': open}" [cdsButton]="kind" [size]="size" [attr.tabindex]="buttonTabIndex" [disabled]="disabled" type="button" [attr.aria-haspopup]="true" [attr.aria-expanded]="open" [attr.aria-controls]="open ? menuId : undefined" (click)="toggleMenu()"> {{label}} <svg cdsIcon="chevron--down" size="16" class="cds--btn__icon"> </svg> </button> <ng-template #menuTemplate> <cds-menu mode="basic" [size]="size" [open]="open" [attr.id]="menuId" [ngClass]="{ 'cds--menu-button__bottom': this.menuAlignment === 'bottom', 'cds--menu-button__bottom-start': this.menuAlignment === 'bottom-start', 'cds--menu-button__bottom-end': this.menuAlignment === 'bottom-end', 'cds--menu-top': this.menuAlignment === 'top', 'cds--menu-top-start': this.menuAlignment === 'top-start', 'cds--menu-top-end': this.menuAlignment === 'top-end' }"> <ng-content select="cds-menu-item, cds-menu-divider"></ng-content> </cds-menu> </ng-template> </code></pre></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> <span class="modifier">Private</span> <a href="#_alignment" >_alignment</a> </li> <li> <span class="modifier"></span> <a href="#containerClass" >containerClass</a> </li> <li> <span class="modifier">Protected</span> <a href="#documentClick" >documentClick</a> </li> <li> <span class="modifier">Static</span> <a href="#menuButtonCounter" >menuButtonCounter</a> </li> <li> <span class="modifier">Private</span> <a href="#menuRef" >menuRef</a> </li> <li> <span class="modifier"></span> <a href="#menuTemplate" >menuTemplate</a> </li> <li> <span class="modifier"></span> <a href="#referenceElement" >referenceElement</a> </li> <li> <span class="modifier">Private</span> <a href="#subscriptions" >subscriptions</a> </li> <li> <span class="modifier">Protected</span> <a href="#unmountFloatingElement" >unmountFloatingElement</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> <a href="#cleanUp" >cleanUp</a> </li> <li> <a href="#handleFocusOut" >handleFocusOut</a> </li> <li> <a href="#handleMenuItemClick" >handleMenuItemClick</a> </li> <li> <a href="#ngAfterViewInit" >ngAfterViewInit</a> </li> <li> <a href="#ngOnChanges" >ngOnChanges</a> </li> <li> <a href="#ngOnDestroy" >ngOnDestroy</a> </li> <li> <a href="#recomputePosition" >recomputePosition</a> </li> <li> <a href="#roundByDPR" >roundByDPR</a> </li> <li> <a href="#toggleMenu" >toggleMenu</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="#buttonTabIndex" >buttonTabIndex</a> </li> <li> <a href="#disabled" >disabled</a> </li> <li> <a href="#kind" >kind</a> </li> <li> <a href="#label" >label</a> </li> <li> <a href="#menuAlignment" >menuAlignment</a> </li> <li> <a href="#menuId" >menuId</a> </li> <li> <a href="#open" >open</a> </li> <li> <a href="#size" >size</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="#class.cds--menu-button__container" >class.cds--menu-button__container</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="#projectedMenuItems" >projectedMenuItems</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(ngZone: NgZone, renderer: Renderer2, hostElement: ElementRef, viewContainerRef: ViewContainerRef, changeDetectorRef: ChangeDetectorRef)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="109" class="link-to-prism">src/menu-button/menu-button.component.ts:109</a></div> </td> </tr> <tr> <td class="col-md-4"> <div> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>ngZone</td> <td> <code>NgZone</code> </td> <td> No </td> </tr> <tr> <td>renderer</td> <td> <code>Renderer2</code> </td> <td> No </td> </tr> <tr> <td>hostElement</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>changeDetectorRef</td> <td> <code>ChangeDetectorRef</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="buttonTabIndex"></a> <b>buttonTabIndex</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>"0" | "1" | "-1" | string</code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>"0"</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="96" class="link-to-prism">src/menu-button/menu-button.component.ts:96</a></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-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="97" class="link-to-prism">src/menu-button/menu-button.component.ts:97</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="kind"></a> <b>kind</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>"primary" | "tertiary" | "ghost"</code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>"primary"</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="93" class="link-to-prism">src/menu-button/menu-button.component.ts:93</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="label"></a> <b>label</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-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="99" class="link-to-prism">src/menu-button/menu-button.component.ts:99</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="menuAlignment"></a> <b>menuAlignment</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="../miscellaneous/typealiases.html#MenuButtonPlacement" target="_self" >MenuButtonPlacement</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>"bottom"</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="95" class="link-to-prism">src/menu-button/menu-button.component.ts:95</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="menuId"></a> <b>menuId</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>`menu-button-${MenuButtonComponent.menuButtonCounter++}`</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="77" class="link-to-prism">src/menu-button/menu-button.component.ts:77</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="open"></a> <b>open</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="98" class="link-to-prism">src/menu-button/menu-button.component.ts:98</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="size"></a> <b>size</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>"sm" | "md" | "lg"</code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>"lg"</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="94" class="link-to-prism">src/menu-button/menu-button.component.ts:94</a></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="class.cds--menu-button__container"></a> <span class="name"> <span ><b>class.cds--menu-button__container</b></span> <a href="#class.cds--menu-button__container"><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">Defined in <a href="" data-line="91" class="link-to-prism">src/menu-button/menu-button.component.ts:91</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="cleanUp"></a> <span class="name"> <span ><b>cleanUp</b></span> <a href="#cleanUp"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>cleanUp()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="180" class="link-to-prism">src/menu-button/menu-button.component.ts:180</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Clean up <code>autoUpdate</code> if auto alignment is enabled</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="handleFocusOut"></a> <span class="name"> <span ><b>handleFocusOut</b></span> <a href="#handleFocusOut"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>handleFocusOut(event)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="169" class="link-to-prism">src/menu-button/menu-button.component.ts:169</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>On body click, close the menu</p> </div> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>event</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="handleMenuItemClick"></a> <span class="name"> <span ><b>handleMenuItemClick</b></span> <a href="#handleMenuItemClick"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>handleMenuItemClick(event: <a href="../interfaces/ItemClickEvent.html" target="_self">ItemClickEvent</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="156" class="link-to-prism">src/menu-button/menu-button.component.ts:156</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>As of now, menu button does not support nexted menu, on button click it should close</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>event</td> <td> <code><a href="../interfaces/ItemClickEvent.html" target="_self" >ItemClickEvent</a></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="ngAfterViewInit"></a> <span class="name"> <span ><b>ngAfterViewInit</b></span> <a href="#ngAfterViewInit"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>ngAfterViewInit()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="135" class="link-to-prism">src/menu-button/menu-button.component.ts:135</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>If user has passed in true for open, we dynamically open the menu</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="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">Defined in <a href="" data-line="124" class="link-to-prism">src/menu-button/menu-button.component.ts:124</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>In case user updates alignment, store initial value. This allows us to test user passed alignment on each open</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="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">Defined in <a href="" data-line="147" class="link-to-prism">src/menu-button/menu-button.component.ts:147</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Clean up Floating-ui & subscriptions</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="recomputePosition"></a> <span class="name"> <span ><b>recomputePosition</b></span> <a href="#recomputePosition"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>recomputePosition()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="238" class="link-to-prism">src/menu-button/menu-button.component.ts:238</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Compute position of menu</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="roundByDPR"></a> <span class="name"> <span ><b>roundByDPR</b></span> <a href="#roundByDPR"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>roundByDPR(value)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="228" class="link-to-prism">src/menu-button/menu-button.component.ts:228</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>Optional</td> </tr> </thead> <tbody> <tr> <td>value</td> <td> No </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</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="toggleMenu"></a> <span class="name"> <span ><b>toggleMenu</b></span> <a href="#toggleMenu"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>toggleMenu()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="197" class="link-to-prism">src/menu-button/menu-button.component.ts:197</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Handles emitting open/close event</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> </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="_alignment"></a> <span class="name"> <span class="modifier">Private</span> <span ><b>_alignment</b></span> <a href="#_alignment"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="../miscellaneous/typealiases.html#MenuButtonPlacement" target="_self" >MenuButtonPlacement</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>"bottom"</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="108" class="link-to-prism">src/menu-button/menu-button.component.ts:108</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="containerClass"></a> <span class="name"> <span class="modifier"></span> <span ><b>containerClass</b></span> <a href="#containerClass"><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('class.cds--menu-button__container')<br /> </code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="91" class="link-to-prism">src/menu-button/menu-button.component.ts:91</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="documentClick"></a> <span class="name"> <span class="modifier">Protected</span> <span ><b>documentClick</b></span> <a href="#documentClick"><span cl