webextensions examples

WebExtensions-Exemplos

https://github.com/mdn/webextensions-examples

Mantido pela equipe de complementos de Mozilla.

WEBEXTENSions são uma maneira de escrever extensões de navegador: ou seja, programas instalados dentro de um navegador da Web que modificam o comportamento do navegador ou páginas da web carregadas pelo navegador. A WeBextensions é construída em um conjunto de APIs de navegador cruzado, por isso, WebExtensions, escritos para o Google Chrome, Opera ou Edge, na maioria dos casos, também será executado no Firefox.

O repositório "WeBextensions-Examples" é uma coleção de webExtensões simples, completas e instaláveis. Os exemplos mostram como usar as APIs do WEBEXTENSIONS e você pode usá -las como ponto de partida para suas WebExtensions.

Para um índice de todos os exemplos, consulte a página "Exemplo de extensões" no MDN.

Os exemplos são disponibilizados sob a licença pública de Mozilla 2.0.

Como usar "WebExtensions-Exemples"

Para usar o repositório, primeiro clone -o.

Cada exemplo está em uma pasta de nível superior e inclui uma leitura curta explicando o que faz. Para ver como um exemplo funciona, instale -o no Firefox seguindo as instruções de instalação.

Para encontrar o caminho em torno da estrutura interna de uma WebExtension, dê uma olhada na anatomia de uma página de WebExtension no MDN.

Para usar esses exemplos no Firefox, use o lançamento mais recente do Firefox. No entanto, a maioria dos exemplos trabalha com lançamentos anteriores.

Alguns exemplos dependem de APIs disponíveis apenas nas versões pré-lançamento do Firefox. Onde é esse o caso, o exemplo declara a versão mínima necessária no atributo strict_min_version da browser_specific_settings key no arquivo manifest.json da extensão.

Instalando um exemplo

Alguns exemplos funcionam apenas em domínios ou páginas específicas. Detalhes de quaisquer restrições são fornecidos no arquivo ReadMe de cada exemplo. Nenhum dos exemplos funciona em janelas de navegação privada por padrão, consulte Extensões na navegação privada para obter detalhes.

Para executar um exemplo de extensão:

1. Abra o Firefox e carregue a página about:debugging . Clique em Carregar complemento temporário e selecione o arquivo manifest.json na pasta de uma extensão de exemplo. Aqui está um vídeo que demonstra como fazer isso.
2. Instale a ferramenta Web-EXT. Na linha de comando, abra a pasta do exemplo da extensão e digite web-ext run . Isso lança o Firefox e instala a extensão automaticamente. Esta ferramenta fornece alguns recursos de desenvolvimento adicionais, como recarga automática.

Suporte para outros navegadores

Esses exemplos são testados no Firefox. Eles podem trabalhar em outros navegadores, se o navegador suportar as APIs usadas. Observe que esses exemplos usam o espaço para nome browser e promete trabalhar com funções assíncronas. Isso significa que os exemplos não funcionarão no Chrome, a menos que você use o poli -fill fornecido pela Mozilla. Veja a visão geral das APIs da WeBextension para obter mais informações.

Saber mais

Para saber mais sobre o desenvolvimento da WebExtensions, consulte a documentação da WeBextensions no MDN para iniciar guias, tutoriais e documentos de referência de API completos.

Problemas?

Se você encontrar um problema:

• Publique uma consulta no fórum do discurso de complementos
• Envie um email para a lista de discussão dev-addons
• Entre em contato com a equipe de complementos na sala de complementos em matriz

Se você não puder resolver o problema, registre um bug.

Contribuindo

Congratulamo -nos com contribuições, sejam eles novos exemplos, novos recursos, correções de bugs ou traduções de cordas localizáveis. Consulte o arquivo contribuindo.md para obter mais detalhes.