javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-20 20:33:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(menu): update menuToggle menuClose docs

Browse Source
This commit is contained in:
Adam Bradley
2016-02-04 20:32:24 -06:00
parent 9f906ae8ae
commit fc49d1aa29
2 changed files with 38 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
ionic/components/menu/menu-close.ts
View File

@ -6,20 +6,21 @@ import {MenuController} from './menu-controller';
/** /**
* @name MenuClose * @name MenuClose
* @description * @description
* Place `menuClose` on a button to automatically close an open menu. * The `menuClose` directive can be placed on any button to
* automatically close an open menu.
* *
* @usage * @usage
* ```html * ```html
* <ion-menu [content]="mycontent"> * <button menuClose>Close Menu</button>
* <ion-content>
* <ion-list>
* <ion-item menuClose>Close the menu</ion-item>
* </ion-list>
* </ion-content>
* </ion-menu>
*
* <ion-nav #mycontent [root]="rootPage"></ion-nav>
* ``` * ```
*
* To close a certain menu by its id or side, give the `menuClose`
* directive a value.
*
* ```html
* <button menuClose="left">Close Left Menu</button>
* ```
*
* @demo /docs/v2/demos/menu/ * @demo /docs/v2/demos/menu/
* @see {@link /docs/v2/components#menus Menu Component Docs} * @see {@link /docs/v2/components#menus Menu Component Docs}
* @see {@link ../../menu/Menu Menu API Docs} * @see {@link ../../menu/Menu Menu API Docs}

22
ionic/components/menu/menu-toggle.ts
View File

@ -4,21 +4,24 @@ import {ViewController} from '../nav/view-controller';
import {Navbar} from '../navbar/navbar'; import {Navbar} from '../navbar/navbar';
import {MenuController} from './menu-controller'; import {MenuController} from './menu-controller';
/** /**
* @name MenuToggle * @name MenuToggle
* @description * @description
* Toggle a menu by placing this directive on any item. * The `menuToggle` directive can be placed on any button to
* Note that the menu's id must be either `leftMenu` or `rightMenu` * automatically close an open menu.
* *
* @usage * @usage
* ```html * ```html
*<ion-content>
* <h3>Page 1</h3>
* <button menuToggle>Toggle Menu</button> * <button menuToggle>Toggle Menu</button>
*</ion-content>
*
* ``` * ```
*
* To toggle a certain menu by its id or side, give the `menuToggle`
* directive a value.
*
* ```html
* <button menuToggle="right">Toggle Right Menu</button>
* ```
*
* @demo /docs/v2/demos/menu/ * @demo /docs/v2/demos/menu/
* @see {@link /docs/v2/components#menus Menu Component Docs} * @see {@link /docs/v2/components#menus Menu Component Docs}
* @see {@link ../../menu/Menu Menu API Docs} * @see {@link ../../menu/Menu Menu API Docs}
@ -49,11 +52,6 @@ export class MenuToggle {
@Optional() private _navbar: Navbar @Optional() private _navbar: Navbar
) { ) {
this._inNavbar = !!_navbar; this._inNavbar = !!_navbar;
// Deprecation warning
if (this._inNavbar && elementRef.nativeElement.tagName === 'A') {
console.warn('Menu toggles within a navbar should use <button menuToggle> instead of <a menu-toggle>')
}
} }
/** /**