ion-menu-controller
The Menu Controller makes it easy to control a Menu. The methods provided can be used to display the menu, enable the menu, toggle the menu, and more. The controller will grab a reference to the menu by the side, or id. if neither of these are passed to it, it will grab the first menu it finds.
Methods
close | |
|---|---|
| Description | Close the menu. If a menu is specified, it will close that menu.
If no menu is specified, then it will close any menu that is open.
If it does not find any open menus, it will return
|
| Signature | close(menu?: string | null | undefined) => Promise<boolean> |
enable | |
| Description | Enable or disable a menu. Disabling a menu will not allow gestures for that menu or any calls to open it. This is useful when there are multiple menus on the same side and only one of them should be allowed to open. Enabling a menu will automatically disable all other menus on that side. |
| Signature | enable(enable: boolean, menu?: string | null | undefined) => Promise<HTMLIonMenuElement | undefined> |
get | |
| Description | Get a menu instance. If a menu is not provided then it will return the first
menu found. If the specified menu is
|
| Signature | get(menu?: string | null | undefined) => Promise<HTMLIonMenuElement | undefined> |
getMenus | |
| Description | Get all menu instances. |
| Signature | getMenus() => Promise<HTMLIonMenuElement[]> |
getOpen | |
| Description | Get the instance of the opened menu. Returns |
| Signature | getOpen() => Promise<HTMLIonMenuElement | undefined> |
isAnimating | |
| Description | Get whether or not a menu is animating. Returns |
| Signature | isAnimating() => Promise<boolean> |
isEnabled | |
| Description | Get whether or not the menu is enabled. Returns |
| Signature | isEnabled(menu?: string | null | undefined) => Promise<boolean> |
isOpen | |
| Description | Get whether or not the menu is open. Returns |
| Signature | isOpen(menu?: string | null | undefined) => Promise<boolean> |
open | |
| Description | Open the menu. If a menu is not provided then it will open the first
menu found. If the specified menu is
|
| Signature | open(menu?: string | null | undefined) => Promise<boolean> |
registerAnimation | |
| Description | Registers a new animation that can be used with any |
| Signature | registerAnimation(name: string, animation: AnimationBuilder | ((menu: MenuI) => IonicAnimation)) => Promise<void> |
swipeGesture | |
| Description | Enable or disable the ability to swipe open the menu. |
| Signature | swipeGesture(enable: boolean, menu?: string | null | undefined) => Promise<HTMLIonMenuElement | undefined> |
toggle | |
| Description | Toggle the menu open or closed. If the menu is already open, it will try to
close the menu, otherwise it will try to open it. Returns
|
| Signature | toggle(menu?: string | null | undefined) => Promise<boolean> |