From fc49d1aa290d04b4152bd9f15b80fb029d013cf0 Mon Sep 17 00:00:00 2001 From: Adam Bradley Date: Thu, 4 Feb 2016 20:32:24 -0600 Subject: [PATCH] docs(menu): update menuToggle menuClose docs --- ionic/components/menu/menu-close.ts | 37 ++++++++++++------------- ionic/components/menu/menu-toggle.ts | 40 +++++++++++++--------------- 2 files changed, 38 insertions(+), 39 deletions(-) diff --git a/ionic/components/menu/menu-close.ts b/ionic/components/menu/menu-close.ts index 04a24ad663..b8ffea7760 100644 --- a/ionic/components/menu/menu-close.ts +++ b/ionic/components/menu/menu-close.ts @@ -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 - * - * - * - * Close the menu - * - * - * + * @name MenuClose + * @description + * The `menuClose` directive can be placed on any button to + * automatically close an open menu. * - * + * @usage + * ```html + * * ``` -* @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 + * + * ``` + * + * @demo /docs/v2/demos/menu/ + * @see {@link /docs/v2/components#menus Menu Component Docs} + * @see {@link ../../menu/Menu Menu API Docs} + */ @Directive({ selector: '[menuClose]' }) diff --git a/ionic/components/menu/menu-toggle.ts b/ionic/components/menu/menu-toggle.ts index 0061321cd0..05180d52b4 100644 --- a/ionic/components/menu/menu-toggle.ts +++ b/ionic/components/menu/menu-toggle.ts @@ -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 - * - *

Page 1

- * - *
+ * @name MenuToggle + * @description + * The `menuToggle` directive can be placed on any button to + * automatically close an open menu. * + * @usage + * ```html + * * ``` -* @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 + * + * ``` + * + * @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