Interface SidebarMenuServiceInterface

interface SidebarMenuServiceInterface {
    items: SidebarMenuItemInterface[];
    closeMenu(): void;
    getActiveItem(): SidebarMenuItemInterface;
    goToItem(item): Promise<void>;
    goToRoot(): void;
    openMenu(): void;
}

Properties

Menu items organized in a tree structure with an array on the root level.

Supported actions that can be performed on the retrieved items structure:

  • Adding new items in any place of the tree
  • Updating existing items
  • Deleting existing items

Returns

Methods

  • Slides the Sidebar Menu user interface out of view.

    Returns void

  • Opens the SidebarMenuItemInterface.

    Note: only works for items that are visible in the menu.

    Parameters

    Returns Promise<void>

    Promise that resolves when navigation has completed and rejects if user has canceled the action (e.g. to keep unsaved changes in the current view).

  • Slides the Sidebar Menu user interface into view.

    Returns void

Generated using TypeDoc