javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2026-03-13 10:22:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(menu): update the docs for toggle and close

Browse Source 
closes driftyco/ionic-site#393
This commit is contained in:
Brandy Carney
2016-04-29 14:24:31 -04:00
parent 35dee45219
commit e2366bbb11
3 changed files with 14 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -6,10 +6,12 @@ import {MenuController} from './menu-controller';
/**
* @name MenuClose
* @description
* The `menuClose` directive can be placed on any button to
* automatically close an open menu.
* The `menuClose` directive can be placed on any button to close an open menu.
*
* @usage
*
* A simple `menuClose` button can be added using the following markup:
*
* ```html
* <button menuClose>Close Menu</button>
* ```

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

@@ -7,10 +7,16 @@ import {MenuController} from './menu-controller';
/**
* @name MenuToggle
* @description
* The `menuToggle` directive can be placed on any button to
* automatically close an open menu.
* The `menuToggle` directive can be placed on any button to toggle a menu open or closed.
* If it is added to the [NavBar](../../nav/NavBar) of a page, the button will only appear
* when the page it's in is currently a root page. See the [Menu Navigation Bar Behavior](../Menu#navigation-bar-behavior)
* docs for more information.
*
*
* @usage
*
* A simple `menuToggle` button can be added using the following markup:
*
* ```html
* <button menuToggle>Toggle Menu</button>
* ```

4
ionic/components/menu/menu.ts
View File

@@ -44,8 +44,8 @@ import {isTrueProperty} from '../../util/util';
*
* If a [MenuToggle](../MenuToggle) button is added to the [NavBar](../../nav/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 it can be set using the [setRoot](../../nav/NavController/#setRoot)
* method on the [NavController](../../nav/NavController).
* 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