Adicione itens ao sistema de menu do navegador.

Esta API é modelada sobre a API"contextMenus" do Chrome, que permite que extensões do Chrome adicione itens para o contexto de menu do navegador. A APIbrowser.menus adiciona alguns recursos à API do Chrome.

Antes do Firefox 55, esta API foi também nomeada, originalmente, decontextMenus, e esse nome era mantido como um alias; portanto, você pode usar ocontextMenus para escrever um código que funcione no Firefox e também em outros navegadores.

Para usar essa API, você precisa dapermissão demenus. Você também pode usar o aliascontextMenus em vez demenus, mas se usar, a API deve ser acessada comobrowser.contextMenus.

Exceto paramenus.getTargetElement(), essa API não pode ser usada de scripts de conteúdo (content scripts).

Criando itens de menu

Para criar um item de menu, chamme o métodomenus.create(). Você passa esse método como um objeto contendo opções para o item, incluindo o ID do item, o tipo do item, e os contextos no qual ele deve ser mostrado.

Escute os cliques no seu item de menu adicionando um ouvinte para o eventomenus.onClicked. Este ouvinte será passado

Listen for clicks on your menu item by adding a listener to themenus.onClicked event. Este ouvinte receberá um objetomenus.OnClickData que contém os detalhes do evento.

Você pode criar quatro tipos diferentes de itens de menu, com base no valor da propriedadetype que você fornece nas opções paracreate():

• "normal": um item de menu que apenas mostra um rótulo.
• "checkbox": um item de menu que representa um estado binário. Ele mostra uma marca de verificação próxima ao rótulo. Clicar no item ativa esta marca. O ouvinte de clique receberá duas propriedades extras: "checked", indicando que o item foi marcado agora, e "wasChecked", indicando que o item foi marcado antes do evento do clique.
• "radio": um item de menu que representa um de um grupo de escolhas. Como uma marca de verificação, isso também mostra uma marca de verificação próxima ao rótulo, e seu ouvinte de clique receberá "checked" e "wasChecked". No entanto, se você criar mais de um item de rádio, os itens funcionarão como um grupo de itens de rádio: apenas um item no grupo poderá ser verificado e clicar em um item o tornará o item marcado.
• "separator": uma linha separando um grupo de itens.

Se você criou mais de um item de menu de contexto ou mais de um item de menu de ferramentas, os itens serão colocados em um submenu. O pai do submenu será identificado com o nome da extensão. Por exemplo, aqui está uma extensão chamada "Demonstração de menu" ("Menu demo"), que adicionou dois itens de menu de contexto:

Ícones

Se você especificou ícones para sua extensão usando achave "icons" do manifest, o item de menu exibirá o ícone especificado ao lado do rótulo. O navegador tentará escolher um ícone de 16x16 pixels para uma exibição normal ou um ícone de 32x32 pixels para uma exibição de alta densidade:

Apenas para itens dentro de um submenu, você pode especificar ícones customizados passando a opçãoicons para omenus.create():

Exemplo

Aqui está um menu de contexto contendo quatro itens: um item normal, dois itens de rádio com separadores em cada lado, e uma marca de seleção. Os itens de rádio receberam ícones customizados.

Você pode criar um submenu como este usando o código abaixo:

browser.menus.create(  {    id: "remove-me",    title: browser.i18n.getMessage("menuItemRemoveMe"),    contexts: ["all"],  },  onCreated,);browser.menus.create(  {    id: "separator-1",    type: "separator",    contexts: ["all"],  },  onCreated,);browser.menus.create(  {    id: "greenify",    type: "radio",    title: browser.i18n.getMessage("menuItemGreenify"),    contexts: ["all"],    checked: true,    icons: {      16: "icons/paint-green-16.png",      32: "icons/paint-green-32.png",    },  },  onCreated,);browser.menus.create(  {    id: "bluify",    type: "radio",    title: browser.i18n.getMessage("menuItemBluify"),    contexts: ["all"],    checked: false,    icons: {      16: "icons/paint-blue-16.png",      32: "icons/paint-blue-32.png",    },  },  onCreated,);browser.menus.create(  {    id: "separator-2",    type: "separator",    contexts: ["all"],  },  onCreated,);var checkedState = true;browser.menus.create(  {    id: "check-uncheck",    type: "checkbox",    title: browser.i18n.getMessage("menuItemUncheckMe"),    contexts: ["all"],    checked: checkedState,  },  onCreated,);

Tipos

menus.ContextType

Os diferentes contextos em que um menu pode aparecer.

menus.ItemType

O tipo de item de menu: "normal", "checkbox", "radio", "separator".

menus.OnClickData

Informação enviada quando um item do menu é clicado.

Propriedades

menus.ACTION_MENU_TOP_LEVEL_LIMIT

O número máximo de itens de extensão de nível superior que podem ser adicionados a um item de menu cujo ContextType seja "browser_action" ou "page_action".

Funções

menus.create()

Cria um novo item de menu.

menus.getTargetElement()

Retorna o elemento para uminfo.targetElementId determinado.

menus.overrideContext()

Oculta todos os itens de menu padrão do Firefox para fornecer uma interface de usuário personalizada do menu de contexto.

menus.refresh()

Atualiza um menu que está sendo exibido no momento.

menus.remove()

Remove um item do menu.

menus.removeAll()

Remove todos os itens do menu adicionados por esta extensão.

menus.update()

Atualiza um item do menu criado anteriormente.

Eventos

menus.onClicked

Ativado quando um item de menu é clicado.

menus.onHidden

Ativado quando o navegador esconde um menu.

menus.onShown

Ativado quando o navegador mostra um menu.

Compatibilidade com navegadores

Example extensions

• menu-accesskey-visible
• menu-demo
• menu-labelled-open
• menu-remove-element
• menu-search
• session-state