123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318 |
- import { removeArrayItem } from '../../util/util';
- /**
- * @name MenuController
- * @description
- * The MenuController is a provider which makes it easy to control a [Menu](../../Menu/Menu/).
- * Its methods can be used to display the menu, enable the menu, toggle the menu, and more.
- * The controller will grab a reference to the menu by the `side`, `id`, or, if neither
- * of these are passed to it, it will grab the first menu it finds.
- *
- *
- * @usage
- *
- * Add a basic menu component to start with. See the [Menu](../../Menu/Menu/) API docs
- * for more information on adding menu components.
- *
- * ```html
- * <ion-menu [content]="mycontent">
- * <ion-content>
- * <ion-list>
- * ...
- * </ion-list>
- * </ion-content>
- * </ion-menu>
- *
- * <ion-nav #mycontent [root]="rootPage"></ion-nav>
- * ```
- *
- * To call the controller methods, inject the `MenuController` provider
- * into the page. Then, create some methods for opening, closing, and
- * toggling the menu.
- *
- * ```ts
- * import { Component } from '@angular/core';
- * import { MenuController } from 'ionic-angular';
- *
- * @Component({...})
- * export class MyPage {
- *
- * constructor(public menuCtrl: MenuController) {
- *
- * }
- *
- * openMenu() {
- * this.menuCtrl.open();
- * }
- *
- * closeMenu() {
- * this.menuCtrl.close();
- * }
- *
- * toggleMenu() {
- * this.menuCtrl.toggle();
- * }
- *
- * }
- * ```
- *
- * Since only one menu exists, the `MenuController` will grab the
- * correct menu and call the correct method for each.
- *
- *
- * ### Multiple Menus on Different Sides
- *
- * For applications with both a left and right menu, the desired menu can be
- * grabbed by passing the `side` of the menu. If nothing is passed, it will
- * default to the `"left"` menu.
- *
- * ```html
- * <ion-menu side="left" [content]="mycontent">...</ion-menu>
- * <ion-menu side="right" [content]="mycontent">...</ion-menu>
- * <ion-nav #mycontent [root]="rootPage"></ion-nav>
- * ```
- *
- * ```ts
- * toggleLeftMenu() {
- * this.menuCtrl.toggle();
- * }
- *
- * toggleRightMenu() {
- * this.menuCtrl.toggle('right');
- * }
- * ```
- *
- *
- * ### Multiple Menus on the Same Side
- *
- * An application can have multiple menus on the same side. In order to determine
- * the menu to control, an `id` should be passed. In the example below, the menu
- * with the `authenticated` id will be enabled, and the menu with the `unauthenticated`
- * id will be disabled.
- *
- * ```html
- * <ion-menu id="authenticated" side="left" [content]="mycontent">...</ion-menu>
- * <ion-menu id="unauthenticated" side="left" [content]="mycontent">...</ion-menu>
- * <ion-nav #mycontent [root]="rootPage"></ion-nav>
- * ```
- *
- * ```ts
- * enableAuthenticatedMenu() {
- * this.menuCtrl.enable(true, 'authenticated');
- * this.menuCtrl.enable(false, 'unauthenticated');
- * }
- * ```
- *
- * Note: if an app only has one menu, there is no reason to pass an `id`.
- *
- *
- * @demo /docs/demos/src/menu/
- *
- * @see {@link /docs/components#menus Menu Component Docs}
- * @see {@link ../Menu Menu API Docs}
- *
- */
- export class MenuController {
- constructor() {
- this._menus = [];
- }
- /**
- * Programatically open the Menu.
- * @param {string} [menuId] Optionally get the menu by its id, or side.
- * @return {Promise} returns a promise when the menu is fully opened
- */
- open(menuId) {
- const menu = this.get(menuId);
- if (menu && !this.isAnimating()) {
- let openedMenu = this.getOpen();
- if (openedMenu && menu !== openedMenu) {
- openedMenu.setOpen(false, false);
- }
- return menu.open();
- }
- return Promise.resolve(false);
- }
- /**
- * Programatically close the Menu. If no `menuId` is given as the first
- * argument then it'll close any menu which is open. If a `menuId`
- * is given then it'll close that exact menu.
- * @param {string} [menuId] Optionally get the menu by its id, or side.
- * @return {Promise} returns a promise when the menu is fully closed
- */
- close(menuId) {
- let menu;
- if (menuId) {
- // find the menu by its id
- menu = this.get(menuId);
- }
- else {
- // find the menu that is open
- menu = this.getOpen();
- }
- if (menu) {
- // close the menu
- return menu.close();
- }
- return Promise.resolve(false);
- }
- /**
- * Toggle the menu. If it's closed, it will open, and if opened, it
- * will close.
- * @param {string} [menuId] Optionally get the menu by its id, or side.
- * @return {Promise} returns a promise when the menu has been toggled
- */
- toggle(menuId) {
- const menu = this.get(menuId);
- if (menu && !this.isAnimating()) {
- var openedMenu = this.getOpen();
- if (openedMenu && menu !== openedMenu) {
- openedMenu.setOpen(false, false);
- }
- return menu.toggle();
- }
- return Promise.resolve(false);
- }
- /**
- * Used to enable or disable a menu. For example, there could be multiple
- * left menus, but only one of them should be able to be opened at the same
- * time. If there are multiple menus on the same side, then enabling one menu
- * will also automatically disable all the others that are on the same side.
- * @param {string} [menuId] Optionally get the menu by its id, or side.
- * @return {Menu} Returns the instance of the menu, which is useful for chaining.
- */
- enable(shouldEnable, menuId) {
- const menu = this.get(menuId);
- if (menu) {
- return menu.enable(shouldEnable);
- }
- }
- /**
- * Used to enable or disable the ability to swipe open the menu.
- * @param {boolean} shouldEnable True if it should be swipe-able, false if not.
- * @param {string} [menuId] Optionally get the menu by its id, or side.
- * @return {Menu} Returns the instance of the menu, which is useful for chaining.
- */
- swipeEnable(shouldEnable, menuId) {
- const menu = this.get(menuId);
- if (menu) {
- return menu.swipeEnable(shouldEnable);
- }
- }
- /**
- * @param {string} [menuId] Optionally get the menu by its id, or side.
- * @return {boolean} Returns true if the specified menu is currently open, otherwise false.
- * If the menuId is not specified, it returns true if ANY menu is currenly open.
- */
- isOpen(menuId) {
- if (menuId) {
- var menu = this.get(menuId);
- return menu && menu.isOpen || false;
- }
- else {
- return !!this.getOpen();
- }
- }
- /**
- * @param {string} [menuId] Optionally get the menu by its id, or side.
- * @return {boolean} Returns true if the menu is currently enabled, otherwise false.
- */
- isEnabled(menuId) {
- const menu = this.get(menuId);
- return menu && menu.enabled || false;
- }
- /**
- * Used to get a menu instance. If a `menuId` is not provided then it'll
- * return the first menu found. If a `menuId` is `left` or `right`, then
- * it'll return the enabled menu on that side. Otherwise, if a `menuId` is
- * provided, then it'll try to find the menu using the menu's `id`
- * property. If a menu is not found then it'll return `null`.
- * @param {string} [menuId] Optionally get the menu by its id, or side.
- * @return {Menu} Returns the instance of the menu if found, otherwise `null`.
- */
- get(menuId) {
- var menu;
- if (menuId === 'left' || menuId === 'right') {
- // there could be more than one menu on the same side
- // so first try to get the enabled one
- menu = this._menus.find(m => m.side === menuId && m.enabled);
- if (menu) {
- return menu;
- }
- // didn't find a menu side that is enabled
- // so try to get the first menu side found
- return this._menus.find(m => m.side === menuId) || null;
- }
- else if (menuId) {
- // the menuId was not left or right
- // so try to get the menu by its "id"
- return this._menus.find(m => m.id === menuId) || null;
- }
- // return the first enabled menu
- menu = this._menus.find(m => m.enabled);
- if (menu) {
- return menu;
- }
- // get the first menu in the array, if one exists
- return (this._menus.length ? this._menus[0] : null);
- }
- /**
- * @return {Menu} Returns the instance of the menu already opened, otherwise `null`.
- */
- getOpen() {
- return this._menus.find(m => m.isOpen);
- }
- /**
- * @return {Array<Menu>} Returns an array of all menu instances.
- */
- getMenus() {
- return this._menus;
- }
- /**
- * @hidden
- * @return {boolean} if any menu is currently animating
- */
- isAnimating() {
- return this._menus.some(menu => menu.isAnimating());
- }
- /**
- * @hidden
- */
- _register(menu) {
- (void 0) /* assert */;
- this._menus.push(menu);
- }
- /**
- * @hidden
- */
- _unregister(menu) {
- (void 0) /* assert */;
- removeArrayItem(this._menus, menu);
- }
- /**
- * @hidden
- */
- _setActiveMenu(menu) {
- (void 0) /* assert */;
- (void 0) /* assert */;
- // if this menu should be enabled
- // then find all the other menus on this same side
- // and automatically disable other same side menus
- const side = menu.side;
- this._menus
- .filter(m => m.side === side && m !== menu)
- .map(m => m.enable(false));
- }
- /**
- * @hidden
- */
- static registerType(name, cls) {
- menuTypes[name] = cls;
- }
- /**
- * @hidden
- */
- static create(type, menuCmp, plt) {
- return new menuTypes[type](menuCmp, plt);
- }
- }
- let menuTypes = {};
- //# sourceMappingURL=menu-controller.js.map
|