Menu

Menu API requires node-webkit >= 0.3.0

Menu represents a native menu, it can be used as window menu or context menu.

Synopsis

// Load native UI library
var gui = require('nw.gui');

// Create an empty menu
var menu = new gui.Menu();

// Add some items
menu.append(new gui.MenuItem({ label: 'Item A' }));
menu.append(new gui.MenuItem({ label: 'Item B' }));
menu.append(new gui.MenuItem({ type: 'separator' }));
menu.append(new gui.MenuItem({ label: 'Item C' }));

// Remove one item
menu.removeAt(1);

// Popup as context menu
menu.popup(10, 10);

// Iterate menu's items
for (var i = 0; i < menu.items.length; ++i) {
  console.log(menu.items[i]);
}

Reference

new Menu([option])

Create a new Menu.

If no option is specified, a normal context menu will be created. To create a menu to be used as window's menu, you need to explicitly specify 'type': 'menubar' in the option, e.g. new Menu({ 'type': 'menubar' }).

Menu.items

Get an array that contains all items of a menu.

Menu.items.length

Get how many items this Menu has.

Menu.items[i]

Get the ith menu item of the Menu. It will return a MenuItem object.

Menu.append(MenuItem item)

Append item of MenuItem type to the tail of the Menu.

Menu.insert(MenuItem item, int i)

Insert item of MenuItem type to the ith position of the Menu, Menu is 0-indexed.

Menu.remove(MenuItem item)

Remove item from Menu. This method requires you to keep the MenuItem outside the Menu.

Menu.removeAt(int i)

Remove the ith item form Menu

Menu.item[x].click

Reference: x is the index of the menu object.

  menu.items[x].click = function() { 
      console.log('clicked');
  };

Menu.popup(int x, int y)

Popup the Menu at position (x, y) in current window. Usually you would listen to contextmenu event of DOM elements and manually popup the menu:

document.body.addEventListener('contextmenu', function(ev) { 
  ev.preventDefault();
  menu.popup(ev.x, ev.y);
  return false;
});

In this way, you can precisely choose which menu to show for different elements, and you can update menu elements just before popuping it.

See also

• Tray
• MenuItem
• Example of cut/copy/paste context menu implementation