mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2025-08-20 12:29:55 +08:00
docs(menu): update menuToggle menuClose docs
This commit is contained in:
@ -4,26 +4,27 @@ import {MenuController} from './menu-controller';
|
||||
|
||||
|
||||
/**
|
||||
* @name MenuClose
|
||||
* @description
|
||||
* Place `menuClose` on a button to automatically close an open menu.
|
||||
*
|
||||
* @usage
|
||||
* ```html
|
||||
* <ion-menu [content]="mycontent">
|
||||
* <ion-content>
|
||||
* <ion-list>
|
||||
* <ion-item menuClose>Close the menu</ion-item>
|
||||
* </ion-list>
|
||||
* </ion-content>
|
||||
* </ion-menu>
|
||||
* @name MenuClose
|
||||
* @description
|
||||
* The `menuClose` directive can be placed on any button to
|
||||
* automatically close an open menu.
|
||||
*
|
||||
* <ion-nav #mycontent [root]="rootPage"></ion-nav>
|
||||
* @usage
|
||||
* ```html
|
||||
* <button menuClose>Close Menu</button>
|
||||
* ```
|
||||
* @demo /docs/v2/demos/menu/
|
||||
* @see {@link /docs/v2/components#menus Menu Component Docs}
|
||||
* @see {@link ../../menu/Menu Menu API Docs}
|
||||
*/
|
||||
*
|
||||
* 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/
|
||||
* @see {@link /docs/v2/components#menus Menu Component Docs}
|
||||
* @see {@link ../../menu/Menu Menu API Docs}
|
||||
*/
|
||||
@Directive({
|
||||
selector: '[menuClose]'
|
||||
})
|
||||
|
@ -4,25 +4,28 @@ import {ViewController} from '../nav/view-controller';
|
||||
import {Navbar} from '../navbar/navbar';
|
||||
import {MenuController} from './menu-controller';
|
||||
|
||||
|
||||
/**
|
||||
* @name MenuToggle
|
||||
* @description
|
||||
* Toggle a menu by placing this directive on any item.
|
||||
* Note that the menu's id must be either `leftMenu` or `rightMenu`
|
||||
*
|
||||
* @usage
|
||||
* ```html
|
||||
*<ion-content>
|
||||
* <h3>Page 1</h3>
|
||||
* <button menuToggle>Toggle Menu</button>
|
||||
*</ion-content>
|
||||
* @name MenuToggle
|
||||
* @description
|
||||
* The `menuToggle` directive can be placed on any button to
|
||||
* automatically close an open menu.
|
||||
*
|
||||
* @usage
|
||||
* ```html
|
||||
* <button menuToggle>Toggle Menu</button>
|
||||
* ```
|
||||
* @demo /docs/v2/demos/menu/
|
||||
* @see {@link /docs/v2/components#menus Menu Component Docs}
|
||||
* @see {@link ../../menu/Menu Menu API Docs}
|
||||
*/
|
||||
*
|
||||
* 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/
|
||||
* @see {@link /docs/v2/components#menus Menu Component Docs}
|
||||
* @see {@link ../../menu/Menu Menu API Docs}
|
||||
*/
|
||||
@Directive({
|
||||
selector: '[menuToggle]',
|
||||
host: {
|
||||
@ -49,11 +52,6 @@ export class MenuToggle {
|
||||
@Optional() private _navbar: 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>')
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
|
Reference in New Issue
Block a user