docs(menuClose): update description

This commit is contained in:
Adam Bradley
2014-11-13 10:51:29 -06:00
parent 8e6ebc6138
commit 18b6e23ba9

View File

@@ -5,9 +5,15 @@
* @restrict AC
*
* @description
* Closes a side menu which is currently opened. By default, navigation
* transitions will not animate between views when the menu is open and
* this directive is used to close the menu.
* Attribute directive which closes a currently opened side menu. By default,
* navigation transitions will not animate between views when the menu is open and
* this directive is used to close the menu. Additionally, this directive
* will reset the history and make the entering view the root of its history
* stack. Having the entering view become the root of the history stack is done
* to replicate the user experience seen on most side menu implementations, which is
* to not show the back button at the root of the stack, and only show the
* menu button. It's recommended to also use the `enable-menu-with-back-views="false"`
* {@link ionic.directive:ionSideMenus} attribute when using the menuClose directive.
*
* @usage
* Below is an example of a link within a side menu. Tapping this link would