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

docs(menu-controller): update docs

Browse Source
This commit is contained in:
Manu Mtz.-Almeida
2018-07-24 00:00:47 +02:00
parent 5c0e9e6f10
commit 0ed9406e8b
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
core/src/components/menu-controller/readme.md
View File

@ -22,9 +22,8 @@ The MenuController makes it easy to control a Menu. Its methods can be used to d
#### close() #### close()
Close the Menu. If no `menuId` is given as the first Close the menu. If no menu is specified, then it will close any menu
argument then it'll close any menu which is open. If a `menuId` that is open. If a menu is specified, it will close that menu.
is given then it'll close that exact menu.
#### createAnimation() #### createAnimation()
@ -40,11 +39,11 @@ will also automatically disable all the others that are on the same side.
#### get() #### get()
Used to get a menu instance. If a `menuId` is not provided then it'll Used to get a menu instance. If a menu is not provided then it will
return the first menu found. If a `menuId` is `left` or `right`, then return the first menu found. If the specified menu is `left` or `right`, then
it'll return the enabled menu on that side. Otherwise, if a `menuId` is it will return the enabled menu on that side. Otherwise, it will try to find
provided, then it'll try to find the menu using the menu's `id` the menu using the menu's `id` property. If a menu is not found then it will
property. If a menu is not found then it'll return `null`. return `null`.
#### getMenus() #### getMenus()
@ -59,22 +58,23 @@ Returns the instance of the menu already opened, otherwise `null`.
#### isAnimating() #### isAnimating()
If any menu is currently animating Returns true if any menu is currently animating.
#### isEnabled() #### isEnabled()
Returns true or false if the menuId is enabled or not Returns true if the specified menu is enabled.
#### isOpen() #### isOpen()
If the menuId is not specified, it returns true if ANY menu is currenly open. Returns true if the specified menu is open. If the menu is not specified, it
will return true if any menu is currently open.
#### open() #### open()
Open the Menu. Open the menu.
#### registerAnimation() #### registerAnimation()