menus.create()

browser.menus.create(
  createProperties, // object
  function() {...}  // optional function
)

Parameters

createProperties

object. Properties for the new menu item.

checkedOptional

boolean. The initial state of a checkbox or radio item: true for selected and false for unselected. Only one radio item can be selected at a time in a given group of radio items.

commandOptional

string. String describing an action that should be taken when the user clicks the item. Possible values are:

• "_execute_browser_action": simulate a click on the extension's browser action, opening its popup if it has one
• "_execute_page_action": simulate a click on the extension's page action, opening its popup if it has one
• "_execute_sidebar_action": open the extension's sidebar

Clicking the item will still trigger the menus.onClicked event, but there's no guarantee of the ordering here: the command may be executed before onClicked fires.

contextsOptional

array of menus.ContextType. Array of contexts in which this menu item will appear. If this option is omitted:

• if the item's parent has contexts set, then this item will inherit its parent's contexts
• otherwise, the item is given a context array of ["page"].

documentUrlPatternsOptional

array of string. Lets you restrict the item to apply only to documents whose URL matches one of the given match patterns. This applies to frames as well.

enabledOptional

boolean. Whether this menu item is enabled or disabled. Defaults to true.

icons Optional

object. One or more custom icons to display next to the item. Custom icons can only be set for items appearing in submenus. This property is an object with one property for each supplied icon: the property's name is the icon's size in pixels, and its value is a path to the icon from the extension's root directory. The browser will try to choose a 16x16 pixel icon for a normal display or a 32x32 pixel icon for a high-density display. So to avoid any scaling, you can specify icons like this:

"icons": {
      "16": "path/to/geo-16.png",
      "32": "path/to/geo-32.png"
    }

Alternatively, you can specify a single SVG icon, and it will be scaled appropriately:

"icons": {
      "16": "path/to/geo.svg"
    }

idOptional

string. The unique ID to assign to this item. Mandatory for event pages. Cannot be the same as another ID for this extension.

onclickOptional

function. A function that will be called when the menu item is clicked. Event pages cannot use this: instead, they should register a listener for menus.onClicked.

parentIdOptional

integer or string. The ID of a parent menu item; this makes the item a child of a previously added item. Note: If you have created more than one menu item, then the items will be placed in a submenu. The submenu's parent will be labeled with the name of the extension.

targetUrlPatternsOptional

array of string. Similar to documentUrlPatterns, but lets you filter based on the src attribute of img/audio/video tags and the href of anchor tags.

titleOptional

string. The text to be displayed in the item. Mandatory unless type is "separator".

You can use "%s" in the string. If you do this in a menu item, and some text is selected in the page when the menu is shown, then the selected text will be interpolated into the title. For example, if title is "Translate '%s' to Pig Latin" and the user selects the word "cool", then activates the menu, then the menu item's title will be: "Translate 'cool' to Pig Latin".

typeOptional

menus.ItemType. The type of menu item: "normal", "checkbox", "radio", "separator". Defaults to "normal".

callbackOptional

function. Called when the item has been created. If there were any problems creating the item, details will be available in runtime.lastError.

Return value

integer or string. The ID of the newly created item.

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

This example creates a context menu item that's shown when the user has selected some text in the page. It just logs the selected text to the console:

browser.menus.create({
  id: "log-selection",
  title: "Log '%s' to the console",
  contexts: ["selection"]
});

browser.menus.onClicked.addListener(function(info, tab) {
  if (info.menuItemId == "log-selection") {
    console.log(info.selectionText);
  }
});

This example adds two radio items, which you can use to choose whether to apply a green or a blue border to the page. Note that this example will need the activeTab permission.

function onCreated() {
  if (browser.runtime.lastError) {
    console.log("error creating item:" + browser.runtime.lastError);
  } else {
    console.log("item created successfully");
  }
}

browser.menus.create({
  id: "radio-green",
  type: "radio",
  title: "Make it green",
  contexts: ["all"],
  checked: false
}, onCreated);

browser.menus.create({
  id: "radio-blue",
  type: "radio",
  title: "Make it blue",
  contexts: ["all"],
  checked: false
}, onCreated);

var makeItBlue = 'document.body.style.border = "5px solid blue"';
var makeItGreen = 'document.body.style.border = "5px solid green"';

browser.menus.onClicked.addListener(function(info, tab) {
  if (info.menuItemId == "radio-blue") {
    browser.tabs.executeScript(tab.id, {
      code: makeItBlue
    });
  } else if (info.menuItemId == "radio-green") {
    browser.tabs.executeScript(tab.id, {
      code: makeItGreen
    });    
  }
});

Example extensions

• menu-demo
• session-state

// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.