mirror of https://github.com/ghostfolio/ghostfolio
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
78 lines
3.8 KiB
78 lines
3.8 KiB
import type { MenuControllerI, AnimationBuilder, MenuI, Animation } from '@ionic/core/components';
|
|
export declare class MenuController implements MenuControllerI {
|
|
private menuController;
|
|
constructor(menuController: MenuControllerI);
|
|
/**
|
|
* Programmatically open the Menu.
|
|
* @param [menuId] Optionally get the menu by its id, or side.
|
|
* @return returns a promise when the menu is fully opened
|
|
*/
|
|
open(menuId?: string): Promise<boolean>;
|
|
/**
|
|
* Programmatically 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.
|
|
* @param [menuId] Optionally get the menu by its id, or side.
|
|
* @return returns a promise when the menu is fully closed
|
|
*/
|
|
close(menuId?: string): Promise<boolean>;
|
|
/**
|
|
* Toggle the menu. If it's closed, it will open, and if opened, it
|
|
* will close.
|
|
* @param [menuId] Optionally get the menu by its id, or side.
|
|
* @return returns a promise when the menu has been toggled
|
|
*/
|
|
toggle(menuId?: string): Promise<boolean>;
|
|
/**
|
|
* 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.
|
|
* @param [menuId] Optionally get the menu by its id, or side.
|
|
* @return Returns the instance of the menu, which is useful for chaining.
|
|
*/
|
|
enable(shouldEnable: boolean, menuId?: string): Promise<HTMLIonMenuElement | undefined>;
|
|
/**
|
|
* Used to enable or disable the ability to swipe open the menu.
|
|
* @param shouldEnable True if it should be swipe-able, false if not.
|
|
* @param [menuId] Optionally get the menu by its id, or side.
|
|
* @return Returns the instance of the menu, which is useful for chaining.
|
|
*/
|
|
swipeGesture(shouldEnable: boolean, menuId?: string): Promise<HTMLIonMenuElement | undefined>;
|
|
/**
|
|
* @param [menuId] Optionally get the menu by its id, or side.
|
|
* @return Returns true if the specified menu is currently open, otherwise false.
|
|
* If the menuId is not specified, it returns true if ANY menu is currenly open.
|
|
*/
|
|
isOpen(menuId?: string): Promise<boolean>;
|
|
/**
|
|
* @param [menuId] Optionally get the menu by its id, or side.
|
|
* @return Returns true if the menu is currently enabled, otherwise false.
|
|
*/
|
|
isEnabled(menuId?: string): Promise<boolean>;
|
|
/**
|
|
* 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`.
|
|
* @param [menuId] Optionally get the menu by its id, or side.
|
|
* @return Returns the instance of the menu if found, otherwise `null`.
|
|
*/
|
|
get(menuId?: string): Promise<HTMLIonMenuElement | undefined>;
|
|
/**
|
|
* @return Returns the instance of the menu already opened, otherwise `null`.
|
|
*/
|
|
getOpen(): Promise<HTMLIonMenuElement | undefined>;
|
|
/**
|
|
* @return Returns an array of all menu instances.
|
|
*/
|
|
getMenus(): Promise<HTMLIonMenuElement[]>;
|
|
registerAnimation(name: string, animation: AnimationBuilder): void;
|
|
isAnimating(): Promise<boolean>;
|
|
_getOpenSync(): HTMLIonMenuElement | undefined;
|
|
_createAnimation(type: string, menuCmp: MenuI): Promise<Animation>;
|
|
_register(menu: MenuI): void;
|
|
_unregister(menu: MenuI): void;
|
|
_setOpen(menu: MenuI, shouldOpen: boolean, animated: boolean): Promise<boolean>;
|
|
}
|
|
|