feature(menu): add menuToggle directive

2025-08-23 14:01:20 +08:00 · 2018-01-09 15:49:48 -06:00
parent acaa9cffe0
commit caca8ef864
3 changed files with 123 additions and 1 deletions
--- a/packages/angular/src/directives/menu-toggle.ts
+++ b/packages/angular/src/directives/menu-toggle.ts
@ -0,0 +1,114 @@
+import { Directive, HostListener, Input } from '@angular/core';
+
+
+import { MenuController } from '../providers/menu-controller';
+
+/**
+ * @name MenuToggle
+ * @description
+ * The `menuToggle` directive can be placed on any button to toggle a menu open or closed.
+ * If it is added to the [NavBar](../../toolbar/Navbar) of a page, the button will only appear
+ * when the page it's in is currently a root page. See the [Menu Navigation Bar Behavior](../Menu#navigation-bar-behavior)
+ * docs for more information.
+ *
+ *
+ * @usage
+ *
+ * A simple `menuToggle` button can be added using the following markup:
+ *
+ * ```html
+ * <button ion-button menuToggle>Toggle Menu</button>
+ * ```
+ *
+ * To toggle a specific menu by its id or side, give the `menuToggle`
+ * directive a value.
+ *
+ * ```html
+ * <button ion-button menuToggle="right">Toggle Right Menu</button>
+ * ```
+ *
+ * If placing the `menuToggle` in a navbar or toolbar, it should be
+ * placed as a child of the `<ion-navbar>` or `<ion-toolbar>`, and not in
+ * the `<ion-buttons>` element:
+ *
+ * ```html
+ * <ion-header>
+ *
+ *   <ion-navbar>
+ *     <ion-buttons start>
+ *       <button ion-button>
+ *         <ion-icon name="contact"></ion-icon>
+ *       </button>
+ *     </ion-buttons>
+ *     <button ion-button menuToggle>
+ *       <ion-icon name="menu"></ion-icon>
+ *     </button>
+ *     <ion-title>
+ *       Title
+ *     </ion-title>
+ *     <ion-buttons end>
+ *       <button ion-button (click)="doClick()">
+ *         <ion-icon name="more"></ion-icon>
+ *       </button>
+ *     </ion-buttons>
+ *   </ion-navbar>
+ *
+ * </ion-header>
+ * ```
+ *
+ * Similar to `<ion-buttons>`, the `menuToggle` can be positioned using
+ * `start`, `end`, `left`, or `right`:
+ *
+ * ```html
+ * <ion-toolbar>
+ *   <button ion-button menuToggle right>
+ *     <ion-icon name="menu"></ion-icon>
+ *   </button>
+ *   <ion-title>
+ *     Title
+ *   </ion-title>
+ *   <ion-buttons end>
+ *     <button ion-button (click)="doClick()">
+ *       <ion-icon name="more"></ion-icon>
+ *     </button>
+ *   </ion-buttons>
+ * </ion-toolbar>
+ * ```
+ *
+ * See the [Toolbar API docs](../../toolbar/Toolbar) for more information
+ * on the different positions.
+ *
+ * @demo /docs/demos/src/menu/
+ * @see {@link /docs/components#menus Menu Component Docs}
+ * @see {@link ../../menu/Menu Menu API Docs}
+ */
+@Directive({
+  selector: '[menuToggle]',
+  host: {
+    '[hidden]': 'isHidden'
+  }
+})
+export class MenuToggle {
+
+  /**
+   * @hidden
+   */
+  @Input() menuToggle: string;
+
+
+  constructor(
+    private _menu: MenuController,
+  ) {
+
+  }
+
+  /**
+  * @hidden
+  */
+  @HostListener('click')
+  toggle() {
+    const menu = this._menu.get(this.menuToggle);
+    menu && menu.toggle();
+  }
+
+}