import { ChangeDetectionStrategy, Component, ContentChild, ElementRef, EventEmitter, Input, Output, Renderer, ViewChild, ViewEncapsulation, forwardRef } from '@angular/core'; import { App } from '../app/app'; import { Backdrop } from '../backdrop/backdrop'; import { Config } from '../../config/config'; import { Content } from '../content/content'; import { DomController } from '../../platform/dom-controller'; import { GESTURE_GO_BACK_SWIPE, GestureController, } from '../../gestures/gesture-controller'; import { isRightSide, isTrueProperty } from '../../util/util'; import { Keyboard } from '../../platform/keyboard'; import { MenuContentGesture } from './menu-gestures'; import { MenuController } from '../app/menu-controller'; import { Nav } from '../nav/nav'; import { Platform } from '../../platform/platform'; import { UIEventManager } from '../../gestures/ui-event-manager'; import { RootNode } from '../split-pane/split-pane'; /** * @name Menu * @description * The Menu component is a navigation drawer that slides in from the side of the current * view. By default, it slides in from the left, but the side can be overridden. The menu * will be displayed differently based on the mode, however the display type can be changed * to any of the available [menu types](#menu-types). The menu element should be a sibling * to the app's content element. There can be any number of menus attached to the content. * These can be controlled from the templates, or programmatically using the [MenuController](../../app/MenuController). * * @usage * * ```html * * * *

some menu content, could be list items

*
*
*
* * * ``` * * To add a menu to an app, the `` element should be added as a sibling to the `ion-nav` it will belongs * to. A [local variable](https://angular.io/docs/ts/latest/guide/user-input.html#local-variables) * should be added to the `ion-nav` and passed to the `ion-menu`s `content` property. * * This tells the menu what it is bound to and what element to watch for gestures. * In the below example, `content` is using [property binding](https://angular.io/docs/ts/latest/guide/template-syntax.html#!#property-binding) * because `mycontent` is a reference to the `` element, and not a string. * * * ### Opening/Closing Menus * * There are several ways to open or close a menu. The menu can be **toggled** open or closed * from the template using the [MenuToggle](../MenuToggle) directive. It can also be * **closed** from the template using the [MenuClose](../MenuClose) directive. To display a menu * programmatically, inject the [MenuController](../MenuController) provider and call any of the * `MenuController` methods. * * * ### Menu Types * * The menu supports several display types: `overlay`, `reveal` and `push`. By default, * it will use the correct type based on the mode, but this can be changed. The default * type for both Material Design and Windows mode is `overlay`, and `reveal` is the default * type for iOS mode. The menu type can be changed in the app's [config](../../config/Config) * via the `menuType` property, or passed in the `type` property on the `` element. * See [usage](#usage) below for examples of changing the menu type. * * * ### Navigation Bar Behavior * * If a [MenuToggle](../MenuToggle) button is added to the [Navbar](../../navbar/Navbar) of * a page, the button will only appear when the page it's in is currently a root page. The * root page is the initial page loaded in the app, or a page that has been set as the root * using the [setRoot](../../nav/NavController/#setRoot) method on the [NavController](../../nav/NavController). * * For example, say the application has two pages, `Page1` and `Page2`, and both have a * `MenuToggle` button in their navigation bars. Assume the initial page loaded into the app * is `Page1`, making it the root page. `Page1` will display the `MenuToggle` button, but once * `Page2` is pushed onto the navigation stack, the `MenuToggle` will not be displayed. * * * ### Persistent Menus * * Persistent menus display the [MenuToggle](../MenuToggle) button in the [Navbar](../../navbar/Navbar) * on all pages in the navigation stack. To make a menu persistent set `persistent` to `true` on the * `` element. Note that this will only affect the `MenuToggle` button in the `Navbar` attached * to the `Menu` with `persistent` set to true, any other `MenuToggle` buttons will not be affected. * ### Menu Side * * By default, menus slide in from the left, but this can be overridden by passing `right` * to the `side` property: * * ```html * ... * ``` * * * ### Menu Type * * The menu type can be changed by passing the value to `type` on the ``: * * ```html * ... * ``` * * It can also be set in the app's config. The below will set the menu type to * `push` for all modes, and then set the type to `overlay` for the `ios` mode. * * ```ts * // in NgModules * * imports: [ * IonicModule.forRoot(MyApp,{ * menuType: 'push', * platforms: { * ios: { * menuType: 'overlay', * } * } * }) * ], * ``` * * * ### Displaying the Menu * * To toggle a menu from the template, add a button with the `menuToggle` * directive anywhere in the page's template: * * ```html * * ``` * * To close a menu, add the `menuClose` button. It can be added anywhere * in the content, or even the menu itself. Below it is added to the menu's * content: * * ```html * * * * Close Menu * * * * ``` * * See the [MenuToggle](../MenuToggle) and [MenuClose](../MenuClose) docs * for more information on these directives. * * The menu can also be controlled from the Page by using the `MenuController`. * Inject the `MenuController` provider into the page and then call any of its * methods. In the below example, the `openMenu` method will open the menu * when it is called. * * ```ts * import { Component } from '@angular/core'; * import { MenuController } from 'ionic-angular'; * * @Component({...}) * export class MyPage { * constructor(public menuCtrl: MenuController) {} * * openMenu() { * this.menuCtrl.open(); * } * } * ``` * * See the [MenuController](../../app/MenuController) API docs for all of the methods * and usage information. * * * @demo /docs/demos/src/menu/ * * @see {@link /docs/components#menus Menu Component Docs} * @see {@link ../../app/MenuController MenuController API Docs} * @see {@link ../../nav/Nav Nav API Docs} * @see {@link ../../nav/NavController NavController API Docs} */ var Menu = (function () { function Menu(_menuCtrl, _elementRef, _config, _plt, _renderer, _keyboard, _gestureCtrl, _domCtrl, _app) { this._menuCtrl = _menuCtrl; this._elementRef = _elementRef; this._config = _config; this._plt = _plt; this._renderer = _renderer; this._keyboard = _keyboard; this._gestureCtrl = _gestureCtrl; this._domCtrl = _domCtrl; this._app = _app; this._isSwipeEnabled = true; this._isAnimating = false; this._isPersistent = false; this._init = false; this._isPane = false; /** * @hidden */ this.isOpen = false; /** * @hidden */ this.isRightSide = false; /** * @output {event} Emitted when the menu is being dragged open. */ this.ionDrag = new EventEmitter(); /** * @output {event} Emitted when the menu has been opened. */ this.ionOpen = new EventEmitter(); /** * @output {event} Emitted when the menu has been closed. */ this.ionClose = new EventEmitter(); this._events = new UIEventManager(_plt); this._gestureBlocker = _gestureCtrl.createBlocker({ disable: [GESTURE_GO_BACK_SWIPE] }); this.side = 'start'; } Object.defineProperty(Menu.prototype, "enabled", { /** * @input {boolean} If true, the menu is enabled. Default `true`. */ get: function () { return this._isEnabled; }, set: function (val) { var isEnabled = isTrueProperty(val); this.enable(isEnabled); }, enumerable: true, configurable: true }); Object.defineProperty(Menu.prototype, "side", { /** * @input {string} Which side of the view the menu should be placed. Default `"left"`. */ get: function () { return this._side; }, set: function (val) { this.isRightSide = isRightSide(val, this._plt.isRTL); if (this.isRightSide) { this._side = 'right'; } else { this._side = 'left'; } }, enumerable: true, configurable: true }); Object.defineProperty(Menu.prototype, "swipeEnabled", { /** * @input {boolean} If true, swiping the menu is enabled. Default `true`. */ get: function () { return this._isSwipeEnabled; }, set: function (val) { var isEnabled = isTrueProperty(val); this.swipeEnable(isEnabled); }, enumerable: true, configurable: true }); Object.defineProperty(Menu.prototype, "persistent", { /** * @input {boolean} If true, the menu will persist on child pages. */ get: function () { return this._isPersistent; }, set: function (val) { this._isPersistent = isTrueProperty(val); }, enumerable: true, configurable: true }); /** * @hidden */ Menu.prototype.ngOnInit = function () { var _this = this; this._init = true; var content = this.content; this._cntEle = (content instanceof Node) ? content : content && content.getNativeElement && content.getNativeElement(); // requires content element if (!this._cntEle) { return console.error('Menu: must have a [content] element to listen for drag events on. Example:\n\n\n\n'); } this.setElementAttribute('side', this._side); // normalize the "type" if (!this.type) { this.type = this._config.get('menuType'); } this.setElementAttribute('type', this.type); // add the gestures this._gesture = new MenuContentGesture(this._plt, this, this._gestureCtrl, this._domCtrl); // add menu's content classes this._cntEle.classList.add('menu-content'); this._cntEle.classList.add('menu-content-' + this.type); var isEnabled = this._isEnabled; if (isEnabled === true || typeof isEnabled === 'undefined') { // check if more than one menu is on the same side isEnabled = !this._menuCtrl.getMenus().some(function (m) { return m.side === _this.side && m.enabled; }); } // register this menu with the app's menu controller this._menuCtrl._register(this); // mask it as enabled / disabled this.enable(isEnabled); }; /** * @hidden */ Menu.prototype.onBackdropClick = function (ev) { ev.preventDefault(); ev.stopPropagation(); this._menuCtrl.close(); }; /** * @hidden */ Menu.prototype._getType = function () { if (!this._type) { this._type = MenuController.create(this.type, this, this._plt); if (this._config.get('animate') === false) { this._type.ani.duration(0); } } return this._type; }; /** * @hidden */ Menu.prototype.setOpen = function (shouldOpen, animated) { var _this = this; if (animated === void 0) { animated = true; } // If the menu is disabled or it is currenly being animated, let's do nothing if ((shouldOpen === this.isOpen) || !this._canOpen() || this._isAnimating) { return Promise.resolve(this.isOpen); } return new Promise(function (resolve) { _this._before(); _this._getType().setOpen(shouldOpen, animated, function () { _this._after(shouldOpen); resolve(_this.isOpen); }); }); }; Menu.prototype._forceClosing = function () { var _this = this; (void 0) /* assert */; this._isAnimating = true; this._getType().setOpen(false, false, function () { _this._after(false); }); }; /** * @hidden */ Menu.prototype.canSwipe = function () { return this._isSwipeEnabled && !this._isAnimating && this._canOpen() && this._app.isEnabled(); }; /** * @hidden */ Menu.prototype.isAnimating = function () { return this._isAnimating; }; Menu.prototype._swipeBeforeStart = function () { if (!this.canSwipe()) { (void 0) /* assert */; return; } this._before(); }; Menu.prototype._swipeStart = function () { if (!this._isAnimating) { (void 0) /* assert */; return; } this._getType().setProgressStart(this.isOpen); }; Menu.prototype._swipeProgress = function (stepValue) { if (!this._isAnimating) { (void 0) /* assert */; return; } this._getType().setProgessStep(stepValue); var ionDrag = this.ionDrag; if (ionDrag.observers.length > 0) { ionDrag.emit(stepValue); } }; Menu.prototype._swipeEnd = function (shouldCompleteLeft, shouldCompleteRight, stepValue, velocity) { var _this = this; if (!this._isAnimating) { (void 0) /* assert */; return; } // user has finished dragging the menu var isRightSide = this.isRightSide; var isRTL = this._plt.isRTL; var opening = !this.isOpen; var shouldComplete = (opening) ? (isRightSide !== isRTL) ? shouldCompleteLeft : shouldCompleteRight : (isRightSide !== isRTL) ? shouldCompleteRight : shouldCompleteLeft; this._getType().setProgressEnd(shouldComplete, stepValue, velocity, function (isOpen) { (void 0) /* console.debug */; _this._after(isOpen); }); }; Menu.prototype._before = function () { (void 0) /* assert */; // this places the menu into the correct location before it animates in // this css class doesn't actually kick off any animations this.setElementClass('show-menu', true); this.backdrop.setElementClass('show-backdrop', true); this.resize(); this._keyboard.close(); this._isAnimating = true; }; Menu.prototype._after = function (isOpen) { (void 0) /* assert */; this._app.setEnabled(false, 100); // keep opening/closing the menu disabled for a touch more yet // only add listeners/css if it's enabled and isOpen // and only remove listeners/css if it's not open // emit opened/closed events this.isOpen = isOpen; this._isAnimating = false; this._events.unlistenAll(); if (isOpen) { // Disable swipe to go back gesture this._gestureBlocker.block(); this._cntEle.classList.add('menu-content-open'); var callback = this.onBackdropClick.bind(this); this._events.listen(this._cntEle, 'click', callback, { capture: true }); this._events.listen(this.backdrop.getNativeElement(), 'click', callback, { capture: true }); this.ionOpen.emit(true); } else { // Enable swipe to go back gesture this._gestureBlocker.unblock(); this._cntEle.classList.remove('menu-content-open'); this.setElementClass('show-menu', false); this.backdrop.setElementClass('show-menu', false); this.ionClose.emit(true); } }; /** * @hidden */ Menu.prototype.open = function () { return this.setOpen(true); }; /** * @hidden */ Menu.prototype.close = function () { return this.setOpen(false); }; /** * @hidden */ Menu.prototype.resize = function () { var content = this.menuContent ? this.menuContent : this.menuNav; content && content.resize(); }; /** * @hidden */ Menu.prototype.toggle = function () { return this.setOpen(!this.isOpen); }; Menu.prototype._canOpen = function () { return this._isEnabled && !this._isPane; }; /** * @hidden */ Menu.prototype._updateState = function () { var canOpen = this._canOpen(); // Close menu inmediately if (!canOpen && this.isOpen) { (void 0) /* assert */; // close if this menu is open, and should not be enabled this._forceClosing(); } if (this._isEnabled && this._menuCtrl) { this._menuCtrl._setActiveMenu(this); } if (!this._init) { return; } var gesture = this._gesture; // only listen/unlisten if the menu has initialized if (canOpen && this._isSwipeEnabled && !gesture.isListening) { // should listen, but is not currently listening (void 0) /* console.debug */; gesture.listen(); } else if (gesture.isListening && (!canOpen || !this._isSwipeEnabled)) { // should not listen, but is currently listening (void 0) /* console.debug */; gesture.unlisten(); } if (this.isOpen || (this._isPane && this._isEnabled)) { this.resize(); } (void 0) /* assert */; }; /** * @hidden */ Menu.prototype.enable = function (shouldEnable) { this._isEnabled = shouldEnable; this.setElementClass('menu-enabled', shouldEnable); this._updateState(); return this; }; /** * @internal */ Menu.prototype.initPane = function () { return false; }; /** * @internal */ Menu.prototype.paneChanged = function (isPane) { this._isPane = isPane; this._updateState(); }; /** * @hidden */ Menu.prototype.swipeEnable = function (shouldEnable) { this._isSwipeEnabled = shouldEnable; this._updateState(); return this; }; /** * @hidden */ Menu.prototype.getNativeElement = function () { return this._elementRef.nativeElement; }; /** * @hidden */ Menu.prototype.getMenuElement = function () { return this.getNativeElement().querySelector('.menu-inner'); }; /** * @hidden */ Menu.prototype.getContentElement = function () { return this._cntEle; }; /** * @hidden */ Menu.prototype.getBackdropElement = function () { return this.backdrop.getNativeElement(); }; /** * @hidden */ Menu.prototype.width = function () { return this.getMenuElement().offsetWidth; }; /** * @hidden */ Menu.prototype.getMenuController = function () { return this._menuCtrl; }; /** * @hidden */ Menu.prototype.setElementClass = function (className, add) { this._renderer.setElementClass(this._elementRef.nativeElement, className, add); }; /** * @hidden */ Menu.prototype.setElementAttribute = function (attributeName, value) { this._renderer.setElementAttribute(this._elementRef.nativeElement, attributeName, value); }; /** * @hidden */ Menu.prototype.getElementRef = function () { return this._elementRef; }; /** * @hidden */ Menu.prototype.ngOnDestroy = function () { this._menuCtrl._unregister(this); this._events.destroy(); this._gesture && this._gesture.destroy(); this._type && this._type.destroy(); this._gesture = null; this._type = null; this._cntEle = null; }; Menu.decorators = [ { type: Component, args: [{ selector: 'ion-menu', template: '' + '', host: { 'role': 'navigation' }, changeDetection: ChangeDetectionStrategy.OnPush, encapsulation: ViewEncapsulation.None, providers: [{ provide: RootNode, useExisting: forwardRef(function () { return Menu; }) }] },] }, ]; /** @nocollapse */ Menu.ctorParameters = function () { return [ { type: MenuController, }, { type: ElementRef, }, { type: Config, }, { type: Platform, }, { type: Renderer, }, { type: Keyboard, }, { type: GestureController, }, { type: DomController, }, { type: App, }, ]; }; Menu.propDecorators = { 'backdrop': [{ type: ViewChild, args: [Backdrop,] },], 'menuContent': [{ type: ContentChild, args: [Content,] },], 'menuNav': [{ type: ContentChild, args: [Nav,] },], 'content': [{ type: Input },], 'id': [{ type: Input },], 'type': [{ type: Input },], 'enabled': [{ type: Input },], 'side': [{ type: Input },], 'swipeEnabled': [{ type: Input },], 'persistent': [{ type: Input },], 'maxEdgeStart': [{ type: Input },], 'ionDrag': [{ type: Output },], 'ionOpen': [{ type: Output },], 'ionClose': [{ type: Output },], }; return Menu; }()); export { Menu }; //# sourceMappingURL=menu.js.map