Class default

Hierarchy

Constructors

constructor

Properties

all allowNoMenus chain event

Accessors

screen visible

Methods

await back backToFirst clearChain get removeFromChain setTop show

Constructors

constructor

  • Parameters

    • screen: default
    • allowNoMenus: boolean = false

    Returns default

Properties

all

all: Record<number, default> = {}

allowNoMenus

allowNoMenus: boolean = false

chain

chain: default[] = []

Readonly event

event: IEventEmitter<default, IMenuManagerEvents> = ...

Accessors

screen

  • get screen(): default

  • Returns default

visible

  • get visible(): undefined | default

  • Returns the visible menu (top of the chain)

    Returns undefined | default

Methods

await

  • Returns a promise that resolves when the given screen is shown.

    Type Parameters

    Parameters

    • menuId: MENU

    Returns Promise<MenuById[MENU]>

back

  • Returns false | void | Promise<void>

backToFirst

  • Returns void | Promise<void>

clearChain

  • Returns default

get

  • Gets the menu by the given ID, initializing it if it does not already exist.

    Type Parameters

    Parameters

    • menuId: ID

    Returns MenuById[ID]

removeFromChain

  • Parameters

    Returns default

setTop

  • Sets the visible menu to be the new top menu. (Removes super-menus, keeps sub-menus)

    Returns default

  • Sets the given menu to be the new top menu. (Removes super-menus, keeps sub-menus)

    Parameters

    Returns default

show

  • Type Parameters

    Parameters

    • menu: MENU
    • Optional menuInitializer: ((menu: MENU extends MenuId ? MenuById[MENU] : MENU) => any)

    Returns void | Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc