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

chore(): update to latest stencil

Browse Source
This commit is contained in:
Manu Mtz.-Almeida
2018-08-12 12:04:27 +02:00
parent 149039bd12
commit d856ecfbbf
101 changed files with 1098 additions and 8675 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -8,88 +8,25 @@ The MenuController makes it easy to control a Menu. Its methods can be used to d
## Methods
#### _register()
#### _setActiveMenu()
#### _setOpen()
#### _unregister()
#### close()
Close the menu. If no menu is specified, then it will close any menu
that is open. If a menu is specified, it will close that menu.
#### createAnimation()
#### enable()
Used to enable or disable a menu. For example, there could be multiple
left menus, but only one of them should be able to be opened at the same
time. If there are multiple menus on the same side, then enabling one menu
will also automatically disable all the others that are on the same side.
#### get()
Used to get a menu instance. If a menu is not provided then it will
return the first menu found. If the specified menu is `left` or `right`, then
it will return the enabled menu on that side. Otherwise, it will try to find
the menu using the menu's `id` property. If a menu is not found then it will
return `null`.
#### getMenus()
Returns an array of all menu instances.
#### getOpen()
Returns the instance of the menu already opened, otherwise `null`.
#### isAnimating()
Returns true if any menu is currently animating.
#### isEnabled()
Returns true if the specified menu is enabled.
#### isOpen()
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 the menu.
#### registerAnimation()
#### swipeEnable()
Used to enable or disable the ability to swipe open the menu.
#### toggle()
Toggle the menu. If it's closed, it will open, and if opened, it
will close.
| Method | Description |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `_register` | |
| `_setActiveMenu` | |
| `_setOpen` | |
| `_unregister` | |
| `close` | Close the menu. If no menu is specified, then it will close any menu that is open. If a menu is specified, it will close that menu. |
| `createAnimation` | |
| `enable` | Used to enable or disable a menu. For example, there could be multiple left menus, but only one of them should be able to be opened at the same time. If there are multiple menus on the same side, then enabling one menu will also automatically disable all the others that are on the same side. |
| `get` | Used to get a menu instance. If a menu is not provided then it will return the first menu found. If the specified menu is `left` or `right`, then it will return the enabled menu on that side. Otherwise, it will try to find the menu using the menu's `id` property. If a menu is not found then it will return `null`. |
| `getMenus` | Returns an array of all menu instances. |
| `getOpen` | Returns the instance of the menu already opened, otherwise `null`. |
| `isAnimating` | Returns true if any menu is currently animating. |
| `isEnabled` | Returns true if the specified menu is enabled. |
| `isOpen` | 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 the menu. |
| `registerAnimation` | |
| `swipeEnable` | Used to enable or disable the ability to swipe open the menu. |
| `toggle` | Toggle the menu. If it's closed, it will open, and if opened, it will close. |
----------------------------------------------