Adiciona um botão a barra de ferramentas do navegador.

Uma browser action é um botão na barra de ferramentas do navegador.

Você pode associar um popup junto ao botão. O popup é especificado usando HTML, CSS e JavaScript, apenas como uma página web normal. O JavaScript rodando no popup tem o mesmo acesso a API WebExtension completa, assim como seus scripts em backend, mas seu contexto global é o popup, não a página exibida no navegador atualmente. Para afetar páginas web você precisa comunicá-las via messages.

Se você especificar um popup ele está exibido — e o conteúdo será carregado — quando o usuário clicar no ícone. Você não especificar um popup, quando o usuário clicar no ícone um evento será disparado para sua extensão.

Você pode definir muitas ações de propriedades do navegador de modo declarativo usando a chave browser_action no arquivo manifest.json.

Com a API browserAction você pode:

  • Usar browserAction.onClicked para escutar por cliques no ícone.
  • Atribuir e obter as propriedades do ícone — icone, titulo, popup, e assim por diante. Você pode obter e atribui-los globalmente para todas as abas, ou para uma aba específica informando o ID como um argumento adicional.

Tipos

browserAction.ColorArray
Um array de quatro números inteiros entre 0-55 definido uma cor RGB.
browserAction.ImageDataType
Dados do pixel de uma imagem. Deve ser um objeto ImageData (por exemplo, de um elemento <canvas>).

Funções

browserAction.setTitle()
Atribui ação de título do navegador. Ele será exibido em um tooltip.
browserAction.getTitle()
Obtém a ação de título do navegador.
browserAction.setIcon()
Atribui a ação de ícone ao navegador.
browserAction.setPopup()
Atribui o documento HTML que será aberto como um popup quando o usuário clicar na ação de ícone do navegador.
browserAction.getPopup()
Obtém o documento HTML atribuido como uma ação de popup do navegador.
browserAction.openPopup()
Abre a ação popup do navegador.
browserAction.setBadgeText()
Atribui a ação do texto distintivo do navegador. O emblema é exibido acima do ícone.
browserAction.getBadgeText()
Obtém o texto do emblema do navegador.
browserAction.setBadgeBackgroundColor()
Atribui a cor de fundo do emblema.
browserAction.getBadgeBackgroundColor()
Obtém a cor de fundo do emblema.
browserAction.enable()
Habilita a ação do navegador para uma aba. Por padrão, ações são habilitadas para todas as abas.
browserAction.disable()
Desabilita a ação para uma aba do navegador, significando que ela não pode ser clicada quando aquela aba estiver ativa.
browserAction.isEnabled()
Verifica se a ação do navegador está ou não habilitada.

Eventos

browserAction.onClicked
Disparado quando uma ação do ícone do navegador é clicada. Este evento não será disparado quando a ação do navegador tiver um popup.

Compatibilidade dos navegadores

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
ColorArrayChrome Full support YesEdge Full support 14Firefox Full support 45Opera Full support YesFirefox Android No support No
ImageDataTypeChrome Full support YesEdge Full support 14Firefox Full support 45Opera Full support YesFirefox Android No support No
disableChrome Full support YesEdge Full support 14Firefox Full support 45Opera Full support YesFirefox Android No support No
enableChrome Full support YesEdge Full support 14Firefox Full support 45Opera Full support YesFirefox Android No support No
getBadgeBackgroundColorChrome Full support YesEdge Full support 14Firefox Full support 45Opera Full support YesFirefox Android No support No
getBadgeTextChrome Full support YesEdge Full support 14Firefox Full support 45Opera Full support YesFirefox Android No support No
getBadgeTextColorChrome No support NoEdge No support NoFirefox Full support 63Opera No support NoFirefox Android No support No
getPopupChrome Full support YesEdge No support NoFirefox Full support 45Opera Full support YesFirefox Android Full support 57
getTitleChrome Full support YesEdge Full support 15Firefox Full support 45Opera Full support YesFirefox Android Full support 55
isEnabledChrome No support NoEdge No support NoFirefox Full support 59Opera No support NoFirefox Android No support No
onClickedChrome Full support YesEdge Full support 14Firefox Full support 45Opera Full support YesFirefox Android Full support 55
openPopupChrome No support NoEdge No support NoFirefox Full support 57Opera No support NoFirefox Android No support No
setBadgeBackgroundColorChrome Full support YesEdge Full support 14Firefox Full support 45
Full support 45
No support 45 — 58
Notes
Notes Tab-specific badge background color is not cleared when a new page is loaded.
Opera Full support YesFirefox Android No support No
setBadgeTextChrome Full support YesEdge Full support 14Firefox Full support 45
Full support 45
No support 45 — 58
Notes
Notes Tab-specific badge text is not cleared when a new page is loaded.
Opera Full support YesFirefox Android No support No
setBadgeTextColorChrome No support NoEdge No support NoFirefox Full support 63Opera No support NoFirefox Android No support No
setIconChrome Full support Yes
Notes
Full support Yes
Notes
Notes Before Chrome 23, `path` couldn't specify multiple icon files, but had to be a string specifying a single icon path.
Edge Full support 14
Notes
Full support 14
Notes
Notes This call is not persisted.
Notes The imageData parameter is not accepted.
Notes The path parameter is required.
Firefox Full support 45
Full support 45
No support 45 — 58
Notes
Notes Tab-specific icons are not cleared when a new page is loaded.
Opera Full support 15Firefox Android No support No
setPopupChrome Full support YesEdge Full support 14Firefox Full support 45
Full support 45
No support 45 — 58
Notes
Notes Tab-specific popups are not cleared when a new page is loaded.
Opera Full support YesFirefox Android Full support 57
Full support 57
No support 57 — 58
Notes
Notes Tab-specific popups are not cleared when a new page is loaded.
setTitleChrome Full support YesEdge Full support 15Firefox Full support 45
Full support 45
No support 45 — 58
Notes
Notes Tab-specific titles are not cleared when a new page is loaded.
Opera Full support YesFirefox Android Full support 55
Full support 55
No support 55 — 58
Notes
Notes Tab-specific titles are not cleared when a new page is loaded.

Legend

Full support  
Full support
No support  
No support
See implementation notes.
See implementation notes.

Example extensions

Agradecimentos

Esta API é baseada na API chrome.browserAction do Chromium. Este documento é derivado do browser_action.json no código do Chromium.

Os dados de compatibilidade do Microsoft Edge são fornecidos Microsoft Corporation e estão aqui inclusos sob a Creative Commons Attribution 3.0 United States License.

Etiquetas do documento e colaboradores

Colaboradores desta página: thiagopelizoni
Última atualização por: thiagopelizoni,