Interface SidebarMenuServiceInterface

Deprecated

Use ApiInterface.ui.topBarService (TopBarServiceInterface) instead.

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

Index

Properties

Methods

closeMenu getActiveItem goToItem goToRoot openMenu

Properties

items

items: SidebarMenuItemInterface[]

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

closeMenu

closeMenu(): Promise<void>

Slides the Sidebar Menu user interface out of view.

Returns Promise<void>

getActiveItem

getActiveItem(): SidebarMenuItemInterface

Get the currently selected SidebarMenuItemInterface.

Returns SidebarMenuItemInterface

goToItem

goToItem(item: SidebarMenuItemInterface): Promise<void>
Opens the SidebarMenuItemInterface.

Note: only works for items that are visible in the menu.
Parameters
- item: SidebarMenuItemInterface
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).

goToRoot

goToRoot(): void

Closes any open SidebarMenuItemInterface and displays the top-level menu items list.

Returns void

openMenu

openMenu(): Promise<void>

Slides the Sidebar Menu user interface into view.

Returns Promise<void>