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

ChromeEdgeFirefoxFirefox for AndroidOpera
ColorArray Yes1445 No Yes
ImageDataType Yes1445 No Yes
disable Yes1445 No Yes
enable Yes1445 No Yes
getBadgeBackgroundColor Yes1445 No Yes
getBadgeText Yes1445 No Yes
getPopup Yes No4557 Yes
getTitle Yes154555 Yes
isEnabled No No59 No No
onClicked Yes144555 Yes
openPopup No No57 No No
setBadgeBackgroundColor Yes14

45

45 — 58 *

No Yes
setBadgeText Yes14

45

45 — 58 *

No Yes
setIcon Yes *14

45

45 — 58 *

No15
setPopup Yes14

45

45 — 58 *

57

57 — 58 *

Yes
setTitle Yes15

45

45 — 58 *

55

55 — 58 *

Yes

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,