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

docs(menu): update some docs and styles

Browse Source
This commit is contained in:
Brandy Carney
2018-07-18 10:44:57 -04:00
parent 12d8174307
commit c3c35b5829
3 changed files with 24 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
core/src/components.d.ts vendored
View File

@ -3814,7 +3814,7 @@ declare global {
'_setOpen': (menu: Menu, shouldOpen: boolean, animated: boolean) => Promise<boolean>;
'_unregister': (menu: Menu) => void;
/**
* Close the Menu. If no `menuId` is given as the first argument then it'll close any menu which is open. If a `menuId` is given then it'll close that exact menu.
* 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.
*/
'close': (menuId?: string | undefined) => Promise<boolean>;
'createAnimation': (type: string, menuCmp: Menu) => Promise<Animation>;
@ -3823,7 +3823,7 @@ declare global {
*/
'enable': (shouldEnable: boolean, menuId?: string | undefined) => HTMLIonMenuElement | null;
/**
* Used to get a menu instance. If a `menuId` is not provided then it'll return the first menu found. If a `menuId` is `left` or `right`, then it'll return the enabled menu on that side. Otherwise, if a `menuId` is provided, then it'll try to find the menu using the menu's `id` property. If a menu is not found then it'll return `null`.
* 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`.
*/
'get': (menuId?: string | undefined) => HTMLIonMenuElement | null;
/**
@ -3835,19 +3835,19 @@ declare global {
*/
'getOpen': () => HTMLIonMenuElement | null;
/**
* If any menu is currently animating
* Returns true if any menu is currently animating.
*/
'isAnimating': () => boolean;
/**
* Returns true or false if the menuId is enabled or not
* Returns true if the specified menu is enabled.
*/
'isEnabled': (menuId?: string | undefined) => boolean;
/**
* 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.
*/
'isOpen': (menuId?: string | undefined) => boolean;
/**
* Open the Menu.
* Open the menu.
*/
'open': (menuId?: string | undefined) => Promise<boolean>;
'registerAnimation': (name: string, animation: AnimationBuilder) => void;