Menu

Menu

Extends: Deletable

Extended by: BarMenu

Use the Menu class to create a context menu. Menus can contain custom entries and hierarchy, or existing actions and tools.

new Menu( id, template[, options] )

Creates a new context menu

Arguments:

• id: string
• template: Array of MenuItem or See types
• options: MenuOptions (Optional)
  • onOpen: Function (Optional)
  • onClose: Function (Optional)
  • keep_open: boolean (Optional)
  • searchable: boolean (Optional)
  • class: string (Optional)

new Menu( template[, options] )

Alternative constructor signature

Property	Type	Description
structure	Array of MenuItem

open( position[, context] )

Opens the menu somewhere

Arguments:

• position: HTMLElement or MouseEvent - Position where to open the menu. Can be a mouse event, or a node that the menu is spawned below.
• context: any (Optional) - Context for the click events inside the menu

Returns: Menu

hide()

Closes the menu if it's open

Returns: Menu

addAction( action[, path] )

Adds an action to the menu structure

Arguments:

• action: Action - Action to add
• path: string or number (Optional) - Path pointing to the location. Use the ID of each level of the menu, or index within a level, separated by a point. For example, export.0 places the action at the top position of the Export submenu.

removeAction( path )

Arguments:

• path: string or Action - Path pointing to the location. Use the ID of each level of the menu, or index within a level, or item ID, separated by a point. For example, export.export_special_format removes the action "Export Special Format" from the Export submenu.

delete()

BarMenu

Extends: Menu

Creates a new menu in the menu bar

new BarMenu( id, structure[, condition] )

Creates a new BarMenu

Arguments:

• id: string
• structure: Array of MenuItem
• condition: ConditionResolvable (Optional)

Property	Type	Description
type	"bar_menu"
id	string
condition	ConditionResolvable
name	string
structure	Array of MenuItem

open( position[, context] )

Opens the menu somewhere

Arguments:

• position: HTMLElement or MouseEvent - Position where to open the menu. Can be a mouse event, or a node that the menu is spawned below.
• context: any (Optional) - Context for the click events inside the menu

Returns: BarMenu

hide()

Closes the menu if it's open

Returns: BarMenu

addAction( action[, path] )

Adds an action to the menu structure

Arguments:

• action: Action - Action to add
• path: string or number (Optional) - Path pointing to the location. Use the ID of each level of the menu, or index within a level, separated by a point. For example, export.0 places the action at the top position of the Export submenu.

removeAction( path )

Arguments:

• path: string or Action - Path pointing to the location. Use the ID of each level of the menu, or index within a level, or item ID, separated by a point. For example, export.export_special_format removes the action "Export Special Format" from the Export submenu.

highlight( action )

Visually highlights an action within the menu, until the user opens the menu

Arguments:

• action: Action

delete()

MenuBar

Namespace

Property	Type	Description
menus	See types

addAction( action[, path] )

Adds an action to the menu structure

Arguments:

• action: Action - Action to add
• path: string (Optional) - Path pointing to the location. Use the ID of each level of the menu, or index or group within a level, separated by a point. For example, file.export.0 places the action at the top position of the Export submenu in the File menu.

removeAction( path )

Arguments:

• path: string - Path pointing to the location. Use the ID of each level of the menu, or index or group within a level, or item ID, separated by a point. For example, export.export_special_format removes the action "Export Special Format" from the Export submenu.

update()

Update the menu bar