From 074785cea106179cb3305637055ab0a009ca74f2 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Tue, 8 Dec 2020 14:42:52 -0500 Subject: initial commit --- .../add-ons/code_snippets/canvas/index.html | 235 ++++++++ .../pt-br/mozilla/add-ons/code_snippets/index.html | 173 ++++++ .../index.html | 168 ++++++ .../enviando-um-complemento-para-o-amo/index.html | 24 + .../add-ons/gerenciador_de_add-on/index.html | 61 ++ files/pt-br/mozilla/add-ons/index.html | 94 +++ .../interface-com-o-repositorio_add-on/index.html | 96 +++ .../add-ons/orientacoes-de-complementos/index.html | 117 ++++ .../mozilla/add-ons/overlay_extensions/index.html | 71 +++ .../mozilla/add-ons/repositorio_add-on/index.html | 155 +++++ files/pt-br/mozilla/add-ons/sdk/guides/index.html | 367 +++++++++++ .../sdk/guides/working_with_events/index.html | 154 +++++ .../mozilla/add-ons/sdk/high-level_apis/index.html | 11 + .../add-ons/sdk/high-level_apis/request/index.html | 214 +++++++ .../add-ons/sdk/high-level_apis/tabs/index.html | 671 +++++++++++++++++++++ .../add-ons/sdk/high-level_apis/windows/index.html | 303 ++++++++++ files/pt-br/mozilla/add-ons/sdk/index.html | 102 ++++ .../mozilla/add-ons/sdk/low-level_apis/index.html | 23 + .../sdk/low-level_apis/ui_sidebar/index.html | 455 ++++++++++++++ .../sdk/low-level_apis/window_utils/index.html | 386 ++++++++++++ .../abra_uma_p\303\241gina_web/index.html" | 51 ++ .../adding_a_button_to_the_toolbar/index.html | 83 +++ .../index.html | 115 ++++ .../index.html | 120 ++++ .../captura_de_carregamento_da_pagina/index.html | 28 + .../sdk/tutorials/chrome_authority/index.html | 65 ++ .../sdk/tutorials/come\303\247ando/index.html" | 206 +++++++ .../tutorials/creating_event_targets/index.html | 245 ++++++++ .../tutorials/creating_reusable_modules/index.html | 253 ++++++++ .../sdk/tutorials/getting_started_(jpm)/index.html | 155 +++++ .../pt-br/mozilla/add-ons/sdk/tutorials/index.html | 144 +++++ .../mozilla/add-ons/sdk/tutorials/l10n/index.html | 380 ++++++++++++ .../sdk/tutorials/lista_de_tabs_abertas/index.html | 67 ++ .../listening_for_load_and_unload/index.html | 60 ++ .../add-ons/sdk/tutorials/logging/index.html | 55 ++ .../modifying_the_page_hosted_by_a_tab/index.html | 137 +++++ .../modifying_web_pages_based_on_url/index.html | 228 +++++++ .../sdk/tutorials/mostrar_um_popup/index.html | 165 +++++ .../add-ons/sdk/tutorials/unit_testing/index.html | 127 ++++ .../mozilla/add-ons/temas/background/index.html | 110 ++++ files/pt-br/mozilla/add-ons/temas/index.html | 55 ++ .../temas/using_the_amo_theme_generator/index.html | 137 +++++ .../anatomia_de_uma_webextension/index.html | 115 ++++ .../add-ons/webextensions/api/alarms/index.html | 52 ++ .../add-ons/webextensions/api/bookmarks/index.html | 119 ++++ .../webextensions/api/browseraction/index.html | 128 ++++ .../webextensions/api/browsersettings/index.html | 60 ++ .../webextensions/api/browsingdata/index.html | 120 ++++ .../add-ons/webextensions/api/clipboard/index.html | 34 ++ .../add-ons/webextensions/api/commands/index.html | 83 +++ .../webextensions/api/contentscripts/index.html | 38 ++ .../api/contextualidentities/index.html | 62 ++ .../add-ons/webextensions/api/cookies/index.html | 162 +++++ .../mozilla/add-ons/webextensions/api/index.html | 53 ++ .../add-ons/webextensions/api/menus/index.html | 205 +++++++ .../add-ons/webextensions/api/tabs/index.html | 223 +++++++ .../add-ons/webextensions/api/tema/index.html | 55 ++ .../browser_support_for_javascript_apis/index.html | 15 + .../empacotando_e_instalando/index.html | 94 +++ .../add-ons/webextensions/examples/index.html | 30 + .../pt-br/mozilla/add-ons/webextensions/index.html | 138 +++++ .../intercept_http_requests/index.html | 155 +++++ .../add-ons/webextensions/manifest.json/index.html | 105 ++++ .../manifest.json/permiss\303\265es/index.html" | 184 ++++++ .../manifest.json/short_name/index.html | 43 ++ .../web_accessible_resources/index.html | 97 +++ .../webextensions/o_que_vem_a_seguir_/index.html | 56 ++ .../add-ons/webextensions/passo-a-passo/index.html | 306 ++++++++++ .../webextensions/pre-requisitos/index.html | 23 + .../sua_primeira_webextension/index.html | 150 +++++ .../webextensions/user_interface/index.html | 97 +++ .../itens_do_menu_de_contexto/index.html | 58 ++ .../what_are_webextensions/index.html | 22 + 73 files changed, 9948 insertions(+) create mode 100644 files/pt-br/mozilla/add-ons/code_snippets/canvas/index.html create mode 100644 files/pt-br/mozilla/add-ons/code_snippets/index.html create mode 100644 files/pt-br/mozilla/add-ons/creating_opensearch_plugins_for_firefox/index.html create mode 100644 files/pt-br/mozilla/add-ons/enviando-um-complemento-para-o-amo/index.html create mode 100644 files/pt-br/mozilla/add-ons/gerenciador_de_add-on/index.html create mode 100644 files/pt-br/mozilla/add-ons/index.html create mode 100644 files/pt-br/mozilla/add-ons/interface-com-o-repositorio_add-on/index.html create mode 100644 files/pt-br/mozilla/add-ons/orientacoes-de-complementos/index.html create mode 100644 files/pt-br/mozilla/add-ons/overlay_extensions/index.html create mode 100644 files/pt-br/mozilla/add-ons/repositorio_add-on/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/guides/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/guides/working_with_events/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/high-level_apis/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/high-level_apis/request/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/high-level_apis/tabs/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/high-level_apis/windows/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/low-level_apis/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/low-level_apis/ui_sidebar/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/low-level_apis/window_utils/index.html create mode 100644 "files/pt-br/mozilla/add-ons/sdk/tutorials/abra_uma_p\303\241gina_web/index.html" create mode 100644 files/pt-br/mozilla/add-ons/sdk/tutorials/adding_a_button_to_the_toolbar/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/tutorials/adicionar_uma_item_de_menu_ao_firefox/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/tutorials/adicione_um_item_ao_menu_de_contexto/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/tutorials/captura_de_carregamento_da_pagina/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/tutorials/chrome_authority/index.html create mode 100644 "files/pt-br/mozilla/add-ons/sdk/tutorials/come\303\247ando/index.html" create mode 100644 files/pt-br/mozilla/add-ons/sdk/tutorials/creating_event_targets/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/tutorials/creating_reusable_modules/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/tutorials/getting_started_(jpm)/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/tutorials/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/tutorials/l10n/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/tutorials/lista_de_tabs_abertas/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/tutorials/listening_for_load_and_unload/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/tutorials/logging/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/tutorials/modifying_the_page_hosted_by_a_tab/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/tutorials/modifying_web_pages_based_on_url/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/tutorials/mostrar_um_popup/index.html create mode 100644 files/pt-br/mozilla/add-ons/sdk/tutorials/unit_testing/index.html create mode 100644 files/pt-br/mozilla/add-ons/temas/background/index.html create mode 100644 files/pt-br/mozilla/add-ons/temas/index.html create mode 100644 files/pt-br/mozilla/add-ons/temas/using_the_amo_theme_generator/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/anatomia_de_uma_webextension/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/api/alarms/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/api/bookmarks/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/api/browseraction/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/api/browsersettings/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/api/browsingdata/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/api/clipboard/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/api/commands/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/api/contentscripts/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/api/contextualidentities/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/api/cookies/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/api/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/api/menus/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/api/tabs/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/api/tema/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/browser_support_for_javascript_apis/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/empacotando_e_instalando/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/examples/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/intercept_http_requests/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/manifest.json/index.html create mode 100644 "files/pt-br/mozilla/add-ons/webextensions/manifest.json/permiss\303\265es/index.html" create mode 100644 files/pt-br/mozilla/add-ons/webextensions/manifest.json/short_name/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/manifest.json/web_accessible_resources/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/o_que_vem_a_seguir_/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/passo-a-passo/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/pre-requisitos/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/sua_primeira_webextension/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/user_interface/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/user_interface/itens_do_menu_de_contexto/index.html create mode 100644 files/pt-br/mozilla/add-ons/webextensions/what_are_webextensions/index.html (limited to 'files/pt-br/mozilla/add-ons') diff --git a/files/pt-br/mozilla/add-ons/code_snippets/canvas/index.html b/files/pt-br/mozilla/add-ons/code_snippets/canvas/index.html new file mode 100644 index 0000000000..5178d91a50 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/code_snippets/canvas/index.html @@ -0,0 +1,235 @@ +--- +title: Canvas fragmentos de códigos +slug: Mozilla/Add-ons/Code_snippets/Canvas +translation_of: Archive/Add-ons/Code_snippets/Canvas +--- +

Para informações gerais sobre o uso do <canvas> ver a página do tópico canvas.

+ +

Código usável do conteúdo da Web

+ +

Recebendo o número de pixels de uma certa cor em um canvas

+ +

A função a seguir retornará o número de pixels em um canvas que a cor RGB de r, g e b. Isso pode ser muito útil para comparar, por exemplo se um usuário  pintou sobre uma outra área  como explicado nessa publicação do blog.

+ +
function getpixelamount(canvas, r, g, b) {
+  var cx = canvas.getContext('2d');
+  var pixels = cx.getImageData(0, 0, canvas.width, canvas.height);
+  var all = pixels.data.length;
+  var amount = 0;
+  for (i = 0; i < all; i += 4) {
+    if (pixels.data[i] === r &&
+        pixels.data[i + 1] === g &&
+        pixels.data[i + 2] === b) {
+      amount++;
+    }
+  }
+  return amount;
+};
+
+ +

Recebendo a cor de um pixel em um canvas

+ +

Esse fragmento a seguir retorna um objeto com os valores RGBA do pixel na posição x e y do canvas. Isso pode ser usado para determinar se o cursor do mouse está dentro de uma certa forma ou não.

+ +
function getpixelcolour(canvas, x, y) {
+  var cx = canvas.getContext('2d');
+  var pixel = cx.getImageData(x, y, 1, 1);
+  return {
+    r: pixel.data[0],
+    g: pixel.data[1],
+    b: pixel.data[2],
+    a: pixel.data[3]
+  };
+}
+
+ +

Encadeamento de métodos

+ +

Essa classe prove um estilo JQuery de acesso encadeado aos métodos e propriedades do contexto 2D.

+ +
function Canvas2DContext(canvas) {
+  if (typeof canvas === 'string') {
+    canvas = document.getElementById(canvas);
+  }
+  if (!(this instanceof Canvas2DContext)) {
+    return new Canvas2DContext(canvas);
+  }
+  this.context = this.ctx = canvas.getContext('2d');
+  if (!Canvas2DContext.prototype.arc) {
+    Canvas2DContext.setup.call(this, this.ctx);
+  }
+}
+Canvas2DContext.setup = function () {
+  var methods = ['arc','arcTo','beginPath','bezierCurveTo','clearRect','clip',
+    'closePath','drawImage','fill','fillRect','fillText','lineTo','moveTo',
+    'quadraticCurveTo','rect','restore','rotate','save','scale','setTransform',
+    'stroke','strokeRect','strokeText','transform','translate'];
+
+  var getterMethods = ['createPattern','drawFocusRing','isPointInPath','measureText', // drawFocusRing not currently supported
+    // The following might instead be wrapped to be able to chain their child objects
+    'createImageData','createLinearGradient',
+    'createRadialGradient', 'getImageData','putImageData'
+  ];
+
+  var props = ['canvas','fillStyle','font','globalAlpha','globalCompositeOperation',
+    'lineCap','lineJoin','lineWidth','miterLimit','shadowOffsetX','shadowOffsetY',
+    'shadowBlur','shadowColor','strokeStyle','textAlign','textBaseline'];
+
+  for (let m of methods) {
+    let method = m;
+    Canvas2DContext.prototype[method] = function () {
+      this.ctx[method].apply(this.ctx, arguments);
+      return this;
+    };
+  }
+
+  for (let m of getterMethods) {
+    let method = m;
+    Canvas2DContext.prototype[method] = function () {
+      return this.ctx[method].apply(this.ctx, arguments);
+    };
+  }
+
+  for (let p of props) {
+    let prop = p;
+    Canvas2DContext.prototype[prop] = function (value) {
+      if (value === undefined)
+        return this.ctx[prop];
+      this.ctx[prop] = value;
+      return this;
+    };
+  }
+};
+
+var canvas = document.getElementById('canvas');
+
+// Use context to get access to underlying context
+var ctx = Canvas2DContext(canvas)
+  .strokeStyle("rgb(30,110,210)")
+  .transform(10, 3, 4, 5, 1, 0)
+  .strokeRect(2, 10, 15, 20)
+  .context;
+
+// Use property name as a function (but without arguments) to get the value
+var strokeStyle = Canvas2DContext(canvas)
+  .strokeStyle("rgb(50,110,210)")
+  .strokeStyle();
+
+ +

Código usável apenas para código previlegiado

+ +

Esse fragmento só é útl para códigos previlegiados, como extensões ou aplicativos previlegiados.

+ +

Salvando uma imagem do canvas à um arquivo

+ +

A função a seguir aceita um objeto canvas e uma string de destinação do caminho do arquivo. O canvas é convertido para um arquivo PNG e, é salvo na localização especificada. A função retorna uma promessa que resolve quando o arquivo foi completamente  salvo.

+ +
function saveCanvas(canvas, path, type, options) {
+    return Task.spawn(function *() {
+        var reader = new FileReader;
+        var blob = yield new Promise(accept => canvas.toBlob(accept, type, options));
+        reader.readAsArrayBuffer(blob);
+
+        yield new Promise(accept => { reader.onloadend = accept });
+
+        return yield OS.File.writeAtomic(path, new Uint8Array(reader.result),
+                                         { tmpPath: path + '.tmp' });
+    });
+}
+
+ +

Carregando uma página remota em um elemento canvas

+ +

A classe a seguir primeiro cria um elemento iframe oculto e anexa um ouvinte ao evento carregar frame. Uma vez que a página remota foi carregada, o método remotePageLoaded é ativado. Esse método pega uma referência da janela do iframe e desenha essa janela no objeto canvas.

+ +

Note que isso só funciona se você esta rodando a página no chrome. Se você tentar rodar o código como uma página da web simples, você receberá um 'Erro de segurança" código: erro "1000'.

+ +
RemoteCanvas = function() {
+    this.url = "http://developer.mozilla.org";
+};
+
+RemoteCanvas.CANVAS_WIDTH = 300;
+RemoteCanvas.CANVAS_HEIGHT = 300;
+
+RemoteCanvas.prototype.load = function() {
+    var windowWidth = window.innerWidth - 25;
+    var iframe;
+    iframe = document.createElement("iframe");
+    iframe.id = "test-iframe";
+    iframe.height = "10px";
+    iframe.width = windowWidth + "px";
+    iframe.style.visibility = "hidden";
+    iframe.src = this.url;
+    // Here is where the magic happens... add a listener to the
+    // frame's onload event
+    iframe.addEventListener("load", this.remotePageLoaded, true);
+    //append to the end of the page
+    window.document.body.appendChild(iframe);
+    return;
+};
+
+RemoteCanvas.prototype.remotePageLoaded = function() {
+    // Look back up the iframe by id
+    var ldrFrame = document.getElementById("test-iframe");
+    // Get a reference to the window object you need for the canvas
+    // drawWindow method
+    var remoteWindow = ldrFrame.contentWindow;
+
+    //Draw canvas
+    var canvas = document.createElement("canvas");
+    canvas.style.width = RemoteCanvas.CANVAS_WIDTH + "px";
+    canvas.style.height = RemoteCanvas.CANVAS_HEIGHT + "px";
+    canvas.width = RemoteCanvas.CANVAS_WIDTH;
+    canvas.height = RemoteCanvas.CANVAS_HEIGHT;
+    var windowWidth = window.innerWidth - 25;
+    var windowHeight = window.innerHeight;
+
+    var ctx = canvas.getContext("2d");
+    ctx.clearRect(0, 0,
+                  RemoteCanvas.CANVAS_WIDTH,
+                  RemoteCanvas.CANVAS_HEIGHT);
+    ctx.save();
+    ctx.scale(RemoteCanvas.CANVAS_WIDTH / windowWidth,
+              RemoteCanvas.CANVAS_HEIGHT / windowHeight);
+    ctx.drawWindow(remoteWindow,
+                   0, 0,
+                   windowWidth, windowHeight,
+                   "rgb(255,255,255)");
+    ctx.restore();
+};
+
+ +

Emprego:

+ +
var remoteCanvas = new RemoteCanvas();
+remoteCanvas.load();
+
+ +

Converter arquivos de imagem para strings base64

+ +

O código a seguir recebe uma imagem remota e converte seu conteúdo para Dados do esquema URI.

+ +
var canvas = document.createElement("canvas");
+var ctxt = canvas.getContext("2d");
+function loadImageFile (url, callback) {
+  var image = new Image();
+  image.src = url;
+  return new Promise((accept, reject) => {
+    image.onload = accept;
+    image.onerror = reject;
+  }).then(accept => {
+    canvas.width = this.width;
+    canvas.height = this.height;
+    ctxt.clearRect(0, 0, this.width, this.height);
+    ctxt.drawImage(this, 0, 0);
+    accept(canvas.toDataURL());
+  });
+}
+
+ +

Emprego:

+ +
loadImageFile("myimage.jpg").then(string64 => { alert(string64); });
+
+ +

Se você quer receber ao invés do conteúdo base64 de um arquivo local usando o arquivo elemento {{ HTMLElement("input") }}, você deve usar o objeto FileReader.

diff --git a/files/pt-br/mozilla/add-ons/code_snippets/index.html b/files/pt-br/mozilla/add-ons/code_snippets/index.html new file mode 100644 index 0000000000..a3e51b03df --- /dev/null +++ b/files/pt-br/mozilla/add-ons/code_snippets/index.html @@ -0,0 +1,173 @@ +--- +title: Snippets de código +slug: Mozilla/Add-ons/Code_snippets +tags: + - Add-ons + - Code snippets + - Extensions + - NeedsTranslation + - TopicStub +translation_of: Archive/Add-ons/Code_snippets +--- +
+

+ O suporte para extensões que usam XUL/XPCOM ou Add-on SDK foi removido no Firefox 57, lançado em novembro de 2017. Como não há versão suportada do Firefox ativando essas tecnologias, essa página será removida em dezembro de 2020. +

+ +

+ Os complementos que usam as técnicas descritas neste documento são considerados código legado no Firefox. Não use essas técnicas para desenvolver novos complementos. + Use WebExtensions. Se você mantém um complemento que usa as técnicas descritas aqui, considere migrar para usar WebExtensions. +

+ +

+ + A partir do Firefox 53, nenhum código legado será aceito no addons.mozilla.org (AMO) para Firefox e Firefox para Android. + +

+ +

+ + A partir do Firefox 57, apenas as extensões desenvolvidas usando as APIs WebExtensions serão suportadas no Firefox e Firefox para Android. + +

+ +

+ Mesmo antes do Firefox 57, as mudanças na plataforma Firefox quebraram muitas extensões legado. Essas alterações incluem o multiprocessamento do Firefox (e10s), + sandboxing e múltiplos processos de conteúdo. As extensões legado afetadas por essas alterações devem migrar para usar as APIs WebExtensions, se possível. + Consute o documento de "Marcos de compatibilidade" para mais informações. +

+ +

+ Uma página wiki contendo recursos, caminhos de migração, expediente e mais, está disponível para ajudar os desenvolvedores a fazer a transição para as novas tecnologias. +

+
+ + + +

+ Esta é uma lista rápida de snippets de código (pequenos exemplos úteis de código) disponíveis para desenvolvedores de extensões para os vários aplicativos Mozilla. Muitos desses exemplos também podem ser usados ​​em aplicativos XULRunner, bem como no próprio código Mozilla. +

+ +

+ Esses exemplos demonstram como realizar tarefas básicas que podem não ser imediatamente óbvias. +

+ +

General

+ +
+
Examples and demos from MDN articles
+
A collection of examples and demos from articles.
+
Window code
+
Opening and manipulating windows
+
Toolbar
+
Toolbar related code
+
Sidebar
+
Sidebar related code
+
Forms
+
Forms related code
+
XML
+
Code used to parse, write, manipulate, etc. XML
+
File I/O
+
Code used to read, write and process files
+
Drag & Drop
+
Code used to setup and handle drag and drop events
+
Dialogs
+
Code used to display and process dialog boxes
+
Alerts and Notifications
+
Modal and non-modal ways to notify users
+
Preferences
+
Code used to read, write, and modify preferences
+
JS XPCOM
+
Code used to define and call XPCOM components in JavaScript
+
Running applications
+
Code used to run other applications
+
<canvas> related
+
WHAT WG Canvas-related code
+
Signing a XPI
+
How to sign an XPI with PKI
+
Delayed Execution
+
Performing background operations.
+
Miscellaneous
+
Miscellaneous useful code fragments
+
HTML to DOM
+
Using a hidden browser element to parse HTML to a window's DOM
+
+ +

JavaScript libraries

+ +

Here are some JavaScript libraries that may come in handy.

+ +
+
StringView
+
A library that implements a StringView view for JavaScript typed arrays. This lets you access data in typed arrays using C-like string functions.
+
Rosetta
+
By default, the only possible standardized scripting language for HTML is ECMAScript. Hence, if you are going to use another scripting language you might expect that most of the browsers will not recognize it. Nevertheless, the increasing computational power of modern browsers together with the introduction of typed arrays in ECMAScript allow us, in theory, to build full virtual machines in pure ECMAScript. Therefore, it is also possible, in theory, to use ECMAScript for a smaller task: parsing exotic programming languages (i.e., creating compilers). This snippets shows a possible way to start from.
+
+ +

Browser-oriented code

+ +
+
Tabbed browser code (Firefox/SeaMonkey)
+
Basic operations, such as page loading, with the tabbed browser, which is the heart of Mozilla's browser applications
+
Cookies
+
Reading, writing, modifying, and removing cookies
+
Page Loading
+
Code used to load pages, reload pages, and listen for page loads
+
Interaction between privileged and non-privileged code
+
How to communicate from extensions to websites and vice-versa.
+
Downloading Files
+
Code to download files, images, and to monitor download progress
+
Password Manager
+
Code used to read and write passwords to/from the integrated password manager
+
Bookmarks
+
Code used to read and write bookmarks
+
JavaScript Debugger Service
+
Code used to interact with the JavaScript Debugger Service
+
+ +

SVG

+ +
+
General
+
General information and utilities
+
SVG Animation
+
Animate SVG using JavaScript and SMIL
+
SVG Interacting with Script
+
Using JavaScript and DOM events to create interactive SVG
+
Embedding SVG in HTML and XUL
+
Using SVG to enhance HTML or XUL based markup
+
+ +

XUL Widgets

+ +
+
HTML in XUL for Rich Tooltips
+
Dynamically embed HTML into a XUL element to attain markup in a tooltip
+
Label and description
+
Special uses and line breaking examples
+
Tree
+
Setup and manipulation of trees using XUL and JS
+
Scrollbar
+
Changing style of scrollbars. Applies to scrollbars in browser and iframe as well.
+
Autocomplete
+
Code used to enable form autocomplete in a browser
+
Boxes
+
Tips and tricks when using boxes as containers
+
Tabbox
+
Removing and manipulating tabs in a tabbox
+
+ +

Windows-specific

+ +
+
Finding Window Handles (HWND) (Firefox)
+
How to use Windows API calls to find various kinds of Mozilla window handles. Window handles can be used for IPC and Accessibility purposes.
+
Using the Windows Registry with XPCOM
+
How to read, write, modify, delete, enumerate, and watch registry keys and values.
+
+ + + +

+ O conteúdo do MozillaZine Example Code está sendo movido lentamente para cá, mas você ainda pode encontrar exemplos úteis. +

diff --git a/files/pt-br/mozilla/add-ons/creating_opensearch_plugins_for_firefox/index.html b/files/pt-br/mozilla/add-ons/creating_opensearch_plugins_for_firefox/index.html new file mode 100644 index 0000000000..677ed79638 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/creating_opensearch_plugins_for_firefox/index.html @@ -0,0 +1,168 @@ +--- +title: Criando um plugin OpenSearch para Firefox +slug: Mozilla/Add-ons/Creating_OpenSearch_plugins_for_Firefox +tags: + - OpenSearch + - Plugins + - busca +translation_of: Web/OpenSearch +--- +

{{ fx_minversion_header("2") }}

+

Firefox 2 suporta formatos descrições OpenSearch para plungins de busca. Plugins que usam a syntax de descrição OpenSearch são compatíveis com IE 7 e Firefox. Devido isto, ele é o formato recomendado para o uso na web.

+

Firefox também suporta recursos adicionais não incluídos na syntax de descrição OpenSearch, como sugestões de busca e elementos  SearchForm. Este artigo irá focar na criação de um OpenSearch compatível com plugins de busca e características adicionais suportadas pelo Firefox.

+

Arquivos de descrição podem também ser descritos automaticamente pelo Autodiscovery of search plugins,  e podem ser instalados via programação como descrito em Adding search engines from web pages.

+

Arquivo de descrição OpenSearch

+

O Arquivo XML descrevendo um motor de busca é bastante simples, seguindo o template básico a seguir. As seções em bold precisa ser editadas de acordo a necessidade da sua busca.

+
<?xml version="1.0" encoding="UTF-8"?>
+<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/"
+                       xmlns:moz="http://www.mozilla.org/2006/browser/search/">
+  <ShortName>SNK</ShortName>
+  <Description>Search engine full control</Description>
+  <InputEncoding>UTF-8</InputEncoding>
+  <Image width="16" height="16" type="image/x-icon">data:image/x-icon;base64,http://www.world-connect-commodities.ro:20523/Style%20Library/icon.png</Image>
+  <Url type="text/html" method="method" template="searchURL">
+    <Param name="key/value pairs" value="{searchTerms}"/>
+    ...
+    <Param name="key/value pairs" value="{searchTerms}"/>
+  </Url>
+  <Url type="application/x-suggestions+json" template="suggestionURL"/>
+  <moz:SearchForm>http://www.world-connect-commodities.ro:8775/Search/default.aspx</moz:SearchForm>
+</OpenSearchDescription>
+
+
+ ShortName
+
+ Um nome para seu motor de busca.
+
+ Restrições: O valor deve conter até 16 caracteres. Este valor também não deve conter markup HTML.
+
+
+
+ Descrição
+
+ Uma breve descrição do seu motor de busca.
+
+ Restrições: Este valor deve conter até 1024 caracteres. Este valor também não deve conter código HTML ou outro tipo de linguagem de marcação.
+
+
+
+ InputEncoding
+
+ Define o ecoding a ser usado na busca. Exemplo: <InputEncoding>UTF-8</InputEncoding>.
+
+
+
+ Image
+
+ URI para um icone que represente o motor de busca. Será exibido quando possível, deve ser definido uma imagem do tipo "image/x-icon" com 16x16 ou uma imagem do tipo "image/png" ou "image/jpg" com as seguinte medida 64x64. O link também suporta o formato data: URI scheme. Uma ferramenta útil que pode ser utilizada apra construir imagem no formato data você encontra aqui: The data: URI kitchen. + 
<Image height="16" width="16" type="image/x-icon">http://example.com/favicon.ico</Image>
+  OR
+<Image height="16" width="16">data:image/x-icon;base64,AAABAAEAEBAAA ... DAAA=</Image>
+
+ O Firefox armazena os icones no formato base64 data: As URL's (do plug-ins de busca são armazenados na pasta "searchplugins" no perfil do usuário). http: URIs são alteradas para data: URIs quando isto é feito.
+
+
+ Nota: Para icones carregados remotamente (ex. de http:// URIs), o Firefox irá rejeitar ícones maiores que 10000 bytes.
+
+
+
+
+ Url
+
+ Descreve a URL ou URLs para ser usada pela search. O atributo method indica se deve ser usada uma requisição GET ou POST para buscar o resultado. O atributo template indica a URL base para a query da busca.
+
+
+ Nota: Internet Explorer 7 não suporta requisições do tipo POST.
+
+
+
+
+ Existem três tipos de URL que o Firefox suporta:
+
+ +
+
+ Para este tipo de URL's você pode usar {searchTerms} para substituir os termos inseridos na busca pelo o usuário na barra de busca ou location bar. Outro parâmetro suportado dinamicamente são descritos em OpenSearch 1.1 parameters.
+
+
+
+ Para sugestões de queries, o template de URL especificado é usado para buscar sugestões em uma lista em um formato JavaScript Object Notation (JSON). Para detalhes de como implementar o suporte a sugestões de busca em seu servidor , veja Supporting search suggestions in search plugins.
+
+

Image:SearchSuggestionSample.png

+
+
+ Param
+
+ Os parâmetros que precisam ser passados junto com a query da busca, com um par de key/value. Quando especifica os valores, você pode usar o {searchTerms} para inserir os termos de busca inseridos pelo o usuário na barra de busca.
+
+
+ Nota: O Internet Explorer 7 não tem suporte a este elemento.
+
+
+
+
+ SearchForm
+
+ A URL que irá abrir a página de busca para qual plugin é designado. Este fornece um modo para o Firefox buscar diretamente no site.
+
+
+ Nota: Uma vez que o elemento é específico para Firefox, e não parte da especificação do OpenSearch, nos usamos o prefixo XML "moz:"  no exemplo acima para asegurar que os outros user agents que não tenham suporte ignorem o recurso por segurança.
+
+
+

Detecção automática de plugins de busca

+

Um web site que oferece um plugin de busca pode notificar facilmente aos usuários do Firefox a instalação do plugin.

+

Para o suporte a detecção automática, você simplesmente adicionaa uma linha na seção <head> do sua web page:

+
<link rel="search" type="application/opensearchdescription+xml" title="searchTitle" href="pluginURL">
+
+

Substitua os item em itálico como explicado a seguir:

+
+
+ searchTitle
+
+ O nome da busca a ser realizada, por exemplo,  "Search MDC" ou "Yahoo! Search". Este valor deve corresponder ao ShortName do seu plugin de busca.
+
+
+
+ pluginURL
+
+ A URL para o XML do plugin de busca, a partir do qual o navegador irá baixar.
+
+

Se você oferece multiplas busca em seu site, você pode adicionar para todos eles o suporte a auto detecção dos seus plugins de busca. Por exemplo:

+
<link rel="search" type="application/opensearchdescription+xml" title="MySite: By Author" href="http://www.mysite.com/mysiteauthor.xml">
+<link rel="search" type="application/opensearchdescription+xml" title="MySite: By Title" href="http://www.mysite.com/mysitetitle.xml">
+
+

Deste modo, seu site irá oferecer plugins de busca para ambos os casos autor e título como no exemplo acima.

+

Suportando atualizações automáticas para OpenSearch plugin

+

{{ fx_minversion_note("3.5", "Esta seção cobre uma feature introduzida na versão 3.5 do Firefox.") }}

+

Iniciada na versão 3.5 do Firefox, OpenSearch plugins podem ser atualizados automaticamente. Para o suporte a este recurso, é preciso incluir uma url extra elemento do tipo  "application/opensearchdescription+xml".  O atributo  rel precisa ser "self" e o atributo template precisa ser a URL do documento OpenSearch para atualizar automaticamente.

+

Por exemplo:

+
<Url type="application/opensearchdescription+xml"
+     rel="self"
+     template="http://www.foo.com/mysearchdescription.xml" />
+
+
+ Nota: Neste momento, addons.mozilla.org (AMO) não dá suporte a updates automaticos do plugin OpenSearch plugins. Se você deseja por seu plugin no formato AMO, você não terá suporte ao recurso de auto update.
+

Dicas para solucionar problemas 

+

Se houver algum erro no seu XML do plugin de busca, você deve rodar o plugin do Firefox 2 para descobrir quais são os erros. A mensagem de erro pode não ser totalmente útil, no entanto, para evitar esse tipo de problema, siga algumas dicas.

+ +

Além disso,  o plugin de busca fornece um serviço de que pode ser usado por desenvolvedores. Use about:config para ser a propriedade 'browser.search.log' para true. As informações de log irá aparecer Error Console do Firefox (Tools->Error Console) quando os plugins de busca são adicionados.

+

Material de referência

+ diff --git a/files/pt-br/mozilla/add-ons/enviando-um-complemento-para-o-amo/index.html b/files/pt-br/mozilla/add-ons/enviando-um-complemento-para-o-amo/index.html new file mode 100644 index 0000000000..500f5ea50e --- /dev/null +++ b/files/pt-br/mozilla/add-ons/enviando-um-complemento-para-o-amo/index.html @@ -0,0 +1,24 @@ +--- +title: Enviando um Complemento para o AMO +slug: Mozilla/Add-ons/Enviando-um-complemento-para-o-AMO +translation_of: Mozilla/Add-ons/Distribution +--- +

Once you've developed a new add-on for a Mozilla-based product (Firefox, Thunderbird, or the Mozilla Suite), you'll want to make sure people can find out about and download it.

+

Mozilla provides the http://addons.mozilla.org (AMO) web site to provide a repository for add-ons for Mozilla software. When users click the "Get Extensions" link in the Add-ons window in Firefox, for example, they are directed to this site.

+

That makes AMO a great way to get your add-ons to the public. This article provides details on how to submit your article to AMO for distribution.

+
+ Note: Attaching your add-on to articles on the Mozilla Developer Center web site won't do you a lot of good, as we delete them.  This is not the right place to post your add-ons; please follow the instructions here instead.
+

1º Passo: Escreva seu complemento

+

This is important. It's hard to get an add-on accepted into AMO if you don't write it first. Really hard.

+

2º Passo: Teste seu complemento

+

Make sure it works before you submit it. You should try it out on every product you claim to support. In other words, you don't want to advertise that it works in both Firefox and Thunderbird if you haven't tested it in both. Make sure it works in every version you claim to support, too.

+

3º Passo: Embale seu complemento

+

Add-ons distributed by AMO need to be packaged properly as XPI files. See Extension Packaging for information on how to do this.

+

4º Passo: Crie uma conta AMO

+

You'll need to have an AMO account so that you can make submissions. To get one, visit the Register link at the top of any page on the AMO website. Fill out the form and follow the instructions to activate your account.

+

Obviously, you can skip this step if you already have an AMO account.

+

5º Passo: Envie seu complemento

+

To submit an add-on, go to the Developer Control Panel.

+

You will then be asked to supply a file, as well as information about the add-on.

+

Once the add-on has been reviewed, it will be made available for downloading. Reviews can take a varying amount of time depending on how many pending submissions there are and the availability of people to perform the reviews.

+

{{ languages( { "fr": "fr/Soumettre_un_module_sur_AMO" } ) }}

diff --git a/files/pt-br/mozilla/add-ons/gerenciador_de_add-on/index.html b/files/pt-br/mozilla/add-ons/gerenciador_de_add-on/index.html new file mode 100644 index 0000000000..3d2cca173d --- /dev/null +++ b/files/pt-br/mozilla/add-ons/gerenciador_de_add-on/index.html @@ -0,0 +1,61 @@ +--- +title: Gerenciador de Complementos +slug: Mozilla/Add-ons/Gerenciador_de_Add-on +translation_of: Mozilla/JavaScript_code_modules/Add-on_Manager +--- +

{{ gecko_minversion_header("2.0") }}

+ +

O Gerenciador de Add-on (Add-on Manager) é responsável por gerenciar todos os add-ons instalados no aplicativo. Através de suas APIs, informação sobre todos os add-ons instalados pode ser recuperada e novos add-ons podem ser instalados. As APIs foram projetadas para serem genéricas e suportar muitos tipos diferentes de add-ons.

+ +

Muitas funções na interface do Gerenciador de Add-on operam de modo assíncrono, retornando os resultados através de callbacks (funções de retrochamadas) passadas para as funções. As callbacks podem ser chamadas imediatamente enquanto as funções iniciais ainda estão em execução ou pouco tempo após, dependendo de quando os dados da requisição se tornem disponíveis.

+ +

Acessando os add-ons instalados

+ +

Informação sobre os add-ons instalados podem ser recuperadas através da  API principal AddonManager. Todas as suas funções são assíncronas, isso significa que uma função de callback deve ser passada para receber as instâncias de Addon. A função de callback pode muito bem ser chamada somente após a função da API retornar. Por exemplo:

+ +
Components.utils.import("resource://gre/modules/AddonManager.jsm");
+
+AddonManager.getAllAddons(function(aAddons) {
+  // Aqui aAddons é um array de objetos Addon
+});
+// Esse código será executado antes do código dentro da callback
+
+ +

Notificações sobre mudanças nos add-ons instalados são dispachadas para quaisquer AddonListeners. registrado Eles devem ser registrados através do método addAddonListener().

+ +

Instalando novos add-ons

+ +

Novos add-ons podem ser instalados usando os métodos getInstallForFile() ou getInstallForURL() do objeto AddonManager. Essas passsarão uma instância de AddonInstall para a função de callback, que pode, então, ser usada para instalar o add-on:

+ +
Components.utils.import("resource://gre/modules/AddonManager.jsm");
+
+AddonManager.getInstallForURL("http://www.foo.com/test.xpi", function(aInstall) {
+  // aInstall é uma instância de AddonInstall
+  aInstall.install();
+}, "application/x-xpinstall");
+
+ +

O progresso de AddonInstall pode ser monitorado usando um InstallListener. Um listener pode ser registgrado quer para uma instalação em particular usando o método addListener() ou para todas as instalações usando o método addInstallListener().

+ +

Encontrando atualizações

+ +

Pode-se verificar a existência de atualizações para Add-ons usando o método findUpdates(). Deve-se lhe passar um UpdateListener para receber informações sobre compatibilidade e informação de nova atualização. Qualquer atualização disponível é retornada  como um AddonInstall, pronto para ser baixado e instalado.

+ +

{{ h1_gecko_minversion("Detectando mudanças nos add-ons", "7.0") }}

+ +

Você também pode conseguir listas de add-ons que, na inicialização, foram modificados de diversos modos. O método  getStartupChanges() lhe permite descobir quais add-ons foram instalados, removidos, atualizados, habilitados ou desabilitados durante a inicialização do aplicativo.

+ +

Por exemplo, para dar uma olhada nos add-ons que foram desabilitados durante a inicialização:

+ +
Components.utils.import("resource://gre/modules/AddonManager.jsm");
+
+let addonIDs = AddonManager.getStartupChanges(AddonManager.STARTUP_CHANGE_DISABLED);
+if (addonIDs.length > 0) {
+  // addonIDs agora é um array das IDs dos  add-on que foram desabilitados
+alert("Nota: " + addonIDs.length + " add-ons foram desabilitados.");
+}
+
+ +

Veja também

+ +

{{ ListSubpages() }}

diff --git a/files/pt-br/mozilla/add-ons/index.html b/files/pt-br/mozilla/add-ons/index.html new file mode 100644 index 0000000000..9b1b760481 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/index.html @@ -0,0 +1,94 @@ +--- +title: Complementos +slug: Mozilla/Add-ons +tags: + - Add-ons + - Precisa de Tradução + - TopicStub +translation_of: Mozilla/Add-ons +--- +
{{AddonSidebar}}
+
Modifique e amplie os aplicativos da Mozilla
+ +

Complementos acrescentam novas funcionalidades para os aplicativos baseados no Gecko tais como Firefox, SeaMonkey e Thunderbird. Há dois tipos de complementos principais Extensões adicionam novas características para o aplicativo, enquanto Temas modificam a interface do aplicativo do usuário.

+ +

Para ambos, extensões e temas, a Mozilla opera o repositório em addons.mozilla.org, também conhecido como AMO. Quando você Envia complementos para o AMO eles são revisados e depois de passados na revisão, são disponibilizados aos usuários. Você não tem que enviar complementos para AMO, mas se enviar, os usuários terão mais confiança no fato de que eles foram revisados, e você pode se beneficiar da visibilidade AMO como uma fonte confiável para complementos úteis.

+ +

O termo "complemento"(Add-ons) inclui plugins, extensões, temas, e plug-ins de mecanismos de busca (tal como google, bing, etc.).

+ +

O Gerenciador de complementos pode afetar o comportamento do aplicativo que o hospeda. Nós desenvolvemos orientações de complementos para ajudar a garantir que eles proveriam uma boa experiência para os usuários. Estas orientações se aplicam em todos tipos de complementos, mesmo se eles são hospedados em addons.mozilla.org ou não.

+ +

O Gerenciador de complementos dá acesso aos complementos a fim de determinar o que está disponível, instalar, remover, desativar e atualizar.

+ +
+

Extensões

+ +

Extensões adicionam novas funcionalidades para aplicativos da Mozilla como Firefox e Thunderbird. Eles podem adicionar novos recursos ao navegador, como um jeito diferente de gerenciar as abas, e eles podem modificar o conteúdo da web para aperfeiçoar a usabilidade ou segurança sites específicos.

+ +

Há três tipos de técnicas diferentes que você pode utilizar para construir uma extensão: Add-on baseado em extensões SDK, extensões restartless inicializadas manualmente e extensões overlay.

+ + + +

Se você puder, é aconselhável utilizar o Add-on SDK, que usa o mecanismo de extensão restartless mas simplifica determinadas tarefas e limpa depois de si mesmo. Se o Add-on SDK não é suficiente para as suas necessidades, implemente uma extensão restartless manual no lugar.

+ +

Para obter mais informações sobre como escolher qual a técnica de usar, leia esta comparação.

+ +
+
+

Práticas Recomendadas

+ +

Não importa como você desenvolve uma extensão, existem algumas orientações que você pode seguir para ajudar a garantir que sua extensão fornece uma experiência tão boa para o usuário o quão possível.

+ +
+
Desempenho
+
Assegurando que sua extensão é rápida, responsiva e eficiente para a memória.
+
Segurança
+
Assegurando que sua extensão não exponha o usuário para websites maliciosos.
+
Etiqueta
+
Assegurando que sua extensão funcione bem com outras extensões.
+
+
+ +
+

Aplicativo específico

+ +

A maioria das documentações assume que você está desenvolvendo para o Firefox Desktop. Se você está desenvolvendo para algum outro aplicativo baseado no Gecko, há diferenças importantes que você precisa saber sobre.

+ +
+
Thunderbird
+
Desenvolvendo extensões para o Thunderbird mail client.
+
Firefox para Android
+
Desenvolvendo extensões para Firefox para Android.
+
SeaMonkey
+
Desenvolvendo extensões para SeaMonkey suíte de software.
+
+
+
+ +
+

Temas

+ +

Os temas são add-ons que personalizam a IU do aplicativo. Existem dois tipos de temas: temas leves e temas completos.

+ +
+
+

Temas Leves são muito mais simples de implementar do que temas completos, mas fornece a personalização muito limitada.

+
+ +
+

Com Temas Completos você pode fazer modificações mais profundas na IU. A documentação para temas completos é fora da data, mas está ligada a aqui como uma possível base para a documentação atualizada.

+
+
+ +
+

Outros tipos de complementos

+ +

Plugins de Search Engine são um tipo simples e muito específico de add-on: eles adicionam novos mecanismos de busca para barra de pesquisa do navegador.
+
+ Plugins ajuda a aplicação a entender o conteúdo web que não é suportado nativamente. Plugins NPAPI são uma tecnologia antiga e os novos sites não devem usá-las. Em geral, os plugins não estão disponíveis na maioria dos sistemas móveis modernos, e os sites devem evitar usar plugins.

diff --git a/files/pt-br/mozilla/add-ons/interface-com-o-repositorio_add-on/index.html b/files/pt-br/mozilla/add-ons/interface-com-o-repositorio_add-on/index.html new file mode 100644 index 0000000000..8b1970eb97 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/interface-com-o-repositorio_add-on/index.html @@ -0,0 +1,96 @@ +--- +title: Interface com o Repositório de Complementos +slug: Mozilla/Add-ons/Interface-com-o-Repositorio_Add-on +translation_of: Mozilla/JavaScript_code_modules/Interfacing_with_the_Add-on_Repository +--- +

{{ gecko_minversion_header("2.0") }}

+

The Add-on Repository JavaScript code module makes it easy for your extension to interface with the AMO repository. You an use the code module to get lists of add-ons and even install new add-ons. This article provides some sample code that queries the recommended add-ons list on AMO and lets the user click a button to install an add-on from the list.

+

Importando o módulo de código do repositório

+

Before you can use the Add-on Repository API, you need to import the code module:

+
Components.utils.import("resource://gre/modules/AddonRepository.jsm");
+
+

Having done this, you can then access the API through the resulting AddonRepository object.

+

Habilitando as características recomendadas

+

In current builds of Firefox 4, the recommendation API doesn't work because the preference for the URL to query to get recommended add-ons is not included by default; see {{ bug(628785) }}. To make the service work for the time being, you can use code like this when your extension starts up:

+
var prefsService = Components.classes["@mozilla.org/preferences-service;1"]
+                        .getService(Components.interfaces.nsIPrefService);
+var prefBranch = prefsService.getBranch("extensions.");
+
+var recUrl = "";
+
+try {
+  recUrl = prefBranch.getCharPref("getAddons.recommended.url");
+} catch(e) {
+  recurl = "";
+}
+
+if (recUrl == "") {
+  prefBranch.setCharPref("getAddons.recommended.url",
+                    "https://services.addons.mozilla.org/%LOCALE%/%APP%/api/%API_VERSION%/list/recommended/all/%MAX_RESULTS%/%OS%/%VERSION%?src=firefox");
+  prefsService.savePrefFile(null);
+}
+
+

This fetches the value of the extensions.getAddons.recommended.url preference, and, if the preference doesn't exist or has no value, sets the value of the preference to the correct one for the AMO site.

+

Iniciando uma requisição

+

To start a search of the repository, you can use either of the following methods:

+
+
+ searchAddons()
+
+ Queries the add-on repository for add-ons matching given search criteria.
+
+ retrieveRecommendedAddons()
+
+ Retrieves a list of recommended add-ons, as determined by the AMO site administrators.
+
+

This example will use the latter, in order to randomly select a recommended add-on and offer to install it. However, the code to perform a search term based query would be very similar.

+

When the user clicks a toolbar button to initiate the query, the following code gets run to start the request:

+
AddonRepository.retrieveRecommendedAddons(10, this);
+
+

This asks the repository to fetch up to 10 add-ons, using the object this as the target for callbacks. The callback object needs to implement the SearchCallback interface, providing the methods that get called when a search either fails or completes successfully.

+

Manipulando falsas requisições

+

The callback object must have a searchFailed() method; this gets called when a repository search fails to execute. The most common cause of failure (other than the search URL preference being incorrect) is if there is already a pending request, since only one request can be in progress at a time. For example:

+
searchFailed: function() {
+  this.showNotification("I have no recommendations for you right now!",
+          "Oh noes!", null);
+},
+
+

Here, we call a showNotification() method with some parameters that we'll look at shortly when we get to our showNotification() method below. The important thing to note is that this will handle the failure case.

+

Manipulando requisições de sucesso

+

The callback object's searchSucceeded() method gets called when a search completes successfully. It receives a list of the matching addons, the number of add-ons returned, and the total number of add-ons that matched the query (in case the returned number is smaller than the requested number, for example).

+

For example:

+
searchSucceeded: function(addons, addonCount, totalResults) {
+  var num = Math.floor(Math.random() * addonCount);
+
+  this.showNotification("Would you like to try the " + addons[num].name + " addon?",
+          "Install", addons[num].install);
+},
+
+

This routine randomly selects one of the returned add-ons, then calls the previously mentioned showNotification() routine, passing in as parameters a prompt including the name of the returned add-on, a label for the button to show in the notification ("Install"), and the AddonInstall object that can be used with the Add-on Manager API to install the add-on.

+

Instalando Extensões

+

The showNotification() routine displays a notification box offering to install the recommended add-on, if one was found, or reports an error if the search failed:

+
showNotification: function(prompt, button, installObj) {
+  this.install = installObj;
+  var box = PopupNotifications.show(gBrowser.selectedBrowser, "sample-popup",
+          prompt,
+          null, /* anchor ID */
+          {
+            label: button,
+            accessKey: "I",
+            callback: function() {
+              if (popupnotifications.install) {
+                popupnotifications.install.install();
+              } else {
+                PopupNotifications.remove(box);
+              }
+            }
+          },
+          null  /* secondary action */
+          );
+}
+
+

The code here starts by stashing the passed-in AddonInstall object for later use, then creates and displays the pop-up notification box with the text and button label passed into the method.

+

popup.png

+

The pop-up callback function that gets called when the user clicks the button looks to see if there's a non-null AddonInstall object reference; if it's null, then the pop-up is displaying an error notification, so clicking the button simply dismisses the pop-up. Otherwise, the AddonInstall object's install() method is called to install the add-on.

+

This doesn't display any UI showing that the install is taking place; however, if you go to the Add-on Manager panel, you'll see the pending install listed among your add-ons.

+

install.png

diff --git a/files/pt-br/mozilla/add-ons/orientacoes-de-complementos/index.html b/files/pt-br/mozilla/add-ons/orientacoes-de-complementos/index.html new file mode 100644 index 0000000000..fe51cb25a2 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/orientacoes-de-complementos/index.html @@ -0,0 +1,117 @@ +--- +title: Orientações de complementos +slug: Mozilla/Add-ons/Orientacoes-de-complementos +translation_of: 'https://extensionworkshop.com/documentation/publish/add-on-policies/' +--- +

These add-on guidelines were created to foster an open and diverse add-on developer community while ensuring an excellent user experience. They apply to all add-ons and add-on updates regardless of where they are hosted, and also apply to customizations performed by installers that configure Firefox without using an add-on. Add-ons hosted on AMO are subject to additional policies.

+

Ser Transparente

+ +

Respeitar os Usuários

+ +

Ser Seguro

+ +

Ser Estável

+ +

Exceções

+ +

Other exceptions may apply.

+

Aplicação

+

Add-ons that do not follow these guidelines may qualify for blocklisting, depending on the extent of the violations. Guidelines qualified with the word + + must + are especially important, and violations thereof will most likely result in a blocklisting nomination.

+

The Add-ons Team will do their best to contact the add-on's developers and provide a reasonable time frame for the problems to be corrected before a block is put in place. If an add-on is considered malicious or its developers have proven unreachable or unresponsive, or in case of repeat violations, blocklisting may be immediate.

+

Guideline violations should be reported via Bugzilla, under Tech Evangelism > Add-ons. Questions can be posted in the #addons IRC channel.

+

These guidelines may change in the future. All updates will be announced in the Add-ons Blog.

diff --git a/files/pt-br/mozilla/add-ons/overlay_extensions/index.html b/files/pt-br/mozilla/add-ons/overlay_extensions/index.html new file mode 100644 index 0000000000..6b6ac40112 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/overlay_extensions/index.html @@ -0,0 +1,71 @@ +--- +title: Overlay extensions +slug: Mozilla/Add-ons/Overlay_Extensions +tags: + - Add-ons + - Extensions + - Landing + - NeedsTranslation + - TopicStub +translation_of: Archive/Add-ons/Overlay_Extensions +--- +

This page contains links to documentation for the approach to developing extensions for Gecko-based applications which uses:

+ +

Before Gecko 2.0 was released this was the only way to develop extensions. Now there are two alternative techniques: restartless extensions and Add-on SDK-based extensions. The privileged JavaScript APIs described here can still be used by the newer techniques.

+

XUL School

+

XUL School is a comprehensive add-on development tutorial, focusing on Firefox extension development but mostly applicable to other Gecko-based applications.

+

More resources

+
+
+
+
+ Setting up your environment
+
+ Setting up the application for extension development.
+
+ XUL
+
+ Tutorials and reference for the user interface language used by XUL extensions.
+
+ Code snippets
+
+ Sample code for many of the things you'll want to do.
+
+ Installing extensions
+
+ How to install an extension by copying the extension files into the application's install directory.
+
+ Firefox add-ons developer guide
+
+ A guide to developing overlay extensions.
+
+
+
+
+
+ JavaScript code modules
+
+ JavaScript modules available to extension developers.
+
+ Extension preferences
+
+ How to specify the preferences for your extension that will appear in the Add-ons Manager.
+
+ Frequently Asked Questions
+
+ Common issues with extension development.
+
+ Extension packaging
+
+ How extensions are packaged and installed.
+
+ Binary Firefox extensions
+
+ Creating binary extensions for Firefox.
+
+
+
+

 

diff --git a/files/pt-br/mozilla/add-ons/repositorio_add-on/index.html b/files/pt-br/mozilla/add-ons/repositorio_add-on/index.html new file mode 100644 index 0000000000..cb3210e93a --- /dev/null +++ b/files/pt-br/mozilla/add-ons/repositorio_add-on/index.html @@ -0,0 +1,155 @@ +--- +title: Repositório Add-on +slug: Mozilla/Add-ons/Repositorio_Add-on +translation_of: Mozilla/JavaScript_code_modules/Add-on_Repository +--- +

{{ gecko_minversion_header("2") }}{{LegacyAddonsNotice}}

+ +

The Add-on Repository is responsible for finding available add-ons; it provides an interface for interacting with the addons.mozilla.org (AMO) site. Its API provides URLs that can be visited to browse the repository's add-ons. The API also offers two ways to search for and retrieve an array of Addon instances: {{ manch("retrieveRecommendedAddons") }}, which returns a list of recommended add-ons, and {{ manch("searchAddons") }}, which performs a search of the repository.

+ +

These searches are asynchronous; results are passed to the provided SearchCallback object when the search is completed. Results passed to the SearchCallback object only include add-ons that are compatible with the current application and are not already installed or in the process of being installed. AddonRepository can only process one search at a time. A new search will immediately fail if the AddonRepository is already handling another search request.

+ +

To import the Add-on Repository code module, use:

+ +
Components.utils.import("resource://gre/modules/AddonRepository.jsm");
+
+ +

Method overview

+ + + + + + + + + + + + + + + + + + + +
string getRecommendedURL()
string getSearchURL(in string searchTerms)
void cancelSearch()
void retrieveRecommendedAddons(in integer maxResults, in SearchCallback callback)
void searchAddons(in string searchTerms, in integer maxResults, in SearchCallback callback)
+ +

Properties

+ + + + + + + + + + + + + + + + + + + +
PropertyTypeDescription
homepageURLstringThe URL of the repository site's home page.
isSearchingbooleantrue if a search is currently in progress; otherwise false.
+ +

Methods

+ +

getRecommendedURL()

+ +

Returns the URL that can be visited to see recommended add-ons.

+ +
string getRecommendedURL();
+ +
Parameters
+ +

None.

+ +
Return value
+ +

An URL indicating the repository's page of recommended add-ons.

+ +

getSearchURL()

+ +

Returns an URL of a web page that can be visited to see search results for the specified search terms.

+ +
string getSearchURL(
+  in string searchTerms
+);
+ +
Parameters
+ +
+
searchTerms
+
Search terms used to search the repository.
+
+ +
Return value
+ +

The URL of the search results page for the specified search terms.

+ +

cancelSearch()

+ +

Cancels the search in progress. Does nothing if there is no search in progress.

+ +
void cancelSearch();
+ +
Parameters
+ +

None.

+ +

retrieveRecommendedAddons()

+ +

Begins a search for recommended add-ons in the repository. The list of recommended add-ons frequently changes. Results will be passed to the given SearchCallback callback.

+ +
void retrieveRecommendedAddons(
+  in integer maxResults,
+  in SearchCallback callback
+);
+ +
Parameters
+ +
+
+ +
+
maxResults
+
The maximum number of results to return.
+
callback
+
The SearchCallback callback to which results will be delivered.
+
+ +

searchAddons()

+ +

Begins a search for add-ons in this repository. Results will be passed to the given callback.

+ +
string searchAddons(
+  in string searchTerms,
+  in integer maxResults,
+  in SearchCallback callback
+);
+ +
Parameters
+ +
+
+ +
+
searchTerms
+
The search terms to pass to AMO. The results will match what you would get if you typed this string in the search box on the AMO web site.
+
maxResults
+
The maximum number of results to return.
+
callback
+
The SearchCallback callback to pass results to.
+
+ +

See also

+ + diff --git a/files/pt-br/mozilla/add-ons/sdk/guides/index.html b/files/pt-br/mozilla/add-ons/sdk/guides/index.html new file mode 100644 index 0000000000..1f7e439322 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/guides/index.html @@ -0,0 +1,367 @@ +--- +title: Guides +slug: Mozilla/Add-ons/SDK/Guides +tags: + - Add-on SDK + - NeedsTranslation + - TopicStub +translation_of: Archive/Add-ons/Add-on_SDK/Guides +--- +

+ +
+

Support for extensions using XUL/XPCOM or the Add-on SDK was removed in Firefox 57, released November 2017. As there is no supported version of Firefox enabling these technologies, this page will be removed by December 2020.

+ +

Add-ons using the techniques described in this document are considered a legacy technology in Firefox. Don't use these techniques to develop new add-ons. Use WebExtensions instead. If you maintain an add-on which uses the techniques described here, consider migrating it to use WebExtensions.

+ +

Starting from Firefox 53, no new legacy add-ons will be accepted on addons.mozilla.org (AMO) for desktop Firefox and Firefox for Android.

+ +

Starting from Firefox 57, only extensions developed using WebExtensions APIs will be supported on Desktop Firefox and Firefox for Android.

+ +

Even before Firefox 57, changes coming up in the Firefox platform will break many legacy extensions. These changes include multiprocess Firefox (e10s), sandboxing, and multiple content processes. Legacy extensions that are affected by these changes should migrate to use WebExtensions APIs if they can. See the "Compatibility Milestones" document for more information.

+ +

A wiki page containing resources, migration paths, office hours, and more, is available to help developers transition to the new technologies.

+
+ + + +

+ +

This page lists more theoretical in-depth articles about the SDK.

+ +
+

Contributor's guide

+ +
+
+
+
Getting Started
+
Learn how to contribute to the SDK: getting the code, opening/taking a bug, filing a patch, getting reviews, and getting help.
+
Modules
+
Learn about the module system used by the SDK (which is based on the CommonJS specification), how sandboxes and compartments can be used to improve security, and about the built-in SDK module loader, known as Cuddlefish.
+
Classes and Inheritance
+
Learn how classes and inheritance can be implemented in JavaScript, using constructors and prototypes, and about the helper functions provided by the SDK to simplify this.
+
+
+ +
+
+
Private Properties
+
Learn how private properties can be implemented in JavaScript using prefixes, closures, and WeakMaps, and how the SDK supports private properties by using namespaces (which are a generalization of WeakMaps).
+
Content Processes
+
The SDK was designed to work in an environment where the code to manipulate web content runs in a different process from the main add-on code. This article highlights the main features of that design.
+
Testing the Add-on SDK
+
Learn how to run the Add-on SDK test suites.
+
+
+
+ +
+

SDK infrastructure

+ +
+
+
+
Module structure of the SDK
+
The SDK, and add-ons built using it, are of composed from reusable JavaScript modules. This explains what these modules are, how to load modules, and how the SDK's module tree is structured.
+
SDK API lifecycle
+
Definition of the lifecycle for the SDK's APIs, including the stability ratings for APIs.
+
+
+ +
+
+
Program ID
+
The Program ID is a unique identifier for your add-on. This guide explains how it's created, what it's used for and how to define your own.
+
Firefox compatibility
+
Working out which Firefox releases a given SDK release is compatible with, and dealing with compatibility problems.
+
+
+
+ +
+

SDK idioms

+ +
+
+
+
Working With Events
+
Write event-driven code using the the SDK's event emitting framework.
+
Content scripts guide
+
An overview of content scripts, including: what they are, what they can do, how to load them, how to communicate with them.
+
+
+ +
+
+
Two Types of Scripts
+
This article explains the differences between the APIs available to your main add-on code and those available to content scripts.
+
+
+
+ +
+

XUL migration

+ +
+
+
+
XUL Migration Guide
+
Techniques to help port a XUL add-on to the SDK.
+
XUL versus the SDK
+
A comparison of the strengths and weaknesses of the SDK, compared to traditional XUL-based add-ons.
+
+
+ +
+
+
Porting Example
+
A walkthrough of porting a relatively simple XUL-based add-on to the SDK.
+
+
+
+ +
+

Multiprocess Firefox

+ +
+
+
+
Multiprocess Firefox and the SDK
+
How to check whether your add-on is compatible with multiprocess Firefox, and fix it if it isn't.
+
+
+ +
+
+ +
+
+
+
+

Join the Add-on SDK community

+ +
+
Choose your preferred method for joining the discussion:
+ + +
+ +
+ +
+
+
+
diff --git a/files/pt-br/mozilla/add-ons/sdk/guides/working_with_events/index.html b/files/pt-br/mozilla/add-ons/sdk/guides/working_with_events/index.html new file mode 100644 index 0000000000..9c51d1328f --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/guides/working_with_events/index.html @@ -0,0 +1,154 @@ +--- +title: Trabalhando com Eventos +slug: Mozilla/Add-ons/SDK/Guides/Working_with_Events +translation_of: Archive/Add-ons/Add-on_SDK/Guides/Working_with_Events +--- +

O Add-on SDK suporta programação dirigida a evento.

+ +

Objetos emitem eventos sobre mudança de estados que devem ser interessantes ao código do add-on, tais como abertura de janelas, carregamento de páginas, requisições de rede completas, e cliques de mouse. Pelo registro de uma função de escuta para um emissor de evento um add-on pode receber notificações destes eventos.

+ +

Nós falamos sobre scripts de conteúdo em mais detalhes no guia Working with Content Scripts.

+ +

Adicionalmente, se você está usando scripts de conteúdo para interagir com o conteúdo web, você pode definir seus próprios eventos e usá-los para comunicar entre o código principal do add-on e os scripts de conteúdo. Neste caso, uma extremidade da conversa emite os eventos, e a outra extremidade ouve.

+ +

Portanto, há dois modos principais que você interagirá com o framework emissor de eventos:

+ + + +

Este guia cobre somente o primeiro destes; o segundo é explicado no guia Working with Content Scripts.

+ +

Adicionando Escutadores

+ +

Você pode adicionar um escutador para um emissor de evento pela chamada ao seu método on(type, listener).

+ +

Ele leva dois parâmetros:

+ + + +

Por exemplo, o seguinte add-on registra uma escuta com o módulo tabs para esperar pelo evento ready, e registra uma string no console reportando o evento:

+ +
var tabs = require("sdk/tabs");
+
+tabs.on("ready", function () {
+  console.log("tab loaded");
+});
+
+ +

Não é possível enumerar o conjunto de escutas para um dado evento.

+ +

O valor de this na função de escuta é o objeto que emitiu o evento.

+ +

Escutando Todos os Eventos

+ +

Você pode passar o curinga "*" como o argumento type. Se você fizer isso, a escuta será chamada para qualquer evento emitido por qualquer objeto, e seu argumento será o nome do evento:

+ +
var ui = require("sdk/ui");
+var panels = require("sdk/panel");
+var self = require("sdk/self");
+
+var panel = panels.Panel({
+  contentURL: self.data.url("panel.html")
+});
+
+panel.on("*", function(e) {
+  console.log("event " + e + " was emitted");
+});
+
+var button = ui.ActionButton({
+  id: "my-button",
+  label: "my button",
+  icon: "./icon-16.png",
+  onClick: handleClick
+});
+
+function handleClick(state) {
+  panel.show({
+    position: button
+  });
+}
+ +

Esta característica do curinga não funciona ainda nos módulos tabs ou window.

+ +

Adicionando escutas em construtores

+ +

Emissores de evento podem ser módulos como no caso do evento ready acima, ou eles podem ser objetos retornados pelos construtores.

+ +

No último caso o objeto options passado para o construtor tipicamente define propriedades cujos nomes são nomes de tipos de eventos suportados prefixados com "on": por exemplo, "onOpen", "onReady" e assim por diante. Então o construtor pode atribuir uma função de escuta para aquela propriedade como uma alternativa a chamada do método do objeto on().

+ +

Por exemplo: o objeto ActionButton emite um evento quando o botão é clicado.

+ +

O add-on a seguir cria um botão e atribui uma escuta para a propriedade onClick do objeto fornecida no options do construtor do objeto botão. A escuta carrega https://developer.mozilla.org/:

+ +
require("sdk/ui/button/action").ActionButton({
+  id: "visit-mozilla",
+  label: "Visit Mozilla",
+  icon: "./icon-16.png",
+  onClick: function() {
+    require("sdk/tabs").open("https://developer.mozilla.org/");
+  }
+});
+
+ +

Isto é exatamente equivalente a construir o botão e então chamar o método on() do botão

+ +
var button = require("sdk/ui/button/action").ActionButton({
+  id: "visit-mozilla",
+  label: "Visit Mozilla",
+  icon: "./icon-16.png"
+});
+
+button.on("click", function() {
+  require("sdk/tabs").open("https://developer.mozilla.org/");
+});
+
+ +

Removendo Escutas de Evento

+ +

Escutas de evento pode ser removidos pela chamada de removeListener(type, listener), fornecendo o tipo do evento e escuta a remover.

+ +

A escuta deve ter sido previamente adicionada usando um dos métodos descritos acima.

+ +

No add-on a seguir, nós adicionamos duas escutas para o evento ready do módulo tab. Uma das funções de manipulação remove a escuta.

+ +

Então nós abrimos duas abas.

+ +
var tabs = require("sdk/tabs");
+
+function listener1() {
+  console.log("Listener 1");
+  tabs.removeListener("ready", listener1);
+}
+
+function listener2() {
+  console.log("Listener 2");
+}
+
+tabs.on("ready", listener1);
+tabs.on("ready", listener2);
+
+tabs.open("https://www.mozilla.org");
+tabs.open("https://www.mozilla.org");
+
+ +

Nós devemos ver a saída como esta:

+ +
info: tabevents: Listener 1
+info: tabevents: Listener 2
+info: tabevents: Listener 2
+
+ +

As escutas serão removidas automaticamente quando o add-on for descarregado.

diff --git a/files/pt-br/mozilla/add-ons/sdk/high-level_apis/index.html b/files/pt-br/mozilla/add-ons/sdk/high-level_apis/index.html new file mode 100644 index 0000000000..2537723562 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/high-level_apis/index.html @@ -0,0 +1,11 @@ +--- +title: High-Level APIs +slug: Mozilla/Add-ons/SDK/High-Level_APIs +tags: + - Add-on SDK + - NeedsTranslation + - TopicStub +translation_of: Archive/Add-ons/Add-on_SDK/High-Level_APIs +--- +

Modules listed on this page implement high-level APIs for building add-ons: creating user interfaces, interacting with the web, and interacting with the browser.

+

Unless the documentation explicitly says otherwise, all these modules are "Stable": we'll avoid making incompatible changes to them. {{ LandingPageListSubpages ("/en-US/Add-ons/SDK/High-Level_APIs", 5) }}

diff --git a/files/pt-br/mozilla/add-ons/sdk/high-level_apis/request/index.html b/files/pt-br/mozilla/add-ons/sdk/high-level_apis/request/index.html new file mode 100644 index 0000000000..01937e2036 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/high-level_apis/request/index.html @@ -0,0 +1,214 @@ +--- +title: request +slug: Mozilla/Add-ons/SDK/High-Level_APIs/request +translation_of: Archive/Add-ons/Add-on_SDK/High-Level_APIs/request +--- +
+

Stable

+
+ +

Faça requesições simples de rede. Para uso mais avançado, cheque os módulos net/xhr, baseado no objeto XMLHttpRequest do navegador.

+ +

Globals

+ +

Constructors

+ +

Request(options)

+ +

Este construtor cria um objeto request que pode ser usado para fazer requisições de rede. O construtor leva um único parâmetro options que é usado para configurar várias propriedades no resultado do Request.

+ +
Parâmetros
+ +

options : object
+ Opções opcionais:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType 
urlstring,url +

This is the url to which the request will be made. Can either be a String or an instance of the SDK's URL.

+
onCompletefunction +

This function will be called when the request has received a response (or in terms of XHR, when readyState == 4). The function is passed a Response object.

+
headersobject +

An unordered collection of name/value pairs representing headers to send with the request.

+
contentstring,object +

The content to send to the server. If content is a string, it should be URL-encoded (use encodeURIComponent). If content is an object, it should be a collection of name/value pairs. Nested objects & arrays should encode safely.

+ +

For GET and HEAD requests, the query string (content) will be appended to the URL. For POST and PUT requests, it will be sent as the body of the request.

+
contentTypestring +

The type of content to send to the server. This explicitly sets the Content-Type header. The default value is application/x-www-form-urlencoded.

+
overrideMimeTypestring +

Use this string to override the MIME type returned by the server in the response's Content-Type header. You can use this to treat the content as a different MIME type, or to force text to be interpreted using a specific character.

+ +

For example, if you're retrieving text content which was encoded as ISO-8859-1 (Latin 1), it will be given a content type of "utf-8" and certain characters will not display correctly. To force the response to be interpreted as Latin-1, use overrideMimeType:

+ + 
+var Request = require("sdk/request").Request;
+var quijote = Request({
+  url: "http://www.latin1files.org/quijote.txt",
+  overrideMimeType: "text/plain; charset=latin1",
+  onComplete: function (response) {
+    console.log(response.text);
+  }
+});
+
+quijote.get();
+
anonymousbooleanIf true, the request will be sent without cookies or authentication headers. This option sets the mozAnon property in the underlying XMLHttpRequest object. Defaults to false.
+ +

Request

+ +

The Request object is used to make GET, HEAD, POST, PUT, or DELETE network requests. It is constructed with a URL to which the request is sent. Optionally the user may specify a collection of headers and content to send alongside the request and a callback which will be executed once the request completes.

+ +

Once a Request object has been created a GET request can be executed by calling its get() method, a POST request by calling its post() method, and so on.

+ +

When the server completes the request, the Request object emits a "complete" event. Registered event listeners are passed a Response object.

+ +

Each Request object is designed to be used once. Attempts to reuse them will throw an error.

+ +

Since the request is not being made by any particular website, requests made here are not subject to the same-domain restriction that requests made in web pages are subject to.

+ +

With the exception of response, all of a Request object's properties correspond with the options in the constructor. Each can be set by simply performing an assignment. However, keep in mind that the same validation rules that apply to options in the constructor will apply during assignment. Thus, each can throw if given an invalid value.

+ +

The example below shows how to use Request to get the most recent tweet from the @mozhacks account:

+ +
var Request = require("sdk/request").Request;
+var latestTweetRequest = Request({
+  url: "https://api.twitter.com/1/statuses/user_timeline.json?screen_name=mozhacks&count=1",
+  onComplete: function (response) {
+    var tweet = response.json[0];
+    console.log("User: " + tweet.user.screen_name);
+    console.log("Tweet: " + tweet.text);
+  }
+});
+
+// Be a good consumer and check for rate limiting before doing more.
+Request({
+  url: "http://api.twitter.com/1/account/rate_limit_status.json",
+  onComplete: function (response) {
+    if (response.json.remaining_hits) {
+      latestTweetRequest.get();
+    } else {
+      console.log("You have been rate limited!");
+    }
+  }
+}).get();
+ +

Methods

+ +

get()

+ +

Make a GET request.

+ +

head()

+ +

Make a HEAD request.

+ +

post()

+ +

Make a POST request.

+ +

put()

+ +

Make a PUT request.

+ +

delete()

+ +

Make a DELETE request.

+ +

Properties

+ +

url

+ +

headers

+ +

content

+ +

contentType

+ +

response

+ +

Events

+ +

complete

+ +

The Request object emits this event when the request has completed and a response has been received.

+ +
Arguments
+ +

Response : Listener functions are passed the response to the request as a Response object.

+ +

Response

+ +

The Response object contains the response to a network request issued using a Request object. It is returned by the get(), head(), post(), put() or delete() method of a Request object.

+ +

All members of a Response object are read-only.

+ +

Properties

+ +

text

+ +

The content of the response as plain text.

+ +

json

+ +

The content of the response as a JavaScript object. The value will be null if the document cannot be processed by JSON.parse.

+ +

status

+ +

The HTTP response status code (e.g. 200).

+ +

statusText

+ +

The HTTP response status line (e.g. OK).

+ +

headers

+ +

The HTTP response headers represented as key/value pairs.

+ +

To print all the headers you can do something like this:

+ +
for (var headerName in response.headers) {
+  console.log(headerName + " : " + response.headers[headerName]);
+}
diff --git a/files/pt-br/mozilla/add-ons/sdk/high-level_apis/tabs/index.html b/files/pt-br/mozilla/add-ons/sdk/high-level_apis/tabs/index.html new file mode 100644 index 0000000000..22493dce1d --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/high-level_apis/tabs/index.html @@ -0,0 +1,671 @@ +--- +title: tabs +slug: Mozilla/Add-ons/SDK/High-Level_APIs/tabs +tags: + - Guías + - Tab +translation_of: Archive/Add-ons/Add-on_SDK/High-Level_APIs/tabs +--- +
+

Stable

+
+ +

Abre, manipula, e acessa tabs, e recebe eventos de tabs

+ +

Uso

+ +

Abrir uma tab

+ +

Você pode abrir uma nova tab, especificando várias propriedades incluindo localização:

+ +
var tabs = require("sdk/tabs");
+tabs.open("http://www.Exemplo.com");
+ +

Rastrear tabs

+ +

Você pode registrar eventos de escuta para ser notificado quando a tabs abre, fecha, termina o carregamento de conteúdo DOM, ou tornam-se ativa ou inativa:

+ +
var tabs = require("sdk/tabs");
+
+// Listen for tab openings.
+tabs.on('open', function onOpen(tab) {
+  myOpenTabs.push(tab);
+});
+
+// Listen for tab content loads.
+tabs.on('ready', function(tab) {
+  console.log('tab is loaded', tab.title, tab.url);
+});
+ +

Accessar tabs

+ +

O módulo por ele mesmo pode ser usado como uma lista de todas as tabs abertas em todos os navegadores. Em particular, você pode enumerá-las:

+ +
var tabs = require('sdk/tabs');
+for (let tab of tabs)
+  console.log(tab.title);
+ +

Você também pode acessar tabs individual pelo índice:

+ +
var tabs = require('sdk/tabs');
+
+tabs.on('ready', function () {
+  console.log('first: ' + tabs[0].title);
+  console.log('last: ' + tabs[tabs.length-1].title);
+});
+ +

Você pode acessar a tab ativa atualmente:

+ +
var tabs = require('sdk/tabs');
+
+tabs.on('activate', function () {
+  console.log('active: ' + tabs.activeTab.url);
+});
+ +

Rastrear uma única tab

+ +

Dada uma tab, você pode registrar escutas para eventos serem notificados quando a tab é fechada, ativada ou desativada, ou quando a página hospedad pela tab é carregada ou recuperada do "back-forward cache":

+ +
var tabs = require("sdk/tabs");
+
+function onOpen(tab) {
+  console.log(tab.url + " is open");
+  tab.on("pageshow", logShow);
+  tab.on("activate", logActivate);
+  tab.on("deactivate", logDeactivate);
+  tab.on("close", logClose);
+}
+
+function logShow(tab) {
+  console.log(tab.url + " is loaded");
+}
+
+function logActivate(tab) {
+  console.log(tab.url + " is activated");
+}
+
+function logDeactivate(tab) {
+  console.log(tab.url + " is deactivated");
+}
+
+function logClose(tab) {
+  console.log(tab.url + " is closed");
+}
+
+tabs.on('open', onOpen);
+ +

Manipular uma tab

+ +

Você pode conseguir e configurar várias propriedades de tabs (mas note que propriedades relacionadas ao conteúdo da tab, tal como URL, não conterão valores válidos até depois do evento ready disparar). Pela configuração da propriedade url você pode carregar uma nova página na tab:

+ +
var tabs = require("sdk/tabs");
+tabs.on('activate', function(tab) {
+  tab.url = "http://www.Exemplo.com";
+});
+ +

Execute scripts em um tab

+ +

Você pode anexar um script de conteúdo a página hospedad na tab, e usar aquele para acessar e manipular o conteúdo da página (veja o tutorial Modifying the Page Hosted by a Tab):

+ +
var tabs = require("sdk/tabs");
+
+tabs.on('activate', function(tab) {
+  var worker = tab.attach({
+    contentScript: 'self.port.emit("html", document.body.innerHTML);'
+  });
+  worker.port.on("html", function(message) {
+    console.log(message)
+  })
+});
+ +

Observe que tab.attach é centrado na tab: se o usuário navegar para uma nova página na mesma tab, então o trabalho e scripts de conteúdo serão reanexados á nova página.

+ +

Anexação de stylesheets

+ +
+

Novo no Firefox 34.

+
+ +

Você não pode anexar folhas de estilo para uma tab usando tab.attach(), mas do Firefox 34 em diante você pode anexar e desanexa-los usando APIs de baixo nível  stylesheet/style e content/mod. Aqui está um add-on que usa botões alternados para anexar uma folha de estilo a tab ativa, e desanexar novamente. A folha de estilo é chamada "style.css" e está localizada no diretório "data":

+ +
var tabs = require("sdk/tabs");
+var { attach, detach } = require('sdk/content/mod');
+var { Style } = require('sdk/stylesheet/style');
+var { ToggleButton } = require("sdk/ui/button/toggle");
+
+var style = Style({
+  uri: './style.css'
+});
+
+var button = ToggleButton({
+  id: "stylist",
+  label: "stylist",
+  icon: "./icon-16.png",
+  onChange: function(state) {
+    if (state.checked) {
+      attach(style, tabs.activeTab);
+    }
+    else {
+      detach(style, tabs.activeTab);
+    }
+  }
+});
+ +

Janelas Privadas

+ +

Se o seu add-on não optou por entrar em navegação privada, então você não verá quaisquer tabs pela janela de navegação privada.

+ +

Tabs hospedadas por janelas em navegação privada não serão vista se você enumerar o módulo tab por si mesmo, e você não receberá quaisquer eventos deles.

+ +

Para aprender mais sobre janelas privadas, como optar por entrar em navegação privada, e como suportar navegação privada, dirija-se à documentação do módulo para private-browsing.

+ +

Converção para XUL tabs

+ +

Para converter de um objeto Tab de alto nível usando esta API para um objeto XUL tab de baixo nível usado na API tabs/utils e por add-ons tradicionais, use a função viewFor() exportada pelo móduloa viewFor.

+ +

Para converter de volta, de uma tab XUL para um objeto Tab de alto nível, use a função modelFor(), exportada pelo módulo modelFor.

+ +

Aqui está um exemplo covertendo de uma Tab de alto nível para uma tab XUL e então converte de volta:

+ +
var { modelFor } = require("sdk/model/core");
+var { viewFor } = require("sdk/view/core");
+
+var tabs = require("sdk/tabs");
+var tab_utils = require("sdk/tabs/utils");
+
+function mapHighLevelToLowLevel(tab) {
+  // get the XUL tab that corresponds to this high-level tab
+  var lowLevelTab = viewFor(tab);
+  // now we can, for Exemplo, access the tab's content directly
+  var browser = tab_utils.getBrowserForTab(lowLevelTab);
+  console.log(browser.contentDocument.body.innerHTML);
+  // get the high-level tab back from the XUL tab
+  var highLevelTab = modelFor(lowLevelTab);
+  console.log(highLevelTab.url);
+}
+
+tabs.on("ready", mapHighLevelToLowLevel);
+
+ +

Observe que acessar objetos XUL diretamente e conteúdo web como este significa que você não está protegido pelas garantias de compatibilidades feitas pelas APIs de alto nível do SDK. Em particular, seu código não deve trabalhar com multiprocess Firefox.

+ +

Globais

+ +

Funções

+ +

open(opções)

+ +

Abre uma nova tab. A nova tab abrirá na janela ativa ou na nova janela, dependendo da opção inNewWindow.

+ +

Examplo

+ +
var tabs = require("sdk/tabs");
+
+// Open a new tab on active window and make tab active.
+tabs.open("http://www.mysite.com");
+
+// Open a new tab in a new window and make it active.
+tabs.open({
+  url: "http://www.mysite.com",
+  inNewWindow: true
+});
+
+// Open a new tab on active window in the background.
+tabs.open({
+  url: "http://www.mysite.com",
+  inBackground: true
+});
+
+// Open a new tab as an app tab and do something once it's open.
+tabs.open({
+  url: "http://www.mysite.com",
+  isPinned: true,
+  onOpen: function onOpen(tab) {
+    // do stuff like listen for content
+    // loading.
+  }
+});
+ +
Parâmetros
+ +

opção: object
+ Opções necessárias:

+ + + + + + + + + + + + + + + + +
NameType 
urlstring +

URL a ser aberta na nova tab. Esta é uma propriedade necessária.

+
+ +

Opções opcionais:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType 
isPrivateboolean +

Boolean que determinará se a nova tab deve ser privada ou não. Se seu add-on não suporta navegação privada isto não terá efeito. Veja a documentação de navegação privada para mais informação. O padrão é false.

+
inNewWindowboolean +

Se presente e true, uma nova janela de navegação será aberta e na primeira tab naquela janela. Esta é uma propriedade opcional.

+
inBackgroundboolean +

Se presente e true, a nova tab será aberta à direita da tab ativa e não estará ativa. Esta é uma propriedade opcional.

+
isPinnedboolean +

Se presente e true, a nova tab será anexada como um app tab.

+
onOpenfunction +

Uma função que será registrada para o evento 'open'. Esta é uma propriedade opcional.

+
onClosefunction +

Uma função de callback que será registrada para o evento 'close'. Esta é uma propriedade opcional.

+
onReadyfunction +

Uma função de callback que será registrada para o evento 'ready'. Esta é uma propriedade opcional.

+
onLoadfunction +

Uma função de callback que será registrada para o evento 'load'. Esta é uma propriedade opcional.

+
onPageShowfunction +

Uma função de callback que será registrada para o evento 'pageshow'. Esta é uma propriedade opcional.

+
onActivatefunction +

Uma função de callback que será registrada para o evento 'activate'. Esta é uma propriedade opcional.

+
onDeactivatefunction +

Uma função de callback que será registrada para o evento 'deactivate'. Esta é uma propriedade opcional.

+
+ +

Propriedades

+ +

activeTab

+ +

A tab ativa na janela ativa. Esta propriedade é somente leitura. Para ativar um objeto Tab, chame seu método activate.

+ +

Exemplo

+ +
// Get the active tab's title.
+var tabs = require("sdk/tabs");
+console.log("title of active tab is " + tabs.activeTab.title);
+ +

length

+ +

O número de tabs abertas em todas as janelas.

+ +

Eventos

+ +

open

+ +

Este evento é emitido quando uma nova tab é aberta. Isto não significa que o conteúdo carregou, somente que o navegador está inteiramente visível para o usuário.

+ +

Propriedades relacionadas à conteúdo da tab (por exemplo: title, favicon, e url) não serão corrigidas neste ponto. Se você precisar acessar estas propriedades, escute o evento ready:

+ +
var tabs = require("sdk/tabs");
+tabs.on('open', function(tab){
+  tab.on('ready', function(tab){
+    console.log(tab.url);
+  });
+});
+ +
Argumentos
+ +

Tab : Escutas são passadas ao objeto tab que acaba de abrir.

+ +

close

+ +

Este evento é emitido quando a tab é fechada. Quando a janela é fechada este evento será emitido para cada uma das tabs abertas naquela janela.

+ +
Argumentos
+ +

Tab : Escutas são passadas ao objeto tab que fechou.

+ +

ready

+ +

Este evento é emitido quando o DOM para o conteúdo da página estiver preparado. É equivalmente ao evento DOMContentLoaded para conteúdo da página dada.

+ +

Um única tab emitirá este evento toda vez todas às vezes que o DOM for carregado: então será emitido novamente se o endereço da página mudar ou o conteúdo for recarregado.

+ +

Depois que este evento for emitido, todas as propriedades relacionadas ao conteúdo da página poderão ser usadas.

+ +
Argumentos
+ +

Tab : Escutas são passadas ao objeto tab que carregou.

+ +

activate

+ +

Este evento é emitido quando uma tab inativa torna-se ativa.

+ +
Argumentos
+ +

Tab : Escutas são passadas para o objeto tab que torna-se ativa.

+ +

deactivate

+ +

Este evento é emitido quando a tab ativa torna-se inativa.

+ +
Argumentos
+ +

Tab : Escutas são passadas para o objeto tab que tornou-se inativo.

+ +

Tab

+ +

Uma instância Tab representa um única tab aberta. Ele contém várias propriedades, vários métodos para manipulação, assim como registração de evento por tab.

+ +

Tabs emitem todos os eventos descritos na seção de Eventos. Escutas são passadas ao objeto Tab que lança eventos.

+ +

Métodos

+ +

pin()

+ +

Anexa a tab como uma app tab.

+ +

unpin()

+ +

Desanexa esta tab.

+ +

close(callback)

+ +

Fecha esta tab.

+ +
Parâmetros
+ +

callback : function
+ Uma função será chamada quanto a tab termine seu processo de fechamento. Este é uma argumento opcional.

+ +

reload()

+ +

Recarrega esta tab.

+ +

activate()

+ +

Torna esta tab ativa, que trará esta tab para o primeiro plano.

+ +

getThumbnail()

+ +

Retorna o dado thumbnail da URI da página atualmente carregada nesta tab.

+ +

attach(options)

+ +

Anexa um ou mais scripts ao documento carregado na tab. Observe que este é centrado na tab: se o usuário navega para uma nova página na mesma tab, então o script de conteúdo será reanexado à nova página.

+ +

Exemplo

+ +
var tabs = require("sdk/tabs");
+
+tabs.on('ready', function(tab) {
+  var worker = tab.attach({
+      contentScript:
+        'document.body.style.border = "5px solid red";'
+  });
+});
+ +
Parâmetros
+ +

options : objeto
+ Opções opcionais:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType 
contentScriptFilestring,array +

As URLs dos arquivos locais dos scripts de conteúdo carregados. Scripts de conteúdo especificados por esta opção são carregados antes daqueles especificados pela opção contentScript. Opcional.

+
contentScriptstring,array +

Uma string ou uma array de strings do código para ser avaliado no contexto. Scripts de conteúdo especificados por esta opção são carregados depois daqueles especificados pela opção contentScriptFile. Opcional.

+
contentScriptOptionsobject +

Você pode usar esta opção para definir valores somente leitura para seus scripts de conteúdo.

+ +

A opção consiste de uma listagem de objetos literais no formato pares name:value para os valores que você quer fornecer para o script de conteúdo. Por exemplo:

+ + 
+// main.js
+
+const tabs = require("sdk/tabs");
+
+tabs.open({
+  url: "./page.html",
+  onReady: function(tab) {
+    tab.attach({
+      contentScriptFile: "./content-script.js",
+      contentScriptOptions: {
+        a: "blah"
+      }
+    });
+  }
+});
+ +

Os valores são acessíveis ao script de conteúdo via propriedade self.options:

+ + 
+// content-script.js
+
+alert(self.options.a);
+
onMessagefunction +

Uma função chamada quando o conteúdo de trabalho recebe uma mensagem dos scripts de conteúdo. Escutas são passadas como um único argumento, a mensagem postada do script de conteúdo.

+
onErrorfunction +

Uma função chamada quando o trabalhador de conteúdo recebe um erro dos scripts de conteúdo. Escutas são passar como um único argumento, error, que é erro postado do script de conteúdo e um objeto do tipo Error. Opcional.

+
+ +
Retorno
+ +

Worker : O objeto Worker pode ser usado para comunicar com o script de conteúdo. Veja o guia de scripts de conteúdo para aprender os detalhes.

+ +

Propriedades

+ +

id

+ +

O único id para a tab. Esta propriedade é somente leitura.

+ +

title

+ +

O título da tab (normalmente o título da página atualmente carregada na tab). Esta propriedade pode ser configurada para mudar o título da tab.

+ +

url

+ +

A URL da página atualmente carregada na tab. Esta propriedade pode ser configurada para carregar uma URL diferente na tab.

+ +

favicon

+ +

A URL do favicon para a página atualmente carregada na tab. Esta propriedade é somente para leitura.

+ +
Esta propriedade está desatualizada. Da versão 1.15, use a função getFavicon() do módulo favicon ao invés.
+ +

contentType

+ +
Esta é uma API experimental atualmente, então nós devemos mudar ele em lançamentos futuros. + +

Retorna o tipo MIME que o documento atualmente tem carregado na tab sendo desenhada. Ele deve vir do cabeçalho do HTTP ou outra fonte de informação MIME, e deve ser afetado pela conversão de tipo automática executada pelo navegador ou extensão. Esta propriedade é somente leitura.

+
+ +

index

+ +

O índice da tab relativa a outras tabs na janela da aplicação. Esta propriedade pode ser configurada para mudar sua posição relativa.

+ +

isPinned

+ +

Se ou não esta tab é anexável como uma app tab. Esta propriedade é somente leitura.

+ +

window

+ +

O objeto window para esta tab.

+ +

readyState

+ +
+

Novo no Firefox 33.

+
+ +

Uma string dizendo a você qual o estado de carga do documento hospedado por esta tab. Isto corresponde diretamente ao Document.readyState. Ele tem um de quatro valores possíveis:

+ + + +

Uma vez que o readyState da tab entrou no "interactive", você pode pegar as propriedades tais como a URL do documento.

+ +

Eventos

+ +

close

+ +

Este evento é emitido quando a tab é fechada. Ele também é emitido quando a janela da tab é fechada.

+ +
Argumentos
+ +

Tab : Escutas são passadas ao objeto tab.

+ +

ready

+ +

Este evento é emitido quando o DOM para o conteúdo da tab estiver preparado.  Ele é equivalente ao evento DOMContentLoaded para o dado conteúdo da página. Neste ponto o documento por si só está inteiramente carreado e analisado, mas recursos tais como folhas de estilo e imagens devem estar ainda carregando.

+ +

Uma única tab emitirá este evento todas às vezes que o DOM estiver carregado: então ela será emitida novamente se o endereço da tab mudar ou o conteúdo for recarregado. Depois deste evento ser emitido, todas as propriedades relacionadas ao conteúdo da tab podem ser usadas.

+ +
Argumentos
+ +

Tab : Escutas são passadas ao objeto tab.

+ +

load

+ +

Este evento é emitido quando a página do conteúdo da tab estiver carregada. É equivalente ao evento load para o dado conteúdo da página. Neste ponto o documento e seus recursos, tais como imagens e folhas de estilo, terminaram o carregamento.

+ +

Este evento pode ser usado por páginas que não tem um evento DOMContentLoaded, como imagens. Para páginas que tem um evento DOMContentLoaded, load é disparado depois do ready.

+ +

Uma única tab emitirá este evento toda vez que a página for carregada: então ele será emitido novamente se o endereço da tab mudar ou o conteúdo for recarregado. Depois deste evento ser emitido, todas as propriedades relacionadas ao conteúdo da tab podem ser usados

+ +
Argumentos
+ +

Tab : Escutas são passadas para o objeto tab.

+ +

pageshow

+ +

O evento pageshow é emitido quando a página para o conteúdo da tab for carregado. É equivalente ao evento pageshow para um dado conteúdo da página.

+ +

Este evento é similar aos eventos load e ready, exceto que diferente de load e ready, pageshow é lançado se a página for recuperada do bfcache. Isto significa que se o usuário carrega a página, carrega uma nova página, então se move para a página anterior usando o botão "Back", o evento pageshow é emitido quando o usuário volta a página, enquanto os eventos load e ready não são.

+ +

Este evento não é emitido quando a tab fica ativa: para conseguir ser notificado sobre isso, você precisa escutar o evento activate.

+ +

Depois que este evento foi emitido, todas as propriedades relacionadas ao conteúdo da tab podem ser usadas. Ele é emitido depois do load e ready.

+ +
Argumentos
+ +

Tab : Escutas são passadas ao objeto tab.

+ +

persisted : Escutas são passadas um valor booleano indicando se ou não a página foi carregada do bfcache.

+ +

activate

+ +

Este evento é emitido quando a tab torna-se ativa.

+ +

Observe que você não pode garantir que o conteúdo da tab, ou mesmo sua url, estão inicializados na hora que o activate foi emitido. Isto porque quando uma nova tab é aberta, seu evento activate pode ser emitido antes do conteúdo ser carregado.

+ +

Você pode usar a propriedade readyState da tab para determinar se o conteúdo da tab e url estão disponíveis: se o readyState está uninitialized ou loading, então você não pode acessar as propriedades da tab e deve esperar pelo evento ready da tab.

+ +
Argumentos
+ +

Tab : Escutas são passadas ao objeto.

+ +

deactivate

+ +

Este evento é emitido quando a tab torna-se inativa.

+ +
Argumentos
+ +

Tab : Escutas são passadas ao objeto tab.

diff --git a/files/pt-br/mozilla/add-ons/sdk/high-level_apis/windows/index.html b/files/pt-br/mozilla/add-ons/sdk/high-level_apis/windows/index.html new file mode 100644 index 0000000000..35c0b6bdb3 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/high-level_apis/windows/index.html @@ -0,0 +1,303 @@ +--- +title: Janelas +slug: Mozilla/Add-ons/SDK/High-Level_APIs/windows +tags: + - Add-on SDK +translation_of: Archive/Add-ons/Add-on_SDK/High-Level_APIs/windows +--- +
+

Stable

+
+ +

Enumera e examina janelas do navegador abertas, abre novas janelas, e escuta por eventos de janela.

+ +

Uso

+ +

O módulo windows fornece funções básicas para trabalhar janelas de navegador. Com este módulo, você pode:

+ + + +

Janelas Privadas

+ +

Se seu add-on não optou pela navegação privada, então você não verá qualquer janela de navegação privada. Janelas de navegação privada não aparecerão na propriedade browserWindows, você não receberá qualquer evento de janela, e você não será capaz de abrir janelas privadas.

+ +

Para aprender mais sobre navegação privada, como optar pela navegação privada, e como suportar navegação privada dirija-se à documentação para o módulo private-browsing.

+ +

Converção para as Janelas Chrome

+ +

Para converter do objeto BrowserWindow usando nesta API para o objeto chrome window usado na API window/utils, use a função viewFor() expotada pelo módulo viewFor().

+ +

Para converter de vola, de uma janela chrome para um objeto BrowserWindow, use a função  modelFor(), exportada pelo módulo modelFor.

+ +

Aqui está um exemplo convertendo do alto nível BrowserWindow para uma janela chrome, e então voltando para o outro modo:

+ +
var { modelFor } = require("sdk/model/core");
+var { viewFor } = require("sdk/view/core");
+
+var browserWindows = require("sdk/windows").browserWindows;
+
+function convertToChromeAndBack(browserWindow) {
+  // get the chrome window for this BrowserWindow
+  var chromeWindow = viewFor(browserWindow);
+  // now we can use the chrome window API
+  console.log(chromeWindow.document.location.href);
+  // -> "chrome://browser/content/browser.xul"
+
+  // convert back to the high-level window
+  var highLevelWindow = modelFor(chromeWindow);
+  // now we can use the SDK's high-level window API
+  console.log(highLevelWindow.title);
+}
+
+browserWindows.on("open", convertToChromeAndBack);
+ +

Note que acessar diretamente os objetos chrome de baixo nível significa que você não está protegido pelas garantias de compatibilidade das APIs de alto nível do SDK. Em particular, dependendo de o que você faz com estes objetos, seu código não deve trabalhar com multiprocess Firefox.

+ +

Globais

+ +

Funções

+ +

open(options)

+ +

Abre uma nova janela.

+ +
var windows = require("sdk/windows").browserWindows;
+
+// Open a new window.
+windows.open("http://www.example.com");
+
+// Open a new window and set a listener for "open" event.
+windows.open({
+  url: "http://www.example.com",
+  onOpen: function(window) {
+    // do stuff like listen for content
+    // loading.
+  }
+});
+ +

Retorna a janela que foi aberta:

+ +
var windows = require("sdk/windows").browserWindows;
+var example = windows.open("http://www.example.com");
+
+require("sdk/ui/button/action").ActionButton({
+  id: "read",
+  label: "Read",
+  icon: "./read.png",
+  onClick: function() {
+    example.close();
+  }
+});
+
+ +
+

Este exemplo usa a API action button, que está disponível somente do Firefox 29 em frente.

+
+ +
Parâmetros
+ +

options : object
+ Opções requeridas:

+ + + + + + + + + + + + + + + + + + + + + +
NameType 
urlstring +

String com a URL a ser aberta na nova janela. É uma propriedade necessária.

+
isPrivateboolean +

Boleano que determinará se a nova janela seria privada ou não. Se seus add-ons não suportam navegação privada isto não terá efeito. Veja a documentação sobre private-browsing para mais informação.

+
+ +

Opções opcionais:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType 
onOpenfunction +

Uma função de retorno que é chamada quando a janela está aberta. Isto não significa que o conteúdo da URL foi carregado, somente que a janela por si está inteiramente funcional e suas propriedades podem ser acessadas. Isto é uma propriedade opcional.

+
onClosefunction +

Uma função de retorno que é chamada quando a janela será chamada. Isto é uma propriedade opcional.

+
onActivatefunction +

Uma função de retorno que é chamada quando a janela está ativa. Isto é uma propriedade opcional.

+
onDeactivatefunction +

Uma função de retorno que é chamada quando a janela não está ativa. Isto é uma propriedade opcional.

+
+ +
Retorna
+ +

BrowserWindow :

+ +

Properties

+ +

browserWindows

+ +

browserWindows fornece acesso a todas as janelas de navegadores abertas com os objetos BrowserWindow.

+ +
var windows = require("sdk/windows");
+for (let window of windows.browserWindows) {
+  console.log(window.title);
+}
+
+console.log(windows.browserWindows.length);
+ +

Este objeto emite todos os eventos listados na seção "Eventos':

+ +
var windows = require("sdk/windows").browserWindows;
+
+// add a listener to the 'open' event
+windows.on('open', function(window) {
+  myOpenWindows.push(window);
+});
+
+// add a listener to the 'close' event
+windows.on('close', function(window) {
+  console.log("A window was closed.");
+});
+
+// add a listener to the 'activate' event
+windows.on('activate', function(window) {
+  console.log("A window was activated.");
+});
+
+// add a listener to the 'deactivate' event
+windows.on('deactivate', function(window) {
+  console.log("A window was deactivated.");
+});
+ +

A janela ativa atual é data pelo BrowserWindows.activeWindow:

+ +
var windows = require("sdk/windows").browserWindows;
+
+windows.on('activate', function(window) {
+  console.log("A window was activated.");
+  var activeWindowTitle = windows.activeWindow.title;
+  console.log("Active window title is: " + activeWindowTitle);
+});
+ +

Eventos

+ +

open

+ +

Evento emitido quando uma nova janela é aberta. Isso não significa que o conteúdo foi carregado, somente que a janela do navegador por si só está inteiramente visível ao usuário.

+ +
Argumentos
+ +

Window : Escutas são passadas para o objeto window que desencadeou o evento.

+ +

close

+ +

Evento emitido quando uma janela é fechada. Você não pode sempre confiar na recepção do evento close para todas as janelas abertas. Em particular, se o usuário fechar o navegador de forma preciptada o que pode fechar o add-on antes das janelas serem fechadas.

+ +
Argumentos
+ +

Window : escutas são passadas para o objeto window lançou o evento.

+ +

activate

+ +

Evento emitido quando uma janela inativa é tornada ativa.

+ +
Argumentos
+ +

Window : Escutas são passadas para o objeto window que torna ativa.

+ +

deactivate

+ +

Evento emitido quando a janela ativa se torna inativa.

+ +
Arguments
+ +

Window : Escutas são passadas para o objeto window que se tornou inativa.

+ +

BrowserWindow

+ +

Uma instância BrowserWindow representa uma única janela aberta. Elas podem ser recuperadas da propriedade browserWindows exportadas pelo módulo.

+ +
var windows = require("sdk/windows").browserWindows;
+
+//Print how many tabs the current window has
+console.log("The active window has " +
+            windows.activeWindow.tabs.length +
+            " tabs.");
+
+// Print the title of all browser windows
+for (let window of windows) {
+  console.log(window.title);
+}
+
+// close the active window
+windows.activeWindow.close(function() {
+  console.log("The active window was closed");
+});
+ +

Métodos

+ +

activate()

+ +

Torna a janela ativa, que focará aquela janela e trará ela para o primeiro plano.

+ +

close(callback)

+ +

Fecha a janela.

+ +
Parâmetros
+ +

callback : function
+ Uma função chamada quando a janela termina seu processo de fechamento. É um argumento opcional.

+ +

Propriedades

+ +

title

+ +

O título atual da janela. Normalmente o título da tab ativa, mais um identificador da app. Esta propriedade é somente leitura.

+ +

tabs

+ +

Uma lista ao vivo das tabs na janela. Esse objeto tem as mesma interface da API tabs, exceto que ele contem somente as tabs nesta janela, não todas as tabs em todas as janelas. Esta propriedade é somente leitura.

diff --git a/files/pt-br/mozilla/add-ons/sdk/index.html b/files/pt-br/mozilla/add-ons/sdk/index.html new file mode 100644 index 0000000000..88ed15ad16 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/index.html @@ -0,0 +1,102 @@ +--- +title: Add-on SDK +slug: Mozilla/Add-ons/SDK +tags: + - Add-on SDK + - Extensões +translation_of: Archive/Add-ons/Add-on_SDK +--- +

Usando a SDK de Add-ons você pode criar add-ons para Firefox usando tecnologias web padrão: Javascript, HTML e CSS. A SDK inclui APIs Javascript as quais você pode utilizar para criar add-ons, além de ferramentas para rodar, testar e empacotar os mesmos.

+
+

Tutoriais

+
+
+
+
+ Começando
+
+ Como instalar a SDK e usar a ferramenta cfx para desenvolver, testar e empacotar add-ons.
+
+ Interagindo com o Navegador
+
+ Abrir páginas web, escutar por carregamento de páginas e listar páginas abertas.
+
+ Técnicas de Desenvolvimento
+
+ Aprenda técnicas comúns de desenvolvimento, tal como testes unitários, registramento, criando módulos reutilizáveis, localização e desenvolvimento mobile.
+
+
+
+
+
+ Crie componentes de Interface de Usuário
+
+ Crie componentes de interface de usuário tais como botões de toolbar, menus de contexto, itens de menu e dialogs.
+
+ Modifique páginas Web
+
+ Modifique páginas que verificam um padrão de URL ou dinamicamente modifique uma aba em particular.
+
+ Juntando Tudo
+
+ Um guia sobre o exemplo do add-on Annotator
+
+
+
+
+

Guia

+
+
+
+
+ Guia do Contribuidor
+
+ Aprenda sobre como começar a contribuir para a SDK e sobre os idiomas mais importantes utilizados no código da SDK, tal como módulos, classes e herança, propriedades privadas e processos de conteúdo.
+
+ Infraestrutura da SDK
+
+ Aspectos da tecnologia fundamental da SDK: módulos, o ID de Programa e regras que definem compatibilidade do Firefox.
+
+ Content scripts
+
+ Um guia detalhado sobre trabalhar com content scripts, incluindo: como carregar content scripts, que objetos content scripts podem acessar e como comunicar entre content scripts e o resto do add-on.
+
+
+
+
+
+ Idiomas da SDK
+
+ O event framework da SDK e uma distinção entre scripts add-on e content scripts.
+
+ Migração de XUL
+
+ Um guia sobre como portar add-ons XUL para a SDK. Este guia inclui uma comparação das duas ferramentas e um exemplo funcionando de como portal um add-on XUL.
+
+
+
+
+

Referência

+
+
+
+
+ APIs Alto Nível
+
+ Documentação referência para as APIs de Alto nível da SDK.
+
+ Referência de Ferramentas
+
+ Documentação referência para a ferramenta cfx usada para desenvolver, testar e empacotar add-ons, o console global usado para registro e o arquivo package.json.
+
+
+
+
+
+ APIs Baixo Nível
+
+ Documentação referência para as APIs baixo nível.
+
+
+
+

 

diff --git a/files/pt-br/mozilla/add-ons/sdk/low-level_apis/index.html b/files/pt-br/mozilla/add-ons/sdk/low-level_apis/index.html new file mode 100644 index 0000000000..8cd08458f0 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/low-level_apis/index.html @@ -0,0 +1,23 @@ +--- +title: Low-Level APIs +slug: Mozilla/Add-ons/SDK/Low-Level_APIs +tags: + - NeedsTranslation + - TopicStub +translation_of: Archive/Add-ons/Add-on_SDK/Low-Level_APIs +--- +

Modules in this section implement low-level APIs. These modules fall roughly into three categories:

+ +

These modules are still in active development, and we expect to make incompatible changes to them in future releases.

+

{{ LandingPageListSubpages ("/en-US/Add-ons/SDK/Low-Level_APIs", 5) }}

+

 

diff --git a/files/pt-br/mozilla/add-ons/sdk/low-level_apis/ui_sidebar/index.html b/files/pt-br/mozilla/add-ons/sdk/low-level_apis/ui_sidebar/index.html new file mode 100644 index 0000000000..a8bd2be2eb --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/low-level_apis/ui_sidebar/index.html @@ -0,0 +1,455 @@ +--- +title: ui/sidebar +slug: Mozilla/Add-ons/SDK/Low-Level_APIs/ui_sidebar +translation_of: Archive/Add-ons/Add-on_SDK/Low-Level_APIs/ui_sidebar +--- +

{{AddonSidebar}}

+ +
+

Experimental

+
+ +

Enables you to create sidebars. A sidebar is a vertical strip of user interface real estate for your add-on that's attached to the left-hand side of the browser window. You specify its content using HTML, CSS, and JavaScript, and the user can show or hide it in the same way they can show or hide the built-in sidebars.

+ +

Usage

+ +

Creating, showing, and hiding sidebars

+ +

You construct a Sidebar object using the Sidebar() constructor.

+ +

Once you've done that, you can show the sidebar by calling the Sidebar's show() method. If a new window is opened from a window that has a sidebar visible, the new window gets a sidebar, too.

+ +

You can hide the sidebar by calling its hide() method.

+ +

Called with no arguments, show() and hide() will operate on the currently active window. From Firefox 33 onwards you can pass a BrowserWindow into these methods, and they will then operate on the specified window.

+ +

Alternatively, the View->Sidebar submenu in Firefox will contain a new item which the user can use to show or hide the sidebar:

+ +

The sidebar generates a show event when it is shown and a hide event when it is hidden.

+ +

Once you've finished using the sidebar you can destroy it by calling its dispose() method.

+ +

To show what a sidebar looks like, here's a sidebar that displays the results of running the W3C Validator on the current page:

+ +

+ +

Specifying sidebar content

+ +

O conteúdo de uma barra lateral é especificado usando HTML, que é carregado a partir da URL fornecida na opção url do construtor da barra lateral. Ao contrário de módulos como panel,  o conteúdo deve ser local, normalmente carregado do diretório de dados ('data') da extensão, através de um URL contruída usando self.data.url():

+ +
var sidebar = require("sdk/ui/sidebar").Sidebar({
+  id: 'my-sidebar',
+  title: 'My sidebar',
+  url: require("sdk/self").data.url("sidebar.html")
+});
+ +
+

From Firefox 34, you can use "./sidebar.html" as an alias for self.data.url("sidebar.html"). So you can rewrite the above code like this:

+ +
var sidebar = require("sdk/ui/sidebar").Sidebar({
+  id: 'my-sidebar',
+  title: 'My sidebar',
+  url: "./sidebar.html"
+});
+
+ +

Você pode incluir JavaScript e CSS no HTML como faria com qualquer página da web, por exemplo, usando tags <script> e <link> contendo o caminho relativo ao próprio arquivo HTML.

+ +
<!DOCTYPE HTML>
+<html>
+  <head>
+    <link href="stuff.css" type="text/css" rel="stylesheet">
+  </head>
+  <body>
+    <script type="text/javascript" src="stuff.js"></script>
+  </body>
+</html>
+
+
+ +

You can update the sidebar's content by setting the sidebar's url property. This will change the sidebar's content across all windows.

+ +

Communicating with sidebar scripts

+ +

You can't directly access your sidebar's content from your main add-on code, but you can send messages between your main add-on code and scripts loaded into your sidebar.

+ +

On the sidebar end of the conversation, sidebar scripts get a global variable addon that contains a port for sending and receiving messages.

+ +

On the add-on side, you need to get a worker object for the sidebar before you can send or receive messages. There are two events emitted by the sidebar which will give you a worker: attach and ready. Listen to attach if the first message in your add-on goes from the sidebar scripts to the main add-on code, and listen to ready if the first message goes from the main add-on code to the sidebar script.

+ +

Using attach

+ +

The  attach event is triggered whenever the DOM for a new sidebar instance is loaded and its scripts are attached. The sidebar script may not be initialized yet, so you can't reliably send messages to the sidebar script right away: however, you can start listening to messages from the script.

+ +

Here's a simple but complete add-on that shows how to set up communication between main.js and a script in a sidebar, in the case where the sidebar script initiates communication:

+ +

The HTML file includes just a script, "sidebar.js":

+ +
<!DOCTYPE HTML>
+<html>
+  <body>
+    Content for my sidebar
+    <script type="text/javascript" src="sidebar.js"></script>
+  </body>
+</html>
+
+
+ +

The "sidebar.js" file sends a ping message to main.js using port.emit() as soon as it loads, and adds a listener to the pong message.

+ +
addon.port.emit("ping");
+
+addon.port.on("pong", function() {
+  console.log("sidebar script got the reply");
+});
+ +

The "main.js" file creates a sidebar object and adds a listener to its attach event. On attach, "main.js" starts listening to the ping message, and responds with a pong:

+ +
var sidebar = require("sdk/ui/sidebar").Sidebar({
+  id: 'my-sidebar',
+  title: 'My sidebar',
+  url: require("sdk/self").data.url("sidebar.html"),
+  onAttach: function (worker) {
+    worker.port.on("ping", function() {
+      console.log("add-on script got the message");
+      worker.port.emit("pong");
+    });
+  }
+});
+ +

Try running the add-on, and showing the sidebar using the "View->Sidebar->My sidebar" menu item. You should see console output like:

+ +
console.log: add-on: add-on script got the message
+console.log: add-on: sidebar script got the reply
+
+ +

Using ready

+ +

The ready event is emitted when the DOM for the sidebar's content is ready. It is equivalent to the DOMContentLoaded event. At this point the sidebar script is initialized, so you  can send messages to the sidebar script and be confident that they will not be lost. Listen to this event if your add-on initiates the conversation.

+ +

Here's a simple but complete add-on that shows how to set up communication between main.js and a script in a sidebar, in the case where the main.js script initiates communication:

+ +

The HTML file includes just a script, "sidebar.js":

+ +
<!DOCTYPE HTML>
+<html>
+  <body>
+    Content for my sidebar
+    <script type="text/javascript" src="sidebar.js"></script>
+  </body>
+</html>
+
+
+ +

The "sidebar.js" file listens to the ping message from main.js, and responds with a pong message.

+ +
addon.port.on("ping", function() {
+  console.log("sidebar script got the message");
+  addon.port.emit("pong");
+});
+ +

The "main.js" file creates a sidebar object and adds a listener to its attach event. On attach, "main.js" sends the ping message, and starts listening for the pong:

+ +
var sidebar = require("sdk/ui/sidebar").Sidebar({
+  id: 'my-sidebar',
+  title: 'My sidebar',
+  url: require("sdk/self").data.url("sidebar.html"),
+  onReady: function (worker) {
+    worker.port.emit("ping");
+    worker.port.on("pong", function() {
+      console.log("add-on script got the reply");
+    });
+  }
+});
+ +

Try running the add-on, and showing the sidebar using the "View->Sidebar->My sidebar" menu item. You should see console output like:

+ +
console.log: add-on: sidebar script got the message
+console.log: add-on: add-on script got the reply
+
+ +

 

+ +

Globals

+ +

Constructors

+ +

Sidebar(options)

+ +

Creates a sidebar.

+ +
var sidebar = require("sdk/ui/sidebar").Sidebar({
+  id: 'my-sidebar',
+  title: 'My sidebar',
+  url: require("sdk/self").data.url("sidebar.html"),
+  onAttach: function (worker) {
+    console.log("attaching");
+  },
+  onShow: function () {
+    console.log("showing");
+  },
+  onHide: function () {
+    console.log("hiding");
+  },
+  onDetach: function () {
+    console.log("detaching");
+  }
+});
+ +
Parameters
+ +

options : object
+ Required options:

+ + + + + + + + + + + + + + + + + + + + + +
NameType 
titlestring +

A title for the sidebar. This will be used for the label for your sidebar in the "Sidebar" submenu in Firefox, and will be shown at the top of your sidebar when it is open.

+
urlstring +

The URL of the content to load in the sidebar. This must be a local URL (typically, loaded from the "data" folder using self.data.url()).

+ +
+

From Firefox 34, you can use "./myFile.html" as an alias for self.data.url("myFile.html").

+
+
+ +

Optional options:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType 
idstring +

The id of the sidebar. This used to identify this sidebar in its chrome window. It must be unique.

+ +
+

This option was mandatory before Firefox 28.

+
+
onAttachfunction +

Listener for the sidebar's attach event.

+
onDetachfunction +

Listener for the sidebar's detach event.

+
onShowfunction +

Listener for the sidebar's show event.

+
onHidefunction +

Listener for the sidebar's hide event.

+
+ + + +

The Sidebar object. Once a sidebar has been created it can be shown and hidden in the active window using its show() and hide() methods. Once a sidebar is no longer needed it can be destroyed using dispose().

+ +

Methods

+ +

dispose()

+ +

Destroys the sidebar. Once destroyed, the sidebar can no longer be used.

+ +

show(window)

+ +

Displays the sidebar.

+ +
Parameters
+ +

window : BrowserWindow
+ The window in which to show the sidebar, specified as a BrowserWindow. This parameter is optional. If it is omitted, then the sidebar will be shown in the currently active window. This parameter is new in Firefox 33.

+ +

hide(window)

+ +

Hides the sidebar.

+ +
Parameters
+ +

window : BrowserWindow
+ The window for which to hide the sidebar, specified as a BrowserWindow. This parameter is optional. If it is omitted, then the sidebar will be hidden for the currently active window. This parameter is new in Firefox 33.

+ +

on(type, listener)

+ +

Registers an event listener with the sidebar.

+ +
Parameters
+ +

type : string
+ The type of event to listen for.

+ +

listener : function
+ The listener function that handles the event.

+ +

once(type, listener)

+ +

Registers an event listener with the sidebar. The difference between on and once is that on will continue listening until it is removed, whereas once is removed automatically upon the first event it catches.

+ +
Parameters
+ +

type : string
+ The type of event to listen for.

+ +

listener : function
+ The listener function that handles the event.

+ +

removeListener(type, listener)

+ +

Unregisters/removes an event listener from the sidebar.

+ +
Parameters
+ +

type : string
+ The type of event for which listener was registered.

+ +

listener : function
+ The listener function that was registered.

+ +

Properties

+ +

id

+ +

The id of the sidebar. This used to identify this sidebar in its chrome window. It must be unique.

+ +

title

+ +

The title of the sidebar. This will be used for the label for your sidebar in the "Sidebar" submenu in Firefox, and will be shown at the top of your sidebar when it is open.

+ +

url

+ +

The URL of the content to load in the sidebar. This must be a local URL (typically, loaded from the "data" folder using self.data.url()).

+ +

Events

+ +

attach

+ +

This event is emitted when a worker is attached to a sidebar, as a result of any of the following:

+ + + +

It is passed a worker as an argument, which defines port.emit() and port.on() methods that you can use to send messages to, and receive messages from, scripts loaded into the sidebar.

+ +

This is the event you should listen to if your main add-on code needs to communicate with the scripts loaded into the sidebar, and the sidebar scripts start the conversation.

+ +

See Using attach for an example.

+ +

ready

+ +

This event is emitted after the DOM content for a sidebar has been loaded, as a result of any of:

+ + + +

It is passed a worker as an argument, which defines port.emit() and port.on() methods that you can use to send messages to, and receive messages from, scripts loaded into the sidebar.

+ +

This is the event you should listen to if your main add-on code needs to communicate with the scripts loaded into the sidebar and the main add-on code starts the conversation.

+ +

See Using ready for an example.

+ +

detach

+ +

This event is emitted when a worker is detached from a sidebar, as a result of either of the following:

+ + + +

The detach listener receives a worker object as a parameter. This object is the same as the worker passed into the corresponding attach event. After detach, this worker can no longer be used to communicate with the scripts in that sidebar instance, because it has been unloaded.

+ +

If you listen to attach, and in the listener take a reference to the worker object that's passed into it, so you can send it messages later on, then you should probably listen to detach, and in its handler, remove your reference to the worker.

+ +

Here's an add-on that adds each worker to an array in the attach handler, and makes sure that its references are cleaned up by listening to detach and removing workers as they are detached:

+ +
var workerArray = [];
+
+function attachWorker(worker) {
+  workerArray.push(worker);
+}
+
+function detachWorker(worker) {
+  var index = workerArray.indexOf(worker);
+  if(index != -1) {
+    workerArray.splice(index, 1);
+  }
+}
+
+var sidebar = require("sdk/ui/sidebar").Sidebar({
+  id: 'my-sidebar',
+  title: 'My Sidebar',
+  url: require("sdk/self").data.url("sidebar.html"),
+  onAttach: attachWorker,
+  onDetach: detachWorker
+});
+ +

show

+ +

This event is emitted when the sidebar is shown, as a result of any of the following:

+ + + +

hide

+ +

This event is emitted when the sidebar is hidden, as a result of either of the following:

+ + diff --git a/files/pt-br/mozilla/add-ons/sdk/low-level_apis/window_utils/index.html b/files/pt-br/mozilla/add-ons/sdk/low-level_apis/window_utils/index.html new file mode 100644 index 0000000000..5ceef79058 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/low-level_apis/window_utils/index.html @@ -0,0 +1,386 @@ +--- +title: window/utils +slug: Mozilla/Add-ons/SDK/Low-Level_APIs/window_utils +translation_of: Archive/Add-ons/Add-on_SDK/Low-Level_APIs/window_utils +--- +
+

Unstable

+
+ +
+

Note that this module includes functions that give you direct access to web content. These functions are not safe to call in multiprocess Firefox. See Multiprocess Firefox and the SDK for more details.

+
+ +

Functions for working with browser windows.

+ +

Usage

+ +

Private windows

+ +

With this module your add-on will see private browser windows even if it has not explicitly opted into private browsing, so you need to take care not to store any user data derived from private browser windows.
+
+ The exception is the windows() function which returns an array of currently opened windows. Private windows will not be included in this list if your add-on has not opted into private browsing.
+
+ To learn more about private windows, how to opt into private browsing, and how to support private browsing, refer to the documentation for the private-browsing module.

+ +

Globals

+ +

Functions

+ +

getMostRecentBrowserWindow()

+ +

Get the topmost browser window, as an nsIDOMWindow instance.

+ +
Returns
+ +

nsIDOMWindow: the topmost browser window.

+ +

getInnerId(window)

+ +

Returns the ID of the specified window's current inner window. This function wraps nsIDOMWindowUtils.currentInnerWindowID.

+ +
Parameters
+ +

window : nsIDOMWindow
+ The window whose inner window we are interested in.

+ +
Returns
+ +

ID: the given window's ID.

+ +

getOuterId(window)

+ +

Returns the ID of the specified window's outer window. This function wraps nsIDOMWindowUtils.outerWindowID.

+ +
Parameters
+ +

window : nsIDOMWindow
+ The window whose outer window we are interested in.

+ +
Returns
+ +

ID: the outer window's ID.

+ +

getXULWindow(window)

+ +

Returns the nsIXULWindow for the given nsIDOMWindow:

+ +
var { Ci } = require('chrome');
+var utils = require('sdk/window/utils');
+var active = utils.getMostRecentBrowserWindow();
+active instanceof Ci.nsIXULWindow // => false
+utils.getXULWindow(active) instanceof Ci.nsIXULWindow // => true
+ +
Parameters
+ +

window : nsIDOMWindow

+ +
Returns
+ +

nsIXULWindow

+ +

getBaseWindow(window)

+ +

Returns the nsIBaseWindow for the given nsIDOMWindow:

+ +
var { Ci } = require('chrome');
+var utils = require('sdk/window/utils');
+var active = utils.getMostRecentBrowserWindow();
+active instanceof Ci.nsIBaseWindow // => false
+utils.getBaseWindow(active) instanceof Ci.nsIBaseWindow // => true
+ +
Parameters
+ +

window : nsIDOMWindow

+ +
Returns
+ +

nsIBaseWindow

+ +

getToplevelWindow(window)

+ +

Returns the toplevel nsIDOMWindow for the given child nsIDOMWindow:

+ +
var { Ci } = require('chrome');
+var utils = require('sdk/window/utils');
+var browserWindow = utils.getMostRecentBrowserWindow();
+var window = browserWindow.content; // `window` object for the current webpage
+utils.getToplevelWindow(window) == browserWindow // => true
+ +
Parameters
+ +

window : nsIDOMWindow

+ +
Returns
+ +

nsIDOMWindow

+ +

getWindowDocShell(window)

+ +

Returns the nsIDocShell for the tabbrowser element.

+ +
Parameters
+ +

window : nsIDOMWindow

+ +
Returns
+ +

nsIDocShell

+ +

getWindowLoadingContext(window)

+ +

Returns the nsILoadContext.

+ +
Parameters
+ +

window : nsIDOMWindow

+ +
Returns
+ +

nsILoadContext

+ +

open(uri, options)

+ +

This function is used to open top level (application) windows. It takes the uri of the window document as its first argument and an optional hash of options as its second argument.

+ +
var { open } = require('sdk/window/utils');
+var window = open('data:text/html,Hello Window');
+ +

This function wraps nsIWindowWatcher.openWindow.

+ +
Parameters
+ +

uri : string
+ URI of the document to be loaded into the window.  Only chrome, resource, and data schemes are accepted.

+ +

options : object
+ Options for the function, with the following properties:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType 
parentnsIDOMWindowParent for the new window. Optional, defaults to null.
namestringName that is assigned to the window. Optional, defaults to null.
featuresobject +

Map of features to set for the window, defined like this: { width: 10, height: 15, chrome: true }.

+ +

See the window.open features documentation for more details.

+ +

Optional, defaults to an empty map: {}.

+ + 
+var { open } = require('sdk/window/utils');
+var window = open('data:text/html,Hello Window', {
+  name: 'jetpack window',
+  features: {
+    width: 200,
+    height: 50,
+    popup: true
+  }
+});
+
argsobjectExtra argument(s) to be attached to the new window as the window.arguments property.
+ +

+ Returns
+ +

nsIDOMWindow

+ +

openDialog(options)

+ +

Opens a top level window and returns its nsIDOMWindow representation. This is the same as open, but you can supply more features. It wraps window.openDialog.

+ +
Parameters
+ +

options : object
+ Options for the function, with the following properties:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameType 
urlstringURI of the document to be loaded into the window. Defaults to "chrome://browser/content/browser.xul".
namestringOptional name that is assigned to the window. Defaults to "_blank".
featuresstring +

Map of features to set for the window, defined like: { width: 10, height: 15, chrome: true }.

+ +

For the set of features you can set, see the window.openDialog documentation.

+ +

Optional, defaults to: 'chrome,all,dialog=no'.

+
argsobjectExtra argument(s) to be attached to the new window as the window.arguments property.
+ +
Returns
+ +

nsIDOMWindow

+ +

windows()

+ +

Returns an array of all currently opened windows. Note that these windows may still be loading.

+ +

In order to see private windows in this list, your add-on must have opted into private browsing and you must include the includePrivate key in the list of options:

+ +
  var allWindows = window_utils.windows(null, {includePrivate:true});
+
+ +
Parameters
+ +

type : string
+ String identifying the type of window to return. This is passed directly into nsIWindowMediator.getEnumerator(), so its possible values are the same as those expected by that function. In particular:

+ + + +

If you're not also passing options, you can omit this, and it's the same as passing null.

+ +

options : object
+ Options object containing the following property:

+ + + + + + + + + + + + + + + + +
NameType 
includePrivatebooleanWhether to include private windows. Defaults to false. The add-on must also have opted into private windows for this to have an effect.
+ +
Returns
+ +

Array: array of nsIDOMWindow instances.

+ +

isDocumentLoaded(window)

+ +

Check if the given window's document is completely loaded. This means that its "load" event has been fired and all content is loaded, including the whole DOM document, images, and any other sub-resources.

+ +
Parameters
+ +

window : nsIDOMWindow

+ +
Returns
+ +

boolean: true if the document is completely loaded.

+ +

isBrowser(window)

+ +

Returns true if the given window is a Firefox browser window: that is, its document has a "windowtype" of "chrome://browser/content/browser.xul".

+ +
Parameters
+ +

window : nsIDOMWindow

+ +
Returns
+ +

boolean

+ +

getWindowTitle(window)

+ +

Get the title of the document hosted by the given window

+ +
Parameters
+ +

window: nsIDOMWindow

+ +
Returns
+ +

string: this document's title.

+ +

isXULBrowser(window)

+ +

Returns true if the given window is a XUL window.

+ +
Parameters
+ +

window : nsIDOMWindow

+ +
Returns
+ +

boolean

+ +

getFocusedWindow()

+ +

Gets the child window within the topmost browser window that is focused. See nsIFocusManager for more details.

+ +
Returns
+ +

nsIDOMWindow

+ +

getFocusedElement()

+ +

Get the element that is currently focused. This will always be an element within the document loaded in the focused window, or null if no element in that document is focused.

+ +
Returns
+ +

nsIDOMElement

+ +

getFrames(window)

+ +

Get the frames contained by the given window.

+ +
Parameters
+ +

window : nsIDOMWindow

+ +
Returns
+ +

array: array of frames.
+  

diff --git "a/files/pt-br/mozilla/add-ons/sdk/tutorials/abra_uma_p\303\241gina_web/index.html" "b/files/pt-br/mozilla/add-ons/sdk/tutorials/abra_uma_p\303\241gina_web/index.html" new file mode 100644 index 0000000000..defcedcee2 --- /dev/null +++ "b/files/pt-br/mozilla/add-ons/sdk/tutorials/abra_uma_p\303\241gina_web/index.html" @@ -0,0 +1,51 @@ +--- +title: Abra uma Página Web +slug: Mozilla/Add-ons/SDK/Tutorials/Abra_uma_Página_Web +tags: + - Add-on SDK + - Tab + - runScript + - tab.attach +translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Open_a_Web_Page +--- +
Para seguir este tutorial você precisará ter instalado o SDK e ter conhecimento básico sobre cfx.
+ +

Para abrir uma página web, você pode usar o módulo tabs:

+ +
var tabs = require("sdk/tabs");
+tabs.open("http://www.example.com");
+
+ +

Esta função é assíncrona, então você não recebe imediatamente um objeto tab que você possa examinar. Faça isto, passe uma função de retorno para open(). A função de retorno é atribuída a propriedade onReady, e será passada a tab como argumento:

+ +
var tabs = require("sdk/tabs");
+tabs.open({
+  url: "http://www.example.com",
+  onReady: function onReady(tab) {
+    console.log(tab.title);
+  }
+});
+
+ +

Mesmo assim, você não consegue acesso direto a qualquer conteúdo hospedado na tab.

+ +

Para acessar conteúdo da tab você precisa anexar um script à tab usando o tab.attach(). Este add-on carrega uma página, então anexa um script à página que adiciona uma borda vermelha nela:

+ +
var tabs = require("sdk/tabs");
+tabs.open({
+  url: "http://www.example.com",
+  onReady: runScript
+});
+
+function runScript(tab) {
+  tab.attach({
+    contentScript: "document.body.style.border = '5px solid red';"
+  });
+}
+
+ +

Aprendendo Mais

+ +

Para aprender mais sobre uso de tabs no SDK, veja a referência da API tabs.

+ +

Para aprender mais sobre execução de scripts em tabs, veja o tutorial sobre uso de tab.attach().

diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/adding_a_button_to_the_toolbar/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/adding_a_button_to_the_toolbar/index.html new file mode 100644 index 0000000000..83b2f61907 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/tutorials/adding_a_button_to_the_toolbar/index.html @@ -0,0 +1,83 @@ +--- +title: Adicionando um botão à barra de ferramentas +slug: Mozilla/Add-ons/SDK/Tutorials/Adding_a_Button_to_the_Toolbar +translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Adding_a_Button_to_the_Toolbar +--- +
+

Para seguir este tutorial você precisará ter instalado o SDK e ter conhecimento básico do cfx.

+ +

Este tutorial usa a API action button, que está disponível somente do Firefox 29 em diante.

+
+ +

Para adicionar um botão à barra de ferramentas, use os módulos action button ou toggle button.

+ +

Crie um novo diretório, navegue até ele, e execute cfx init.

+ +

Então salve estes três ícones no diretório "data":

+ + + + + + + + + + + + + + + + +
icon-16.png
icon-32.png
icon-64.png
+ +

Então abra o arquivo chamado "main.js" no diretório "lib" e adicione o seguinte código a ele:

+ +
var buttons = require('sdk/ui/button/action');
+var tabs = require("sdk/tabs");
+
+var button = buttons.ActionButton({
+  id: "mozilla-link",
+  label: "Visit Mozilla",
+  icon: {
+    "16": "./icon-16.png",
+    "32": "./icon-32.png",
+    "64": "./icon-64.png"
+  },
+  onClick: handleClick
+});
+
+function handleClick(state) {
+  tabs.open("https://www.mozilla.org/");
+}
+ +

Agora execute o add-on com cfx run. O botão é adicionado à barra de ferramentas no topo da janela do navegador:

+ +

Você não pode configurar a localização inicial para o botão, mas o usuário pode mover ele usando as características de personalização do navegador. O id é obrigatório, e é usado para lembrar a posição do botão, então você não deve mudá-lo em versões subsequentes do add-on.

+ +

Clicando no botão carrega https://www.mozilla.org/ em uma nova tab.

+ +

Especificando o ícone

+ +

A propriedade ícone pode especificar um único ícone ou uma coleção de ícones em diferentes tamanhos, como o exemplo acima. Se você especificar uma coleção de ícones em diferentes tamanhos o navegador automaticamente escolherá o melhor para a resolução de tela em uso e coloca na interface de usuário do navegador que hospeda o botão. Leia mais sobre especificar múltiplos ícones.

+ +

O arquivo de ícone deve ser empacotado com seu add-on: ele não pode referenciar um arquivo remoto.

+ +

Você pode mudar o ícone a qualquer hora configurando a propriedade icon do botão. Você pode mudar o ícone, e os outros atributos de estado, ou globalmente, para uma janela específica, ou para uma tab específica. Leia mais sobre atualização de estado.

+ +

Anexando um painel

+ +

Se você precisar anexar um panel a um botão, use a API toggle button. É como a API do action button exceto que ele adiciona uma propriedade boleana checked que é alternada sempre que o botão é checado. Para anexar o painel, passe o método show() do painel. Para mais detalhes sobre isso, veja a documentação do toggle button.

+ +

Mostrando conteúdo mais rico

+ +

Para criar conteúdo mais complexo para a interface do usuário do que é possível com apenas um botão, use a API toolbar. Com a API toolbar você consegue uma faixa horizontal da interface do usuário. Você pode adicionar botões à barra de ferramentas e também frames, que podem ter HTML, CSS, e JavaScript.

+ +

Aprendendo mais

+ + diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/adicionar_uma_item_de_menu_ao_firefox/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/adicionar_uma_item_de_menu_ao_firefox/index.html new file mode 100644 index 0000000000..ebc4e41846 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/tutorials/adicionar_uma_item_de_menu_ao_firefox/index.html @@ -0,0 +1,115 @@ +--- +title: Adicionar um item de menu ao Firefox +slug: Mozilla/Add-ons/SDK/Tutorials/Adicionar_uma_item_de_menu_ao_Firefox +tags: + - Add-on SDK + - Menu Item +translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Add_a_Menu_Item_to_Firefox +--- +
+

Para seguir este tutorial você precisará ter instalado o SDK e aprendido o básico do cfx.

+
+ +
+

Se vocé estiver usando jpm ao invés de cfx, o método para usar módulos de terceiros é diferente, e você deve ler a versão jpm ao invés deste guia.

+
+ +

O SDK não tem ainda uma API para adicionar novos itens de menu ao Firefox. Mas é extensível por design, então qualquer um pode construir e publicar módulos para desenvolvedores de add-on usar. Felizmente, Erik Vold escreveu um módulo menuitems que nos permite adicionar itens de menu.

+ +

Este tutorial tem dupla função. Ele descreve o método geral para usar um externo, módulo de terceiro em seu add-on, e ele descreve como adicionar um item de menu usando o módulo menuitems em especial.

+ +

Primeiro, crie um novo add-on. Crie um diretório chamado "clickme" onde você quiser, navegue para ele e execute cfx init.

+ +
mkdir clickme
+cd clickme
+cfx init
+
+ +

A estrutura de diretório de costume será criada:

+ + + +
 
+ +

Inslatando menuitems

+ +

Crie um diretório em "clickme" chamado "packages". Baixe o pacote menuitems de https://github.com/mykmelez/menuitems-jplib e extrai ele dentro do diretório "packages" que você criou:

+ +
mkdir packages
+cd packages
+tar -xf ../erikvold-menuitems-jplib-d80630c.zip
+
+ +

Dependências de Módulo

+ +

Se os módulos de terceiros dependem de módulos SDK, você pode usá-los imediatamente, mas se eles dependem de módulos de terceiros, você terá de instalar essas dependências também.

+ +

No diretório principal do pacote (menuitems) você encontrará um arquivo chamado "package.json". Abra ele e procure por uma entrada chamada "dependencies". A entrada para o pacote menuitems é:

+ +
"dependencies": ["api-utils", "vold-utils"]
+
+ +

Isso nos diz que nós precisamos instalar o pacote vold-utils, que nós podemos fazer baixando ele de https://github.com/mykmelez/vold-utils-jplib e adicionando ele ao diretório packages com menuitems. Veja também api-utils Docs(UtilsAPI).

+ +

Usando menuitems

+ +

A documentação para o módulo menuitems nos diz para criar um item de menu usando MenuItem(). Das opções aceitas pelo MenuItem(), nós usaremos este conjunto mínimo:

+ + + +
+
+
var menuitem = require("menuitems").Menuitem({
+  id: "clickme",
+  menuid: "menu_ToolsPopup",
+  label: "Click Me!",
+  onCommand: function() {
+    console.log("clicked");
+  },
+  insertbefore: "menu_pageInfo"
+});
+ +
 
+
+
+ +

Próximo, nós temos que declarar nossa dependência do pacote menuitems. No package.json de nosso add-on adicionamos a linha:

+ +
"dependencies": "menuitems"
+
+ +

Observe que devido ao bug 663480, se você adicionar uma linha dependencies ao package.json, e você usar qualquer módulo do SDK, então você deve também declarar sua dependência naquele pacote embutido, como isto:

+ +
"dependencies": ["menuitems", "addon-sdk"]
+
+ +

Agora terminamos. Execute o add-on e você verá o novo item aparecer no menu de Ferramentas: selecione ele e você verá a info: clicked aparecer no console.

+ +

Cuidados

+ +

Módulos de terceiros são uma ótima forma de usar características não suportadas diretamente pelo SDK, mas porque módulos de terceiros usam APIs de nível baixo, eles podem quebrar quando forem lançadas novas versões do Firefox.

+ +

 

diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/adicione_um_item_ao_menu_de_contexto/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/adicione_um_item_ao_menu_de_contexto/index.html new file mode 100644 index 0000000000..d864cd3029 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/tutorials/adicione_um_item_ao_menu_de_contexto/index.html @@ -0,0 +1,120 @@ +--- +title: Adicione um Item ao Menu de Contexto +slug: Mozilla/Add-ons/SDK/Tutorials/Adicione_um_Item_ao_Menu_de_Contexto +tags: + - Add-on SDK + - Firefox + - Guide + - context-menu +translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Add_a_Context_Menu_Item +--- +
+

Para seguir este tutorial você precisará ter instalado o SDK e ter conhecimento básico sobre cfx.

+
+ +

Para adicionar itens e submenus ao menu de contexto do Firetox, use o módulo  context-menu.

+ +

Aqui está um add-on que adiciona um novo item ao menu de contexto. O item é mostrado sempre que alguma coisa na página é selecionada. Quando é clicado, a seleção é enviada para o código principal do add-on, que apenas registra ele:

+ +
var contextMenu = require("sdk/context-menu");
+ var menuItem = contextMenu.Item({
+  label: "Log Selection",
+  context: contextMenu.SelectionContext(),
+  contentScript: 'self.on("click", function () {' +
+                 '  var text = window.getSelection().toString();' +
+                 '  self.postMessage(text);' +
+                 '});',
+  onMessage: function (selectionText) {
+    console.log(selectionText);
+  }
+});
+ +

Teste: execute o add-on, carregue uma página web, selecione algum texto e clique com o botão direito. Você verá o novo item aparecer:

+ +

+ +

Clique nele, e a seleção é registrada no console (ou na shell, se você estiver executando uma instância do Firefox na linha de comando):

+ +
info: elephantine lizard
+
+ +

Detalhes

+ +

Tudo que este add-on faz é criar um item no menu de contexto. Você não precisa adicioná-lo: uma vez que você criou o item, ele é automaticamente adicionado no contexto correto. O construtor nesse caso possui quatro opções: label, context, contentScript, e onMessage.

+ +

label

+ +

O label é tão somente a string que será mostrada.

+ +

context

+ +

O context descreve a circunstância em que o item será mostrado. O módulo context-menu oferece uma série de contextos embutidos, incluindo este SelectionContext(), que significa: mostrar o item quando alguma coisa na página for selecionada.

+ +

Se estes simples contextos não forem suficiente, você pode definir contextos mais sofisticados usando scripts.

+ +

contentScript

+ +

Este anexa um script ao item. Nesse caso o script espera pelo clique do usuário no item, então envia uma mensagem para o add-on contendo do texto selecionado.

+ +

onMessage

+ +

A propriedade onMessage oferece um modo para o código do add-on responder mensagens do script anexado ao item do menu de contexto. Nesse caso é apenas registrado o texto selecionado.

+ +

Então:

+ +
    +
  1. O usuário clica no item
    2. +
  2. o conteúdo do script do evento click dispara, e o conteúdo do script recupera o texto selecionado e envia a mensagem para o add-on
    3. +
  3. o evento message do add-on dispara, e ao código manipulador da função é passado o texto selecionado, que é registrado
    4. +
+ +

Mais opções

+ +

Adicionando uma imagem

+ +

Você pode adicionar uma imagem ao menu de contexto por meio da opção image. Isto é uma URL apontando para um ícone 16x16 que é mostrado do lado esquerdo do item do menu de contexto. Geralmente você armazenaria sua imagem no diretório "data" do seu add-on, e construiria a URL usando self.data.url():

+ +
var self = require("sdk/self");
+
+var contextMenu = require("sdk/context-menu");
+var menuItem = contextMenu.Item({
+  label: "Log Selection",
+  context: contextMenu.SelectionContext(),
+  contentScript: 'self.on("click", function () {' +
+                 '  var text = window.getSelection().toString();' +
+                 '  self.postMessage(text);' +
+                 '});',
+  image: self.data.url("icon-16.png"),
+  onMessage: function (selectionText) {
+    console.log(selectionText);
+  }
+});
+ +

Adicione uma tecla de atalho

+ +
+

Novo no Firefox 35.

+
+ +

A partir do Firefox 35 você pode especificar uma tecla de atalho usando a opção  accessKey. Deve ser somente um caracter. Pressione a tecla selecionada na opção quando o menu de contexto estiver aberto:

+ +
var contextMenu = require("sdk/context-menu");
+var menuItem = contextMenu.Item({
+  label: "Log Selection",
+  context: contextMenu.SelectionContext(),
+  contentScript: 'self.on("click", function () {' +
+                 '  var text = window.getSelection().toString();' +
+                 '  self.postMessage(text);' +
+                 '});',
+  accessKey: "l",
+  onMessage: function (selectionText) {
+    console.log(selectionText);
+  }
+});
+
+ +

 

+ +

Aprendendo mais

+ +

Aprendendo mais sobre o módulo context-menu, veja a referência da API context-menu.

diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/captura_de_carregamento_da_pagina/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/captura_de_carregamento_da_pagina/index.html new file mode 100644 index 0000000000..1fa1ae81d6 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/tutorials/captura_de_carregamento_da_pagina/index.html @@ -0,0 +1,28 @@ +--- +title: Captura de carregamento da página +slug: Mozilla/Add-ons/SDK/Tutorials/captura_de_carregamento_da_pagina +translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Listen_for_Page_Load +--- +
+ Para seguir esse tutorial você necessita ter instalado o SDK e aprendido o básico do cfx.
+

Você pode capturar notificações sobre novas páginas em carregamento usando o módulo tabs. O seguinte complemento captura o evento ready da aba e mostra no console a URL da mesma, carregada pelo usuário:

+
require("sdk/tabs").on("ready", logURL);
+
+function logURL(tab) {
+  console.log(tab.url);
+}
+
+

Você não tem acesso direto a qualquer conteúdo hospedado na guia.

+

Para acessar o conteúdo da aba você precisa anexar um script usando tab.attach(). Este add-on atribui um script para todas as abas abertas. O script adiciona uma borda vermelha ao documento da aba:

+
require("sdk/tabs").on("ready", runScript);
+
+function runScript(tab) {
+  tab.attach({
+    contentScript: "if (document.body) document.body.style.border = '5px solid red';"
+  });
+}
+
+

(Este exemplo é apenas para mostrar a idéia: para implementar algo como isso, você deve usar page-mod, e especificar "*" como o match-pattern.)

+

Aprendendo Mais

+

Para aprender mais sobre o trabalho com abas no SDK, veja a referência de tab da API. Você pode capturar uma série de outros eventos da aba, incluindo open, close e activate.

+

Para ler mais sobre rodar scripts nas abas, veja o tutorial sobre como usar tab.attach().

diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/chrome_authority/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/chrome_authority/index.html new file mode 100644 index 0000000000..0e09ecdc02 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/tutorials/chrome_authority/index.html @@ -0,0 +1,65 @@ +--- +title: Autoridade Chrome +slug: Mozilla/Add-ons/SDK/Tutorials/Chrome_Authority +translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Chrome_Authority +--- +
+

A API usada para ganhar acesso ao Chrome atualmente é uma característica experimental do SDK, e deve mudar em lançamentos futuros.

+
+ +

Usando Autoridade Chrome

+ +

Os módulos de baixo-nível mais poderosos são executados com "chrome privileges", que nos dão acesso ao infame Objeto Components, que concede acesso irrestrito ao host. A partir daí, o módulo pode fazer praticamente qualquer coisa que o navegador é capaz. Para obter estes privilégios, o módulo deve declarar sua intenção com uma declaração como a seguinte:

+ +
var {Cc, Ci} = require("chrome");
+ +

O objeto retornado pelo require("chrome"), quando desempacotado com a característica destructuring assignment disponível no ambiente JS do Mozilla, fornecerá os redutores comuns dos Components.*:

+ +

Cc

+ +

Um redutor para Components.classes.

+ +

Ci

+ +

Um redutor para Components.interfaces.

+ +

Cu

+ +

Um redutor para Components.utils.

+ +

Cr

+ +

Um redutor para Components.results.

+ +

Cm

+ +

Um redutor para Components.manager.

+ +

components

+ +

Uma outra forma de chamar Components por si mesmo (note as letras minúsculas). A partir daí você pode acessar propriedade de uso menos frequente como Components.stack e Components.isSuccessCode.

+ +

Nota: a declaração require("chrome") é o único modo para acessar as funcionalidades do chrome e da API Components. O objeto Components não deve ser acessado de módulos. A ferramenta SDK emitira um aviso se ela vir código em móduo que referencie o Components diretamente.

+ +

Seu módulo deve evitar usar privilégios do chrome a menos que seja absolutamente necessário. Uso da Autoridade do Chrome deve receber revisão extra de segurança, e a maioria dos bugs nestes módulos são críticos a segurança.

+ +

Geração do Manifesto

+ +

O manifesto é uma lista, incluída no XPI gerado, que especifica quais módulos requisitação accesso require() para quais outros módulos. Ele também grava quais módulos requisitam acesso chrome. Esta lista é gerada pelo mapeamento de todos os módulos incluído pela declaração require(XYZ) e grava a string "XYZ" que eles referênciam.

+ +

Quando a implementação do manifesto estiver completa o carregador do programa  vai impedir os módulos de usar require()  para solicitar módulos que não estão listados no manifesto. Também, evitará que os módulos consiga autoridade chrome a menos que o manifesto indique que eles pediram para ele. Isto irá assegurar que os revisores enxerguem as mesmas restrições de autoridade que são aplicadas sobre o código em execução, aumentando efetivamente o tempo gasto revendo o add-on. (até que este trabalho seja concluído, os módulos podem ser capazes de burlar essas restrições).

+ +

O manifesto é construído com um mapeador baseado em expressão regular, não um análisador Javascript. Os desenvolvedores devem manter as declarações require simples, com uma única string estática, uma por linha de código. Se o mapeador falhar para enxergar a entrada require, o manifesto não incluirá aquela entrada, e (uma vez que a implementação esteja completa) o código em execução lança uma exceção.

+ +

Por exemplo, nenhum dos códigos a seguir serão encontrados pelo mapeamento do manifesto, levando a uma exceção em tempo de execução, quando a chamada require() é proibida de importar os módulos chamados:

+ +
// todos estes falharão
+var xhr = require("x"+"hr");
+var modname = "xpcom";
+var xpcom = require(modname);
+var one = require("one"); var two = require("two");
+
+ +

A intenção é que os desenvolvedores usem a declaração require() para dois propósitos: declarar (ao revisores de segurança) qual a classificação dos poderes que os modulos querem usar, e controlar como estes poderes serão mapeados dentro do namespace do módulo local. Suas declarações devem então ser claras e fáceis de analisar. Um formato de manifesto futuro deve mover a porção de declaração para um arquivo separado, para permitir expressões mais granuladas de autorização.

+ +

Comandos que constroem um manifesto, como "jpm xpi" ou "jpm run", mapearão todos os módulos incluídos pelo uso dos atalhos Cc/Ci (ou a forma expandida Components.classes). Emitirá um aviso se ele visualizar a forma expandida ou ver o uso e.g. "Cc" sem a entrada correspondente na declaração require("chrome"). Estes avisos servem para guiar os desenvolvedores para o usar o padrão correto. Todos os desenvolvedores de módulos devem reparar os avisos e corrigir seus códigos até que os avisos tenham desaparecido.

diff --git "a/files/pt-br/mozilla/add-ons/sdk/tutorials/come\303\247ando/index.html" "b/files/pt-br/mozilla/add-ons/sdk/tutorials/come\303\247ando/index.html" new file mode 100644 index 0000000000..1294a58ffd --- /dev/null +++ "b/files/pt-br/mozilla/add-ons/sdk/tutorials/come\303\247ando/index.html" @@ -0,0 +1,206 @@ +--- +title: Começando +slug: Mozilla/Add-ons/SDK/Tutorials/Começando +tags: + - Add-on SDK + - Tutorial +translation_of: Mozilla/Add-ons/SDK/Tutorials/Getting_Started_%28jpm%29 +--- +

Este tutorial percorre a criação de um add-on simples usando o SDK.

+ +

Pré-requisitos

+ +

Para criar add-ons para Firefox usando SDK, você primeiro precisará seguir as instruções para instalar e ativar o SDK. Uma vez que você fez isso, você estará olhando para um prompt de comando.

+ +

Inicializando um add-on vazio

+ +

No prompt de comando, crie um novo diretório. O diretório não precisa estar no diretório principal do SDK: você pode criar ele em qualquer lugar que você quiser. Navegue para ele, digite cfx init, e tecle enter:

+ +
mkdir my-addon
+cd my-addon
+cfx init
+
+ +

Você verá uma saída como esta:

+ +
* lib directory created
+* data directory created
+* test directory created
+* doc directory created
+* README.md written
+* package.json written
+* test/test-main.js written
+* lib/main.js written
+* doc/main.md written
+Your sample add-on is now ready for testing:
+try "cfx test" and then "cfx run". Have fun!"
+
+ +

Implementando o add-on

+ +

Agora você pode escrever o código do add-on, que vai no arquivo "main.js" em diretório "lib". Esse arquivo foi criado para você no passo anterior. Abra ele e adicione o seguinte código:

+ +
var buttons = require('sdk/ui/button/action');
+var tabs = require("sdk/tabs");
+
+var button = buttons.ActionButton({
+  id: "mozilla-link",
+  label: "Visite Mozilla",
+  icon: {
+    "16": "./icon-16.png",
+    "32": "./icon-32.png",
+    "64": "./icon-64.png"
+  },
+  onClick: handleClick
+});
+
+function handleClick(state) {
+  tabs.open("https://www.mozilla.org/");
+}
+
+ +

Salve o arquivo.

+ +

Próximo, salve estes ícones no diretório "data" de seu add-on:

+ + + + + + + + + + + + + + + + +
icon-16.png
icon-32.png
icon-64.png
+ +

Volte ao prompt de comando, digite:

+ +
cfx run
+
+ +

Este é o comando SDK para executar uma nova instância do Firefox com seu add-on instalado. Quando o Firefox inicia, no canto de cima do lado direito do navegador você verá um ícone com o logotipo do Firefox. Clique nele, e uma nova tab abrirá com o site https://www.mozilla.org/ carregado nela.

+ +

Isso é tudo que esse add-on faz. Ele usa dois módulos SDK: o módulo action button, que permite a você adicionar botões ao navegador, e o módulo tabs, que permite a você realizar operações básicas com tabs. Nesse caso, nós criamos uma botão cujo ícone é o íncone do Firefox, e adicionamos um manipulador de clique que carrega a home page da Mozilla na nova tab.

+ +

Tente editar esse arquivo. Por exemplo, nós poderíamos mudar a página que é carregada:

+ +
var buttons = require('sdk/ui/button/action');
+var tabs = require("sdk/tabs");
+
+var button = buttons.ActionButton({
+  id: "mozilla-link",
+  label: "Visit Mozilla",
+  icon: {
+    "16": "./icon-16.png",
+    "32": "./icon-32.png",
+    "64": "./icon-64.png"
+  },
+  onClick: handleClick
+});
+
+function handleClick(state) {
+  tabs.open("https://developer.mozilla.org/");
+}
+ +

No promp de comando, execute novamente cfx run. Desta vez clicando levará você para https://developer.mozilla.org/.

+ +

Empacotando o add-on

+ +

Quando você termina o add-on e está preparado para distribui-lo, você precisa empacotá-lo como um arquivo XPI. Esse é um formato de arquivo instalável para add-ons de Firefox.  Você pode distribuir arquivos XPI ou publicá-los em https://addons.mozilla.org assim outros usuários podem baixar e instalá-los.

+ +

Para construir um XPI, apenas execute o comando cfx xpi do diretório do add-on:

+ +
cfx xpi
+
+ +

Você deve ver uma mensagem como:

+ +
Exporting extension to my-addon.xpi.
+
+ +

Para testar que funcionou, tente instalar o arquivo XPI em sua própria instalação do Firefox. Você pode fazer isso pressionando Ctrl+O (Cmd+O no Mac) de dentro do Firefox, ou selecionando o item "Abrir arquivo" do menu "Arquivo" do Firefox. Isso trará uma caixa de seleção; navegue até o arquivo "my-addon.xpi", abra-o e siga o prompt para instalar o add-on.

+ +

Resumo

+ +

Neste tutorial nós construímos e empacotamos um add-on usando três comandos:

+ + + +

Esses são os três principais comandos que você usará quando desenvolver add-ons no SDK. Há uma abrangente documentação de referência cobrindo todos os comandos que você pode usar e todas as opções que eles possuem.

+ +

O próprio código do add-on usa dois módulos do SDK, action button e tabs. Há documentação de referência para toda a API do SDK, de alto e baixo nível.

+ +

O que vem a seguir?

+ +

Para sentir algumas das coisas que você pode fazer com a API do SDK, tente trabalhar através de alguns dos tutorials.

+ +

Técnicas avançadas

+ +

Sobreescrevendo os módulos embutidos

+ +

Os módulos do SDK que você usa para implementar seu add-on estão embutidas no Firefox. Quando você executa ou empacota um add-on usando cfx run ou cfx xpi, o add-on usará as versões dos módulos na versão do Firefox que hospeda elas.

+ +

Como um desenvolvedor de add-on, isso é normalmente o que você quer. Mas se você está desenvolvendo os módulos SDK por si mesmo, claro, não será. Nesse caso assumimos que você pegou o SDK de seu repositório GitHub e executará o script bin/activate desse diretório raiz de trabalho.

+ +

Então quando você invoca cfx run ou cfx xpi, você passa a opçao "-o":

+ +
cfx run -o
+
+ +

Isso instrui o cfx a usar a cópia local dos módulos do SDK, não aqueles existentes no Firefox.

+ +

Desenvolvendo sem cfx run

+ +

Porque cfx run reinicia o navegador cada vez que você invoca ele, ele pode ser um pouco pesado se você está fazendo mudanças frequentes em um add-on. Um modelo de desenvolvimento alternativo é usar o add-on Extension Auto-Installer: este escuta para novos arquivos XPI em uma porta específica e instala-os automaticamente. Dessa maneira você pode testar novas mudanças sem precisar reiniciar o navegador:

+ + + +

Você poderia até mesmo automatizar esse fluxo com um script simples. Por exemplo:

+ +
while true ; do cfx xpi ; wget --post-file=codesy.xpi http://localhost:8888/ ; sleep 5 ; done
+
+ +

Note que o nível de registro definido para o console é diferente quando você usa esse método, comparado com o nível de registro usado quando um add-on está executando usando cfx run. Isso significa que se você quiser ver a saída de mensagens do console.log(), você terá que ajustar uma configuração. Veja a documentação no nível de registros para mais detalhes sobre isso.

+ +

Um outro exemplo usando grunt e grunt-shell:

+ +
module.exports = function(grunt) {
+  'use strict';
+  require('matchdep').filterDev('grunt-!(cli)').forEach(grunt.loadNpmTasks);
+  grunt.initConfig({
+    shell: {
+      xpi: {
+        command: [
+          'cd pluginpath',
+          'cfx xpi',
+          'wget --post-file=pluginname.xpi http://localhost:8888/ || echo>/dev/null'
+        ].join('&&')
+      }
+    },
+    watch: {
+      xpi: {
+        files: ['pluginpath/**'],
+        tasks: ['shell:xpi']
+      }
+    }
+  });
+
+  grunt.loadNpmTasks('grunt-contrib-watch');
+  grunt.loadNpmTasks('grunt-shell');
+  grunt.registerTask('default', ['watch']);
+};
diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/creating_event_targets/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/creating_event_targets/index.html new file mode 100644 index 0000000000..d8fd6a7318 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/tutorials/creating_event_targets/index.html @@ -0,0 +1,245 @@ +--- +title: Criando Alvos de Eventos +slug: Mozilla/Add-ons/SDK/Tutorials/Creating_event_targets +translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Creating_event_targets +--- +

Este tutorial descreve o uso de APIS de baixo nível. Estas APIs estão ainda em desenvolvimento, e nós esperamos fazer mudanças incompatíveis nela em lançamentos futuros.

+ +

O guia de programação de eventos dirigidos com SDK descreve como consumir eventos: isto é, como escutar eventos gerados pelo alvos de evento. Por exemplo, você pode escutar ao evento evento ready do módulo tab ou o event show do objeto Panel.

+ +

Com o SDK, também é simples implementar seus próprios alvos de eventos. Isto é especialmente útil se você quiser construir seus próprios módulos, ou organizar seu add-on melhor ou permitir a outros desenvolvedores reusar seu código. Se você usa o framework de eventos do SDK para seus alvos de eventos, os usuários de seus módulos podem escutar pelos eventos usando a API de evento padrão do SDK.

+ +

Neste tutorial nów criaremos parte de um módulo para acessar a API Local do navegador. Ele emitirá eventos quando o usuário adicionar e visitar um favorito, permitindo aos usuários escutar estes eventos usando a API de evento padrão do SDK.

+ +

Usando a API Local

+ +

Primeiro, vamos escrever algun código usando a API Local que registra as URIs do favorito que o usuário adicinou.

+ +

Crie uma novo diretório chamado "bookmarks", navegue até ele, e execute jpm init, aceitando todos os padrões. Então abra o "index.js" e adicione o seguinte código:

+ +
var {Cc, Ci, Cu} = require("chrome");
+Cu.import("resource://gre/modules/XPCOMUtils.jsm", this);
+var bookmarkService = Cc["@mozilla.org/browser/nav-bookmarks-service;1"]
+                          .getService(Ci.nsINavBookmarksService);
+
+var bookmarkObserver = {
+  onItemAdded: function(aItemId, aFolder, aIndex) {
+    console.log("added ", bookmarkService.getBookmarkURI(aItemId).spec);
+  },
+  onItemVisited: function(aItemId, aVisitID, time) {
+    console.log("visited ", bookmarkService.getBookmarkURI(aItemId).spec);
+  },
+  QueryInterface: XPCOMUtils.generateQI([Ci.nsINavBookmarkObserver])
+};
+
+exports.main = function() {
+  bookmarkService.addObserver(bookmarkObserver, false);
+};
+
+exports.onUnload = function() {
+  bookmarkService.removeObserver(bookmarkObserver);
+}
+
+ +

Tente executar este add-on, adicionando e visitando favoritos, e observando a saída no console.

+ +

Módulos como Alvos de Evento

+ +

Nós podemos adaptar esse código em módulos separados que expõe a interface de evento padrão do SDK.

+ +

Para fazer isso nós usaremos o módulo event/core.

+ +

Crie um novo arquivo no "lib" chamado "bookmarks.js", e adicione o seguinte código:

+ +
var { emit, on, once, off } = require("sdk/event/core");
+
+var {Cc, Ci, Cu} = require("chrome");
+Cu.import("resource://gre/modules/XPCOMUtils.jsm", this);
+var bookmarkService = Cc["@mozilla.org/browser/nav-bookmarks-service;1"]
+                          .getService(Ci.nsINavBookmarksService);
+
+var bookmarkObserver = {
+  onItemAdded: function(aItemId, aFolder, aIndex) {
+    emit(exports, "added", bookmarkService.getBookmarkURI(aItemId).spec);
+  },
+  onItemVisited: function(aItemId, aVisitID, time) {
+    emit(exports, "visited", bookmarkService.getBookmarkURI(aItemId).spec);
+  },
+  QueryInterface: XPCOMUtils.generateQI([Ci.nsINavBookmarkObserver])
+};
+
+bookmarkService.addObserver(bookmarkObserver, false);
+
+exports.on = on.bind(null, exports);
+exports.once = once.bind(null, exports);
+exports.removeListener = function removeListener(type, listener) {
+  off(exports, type, listener);
+};
+
+ +

Este código implementa um módulo que pode emitir eventos added e visited. Ele duplica o código anterior, mas com um pouco de mudanças:

+ + + +

O on() e once() exporta delegação a uma função correspondente do event/core, e usa bind() para passar o objeto exports por si só como o argumento target(alvo) à função subjacente. A função removeListener() é implementada pela chamada da função subjacente  off().

+ +

Nós podemos usar este módulo do mesmo modo que nós usamos qualquer outro módulo que emite eventos a nível de módulo, tais como tabs. Por exemplo, nós podemos adaptar o "index.js" como segue:

+ +
var bookmarks = require("./bookmarks");
+
+function logAdded(uri) {
+  console.log("added: " + uri);
+}
+
+function logVisited(uri) {
+  console.log("visited: " + uri);
+}
+
+exports.main = function() {
+  bookmarks.on("added", logAdded);
+  bookmarks.on("visited", logVisited);
+};
+
+exports.onUnload = function() {
+  bookmarks.removeListener("added", logAdded);
+  bookmarks.removeListener("visited", logVisited);
+}
+
+ +

Classes como Alvos de Eventos

+ +

Às vezes nós queremos emitir eventos à nível de objetos individuais, em vez de à nível de módulo.

+ +

Para fazer isto, nós podemos herdar da classe EventTarget do SDK. EventTarget fornece uma implementação das funções necessárias a adicionar e remover escutas: on(), once(), e removeListener().

+ +

Neste exemplo, nós poderíamos definir uma classe BookmarkManager que herda do EventTarget e emite eventos added e visited.

+ +

Abra o "bookmarks.js" e substitua seu conteúdo com este código:

+ +
var { emit } = require("sdk/event/core");
+var { EventTarget } = require("sdk/event/target");
+var { Class } = require("sdk/core/heritage");
+var { merge } = require("sdk/util/object");
+
+var {Cc, Ci, Cu} = require("chrome");
+Cu.import("resource://gre/modules/XPCOMUtils.jsm", this);
+var bookmarkService = Cc["@mozilla.org/browser/nav-bookmarks-service;1"]
+                          .getService(Ci.nsINavBookmarksService);
+
+function createObserver(target) {
+   var bookmarkObserver = {
+     onItemAdded: function(aItemId, aFolder, aIndex) {
+       emit(target, "added", bookmarkService.getBookmarkURI(aItemId).spec);
+     },
+     onItemVisited: function(aItemId, aVisitID, time) {
+       emit(target, "visited", bookmarkService.getBookmarkURI(aItemId).spec);
+     },
+     QueryInterface: XPCOMUtils.generateQI([Ci.nsINavBookmarkObserver])
+   };
+   bookmarkService.addObserver(bookmarkObserver, false);
+}
+
+var BookmarkManager = Class({
+  extends: EventTarget,
+  initialize: function initialize(options) {
+    EventTarget.prototype.initialize.call(this, options);
+    merge(this, options);
+    createObserver(this);
+  }
+});
+
+exports.BookmarkManager = BookmarkManager;
+
+ +

O código para interagir com a API Local é o mesmo que aqui. Porém:

+ + + +

Para usar este alvo de evento nós podemos criar ele e chamar a funções on(), once(), e removeListener() que ele herdou:

+ +
var bookmarks = require("./bookmarks");
+var bookmarkManager = bookmarks.BookmarkManager({});
+
+function logAdded(uri) {
+  console.log("added: " + uri);
+}
+
+function logVisited(uri) {
+  console.log("visited: " + uri);
+}
+
+exports.main = function() {
+  bookmarkManager.on("added", logAdded);
+  bookmarkManager.on("visited", logVisited);
+};
+
+exports.onUnload = function() {
+  bookmarkManager.removeListener("added", logAdded);
+  bookmarkManager.removeListener("visited", logVisited);
+}
+
+ +

Implementando uma opção "onEvent"

+ +

Finalmente, a maioria dos alvos de eventos aceitam opções na forma "onEvent", onde "Event" é o nome do evento com a primeira letra em maiúsculo. Por exemplo, você pode escutar o evento show do objeto Panel ou chamando:

+ +
myPanel.on("show", listenerFunction);
+
+ +

ou passando a opção onShow para o construtor do Painel:

+ +
var myPanel = require("sdk/panel").Panel({
+  onShow: listenerFunction,
+  contentURL: "https://en.wikipedia.org/w/index.php"
+});
+
+ +

Se sua classe herda do EventTarget, opções como this são automaticamente manipuladas para você. Por exemplo, dada a implementação do BookmarkManager acima, seu "index.js" seria reescrito como isto:

+ +
var bookmarks = require("./bookmarks");
+
+function logAdded(uri) {
+  console.log("added: " + uri);
+}
+
+function logVisited(uri) {
+  console.log("visited: " + uri);
+}
+
+var bookmarkManager = bookmarks.BookmarkManager({
+  onAdded: logAdded,
+  onVisited: logVisited
+});
+
+exports.onUnload = function() {
+  bookmarkManager.removeListener("added", logAdded);
+  bookmarkManager.removeListener("visited", logVisited);
+}
+
diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/creating_reusable_modules/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/creating_reusable_modules/index.html new file mode 100644 index 0000000000..837583f9c8 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/tutorials/creating_reusable_modules/index.html @@ -0,0 +1,253 @@ +--- +title: Criando Módulos Reutilizáveis +slug: Mozilla/Add-ons/SDK/Tutorials/Creating_reusable_modules +tags: + - Add-on SDK +translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Creating_reusable_modules +--- +
Para seguir este tutorial você precisa do SDK instalado e conhecimento básico de cfx.
+ +

Com o SDK você não precisa manter tudo em um único arquivo "main.js". Você pode separar seu código em módulos separados com interfaces claramente definidas entre eles. Você então importa e usa estes módulos de outras partes de seu add-on usando a declaração require(), da mesma forma que você importa os módulos core do SDK como page-mod or panel.

+ +

Muitas vezes faz sentido estruturar um add-on muito grande ou complexo como uma coleção de módulos. Isso torna o desenho do add-on mais fácil de entender e fornece algum encapsulamento em que cada módulo exportará somente o que ele escolheu, então você pode mudar o módulo internamente sem quebrar seu usuário.

+ +

Uma vez que você fez isso, você pode empacotar os módulos e distribui-los independentemente de seu add-on, tornando-os disponíveis para outros desenvolvedores de add-on e efetivamente extendendo o SDK.

+ +

Neste tutorial faremos exatamente isso com o módulo que calcula hashes de arquivo.

+ +

Um add-on de hashing

+ +

Uma função hash leva uma string de qualquer tamanho de bytes, e produz uma string curta e de tamanho fixo de bytes como saída. É um modo útil para criar um "fingerprint" que pode ser usado para identificar um arquivo. MD5 é uma função hash comumente usada: embora não seja considerada segura, ela trabalha bem desconsiderando o contexto da segurança.

+ +

Aqui nós escreveremos um add-on que deixa o usuário escolher uma arquivo no disco e calcula seu hash. Para ambas operações nós usaremos as interfaces XPCOM.

+ +

File picker

+ +

Para deixar o usuário selecionar um arquivo nós usaremos  o nsIFilePicker. A documentação para esta interface inclui um exemplo que nós podemos adaptar como este:

+ +
var {Cc, Ci} = require("chrome");
+
+function promptForFile() {
+  const nsIFilePicker = Ci.nsIFilePicker;
+
+  var fp = Cc["@mozilla.org/filepicker;1"]
+           .createInstance(nsIFilePicker);
+
+  var window = require("sdk/window/utils").getMostRecentBrowserWindow();
+  fp.init(window, "Select a file", nsIFilePicker.modeOpen);
+  fp.appendFilters(nsIFilePicker.filterAll | nsIFilePicker.filterText);
+
+  var rv = fp.show();
+  if (rv == nsIFilePicker.returnOK || rv == nsIFilePicker.returnReplace) {
+    var file = fp.file;
+    // Pega o caminho como string. Note que você normalmente não
+    // precisará trabalhar com strings de caminho.
+    var path = fp.file.path;
+    // Trabalhe com o retorno de nsILocalFile...
+  }
+  return path;
+}
+ +

Função Hash

+ +

Firefox tem suporte embutido para funções hash, exposto via interface XPCOM nsICryptoHash. A página da documentação para esta interface inclui um exemplo de calculadora de hash MD5 do conteúdo do arquivo, dado seu caminho. Nós adaptamos como esta:

+ +
var {Cc, Ci} = require("chrome");
+
+// retorna o código hexadecimal de dois dígitos para um byte
+function toHexString(charCode) {
+  return ("0" + charCode.toString(16)).slice(-2);
+}
+
+function md5File(path) {
+  var f = Cc["@mozilla.org/file/local;1"]
+          .createInstance(Ci.nsILocalFile);
+  f.initWithPath(path);
+  var istream = Cc["@mozilla.org/network/file-input-stream;1"]
+                .createInstance(Ci.nsIFileInputStream);
+  // abrindo para leitura
+  istream.init(f, 0x01, 0444, 0);
+  var ch = Cc["@mozilla.org/security/hash;1"]
+           .createInstance(Ci.nsICryptoHash);
+  // nós queremos usar o algoritmo MD5
+  ch.init(ch.MD5);
+  // isto diz para updateFromStream ler o arquivo todo
+  const PR_UINT32_MAX = 0xffffffff;
+  ch.updateFromStream(istream, PR_UINT32_MAX);
+  // passe false aqui para conseguir os dados binários de volta
+  var hash = ch.finish(false);
+
+  // converte o hash binário para hex string.
+  var s = Array.from(hash, (c, i) => toHexString(hash.charCodeAt(i))).join("");
+  return s;
+}
+ +

Colocando tudo junto

+ +

O add-on completo adiciona um botão ao Firfox: quando o usuário clica no botão, nós pedimos lhe para selecionar  um arquivo, e registramos o hash no console:

+ +
var {Cc, Ci} = require("chrome");
+
+// retorna o código hexadecimal de dois dígitos para um byte
+function toHexString(charCode) {
+  return ("0" + charCode.toString(16)).slice(-2);
+}
+
+function md5File(path) {
+  var f = Cc["@mozilla.org/file/local;1"]
+          .createInstance(Ci.nsILocalFile);
+  f.initWithPath(path);
+  var istream = Cc["@mozilla.org/network/file-input-stream;1"]
+                .createInstance(Ci.nsIFileInputStream);
+  // abrindo para leitura
+  istream.init(f, 0x01, 0444, 0);
+  var ch = Cc["@mozilla.org/security/hash;1"]
+           .createInstance(Ci.nsICryptoHash);
+  // nós queremos usar o algoritmo MD5
+  ch.init(ch.MD5);
+  // isto diz para updateFromStream ler o arquivo todo
+  const PR_UINT32_MAX = 0xffffffff;
+  ch.updateFromStream(istream, PR_UINT32_MAX);
+  // passe false aqui para conseguir os dados binários de volta
+  var hash = ch.finish(false);
+
+  // converte o hash binário para hex string.
+  var s = Array.from(hash, (c, i) => toHexString(hash.charCodeAt(i))).join("");
+  return s;
+}
+
+function promptForFile() {
+  var window = require("sdk/window/utils").getMostRecentBrowserWindow();
+  const nsIFilePicker = Ci.nsIFilePicker;
+
+  var fp = Cc["@mozilla.org/filepicker;1"]
+           .createInstance(nsIFilePicker);
+  fp.init(window, "Select a file", nsIFilePicker.modeOpen);
+  fp.appendFilters(nsIFilePicker.filterAll | nsIFilePicker.filterText);
+
+  var rv = fp.show();
+  if (rv == nsIFilePicker.returnOK || rv == nsIFilePicker.returnReplace) {
+    var file = fp.file;
+    // Pega o caminho como string. Note que você normalmente não
+    // precisará trabalhar com strings de caminho.
+    var path = fp.file.path;
+    // Trabalhe com o retorno de nsILocalFile...
+  }
+  return path;
+}
+
+require("sdk/ui/button/action").ActionButton({
+  id: "show-panel",
+  label: "Show Panel",
+  icon: {
+    "16": "./icon-16.png"
+  },
+  onClick: function() {
+    console.log(md5File(promptForFile()));
+  }
+});
+
+ +

Isso funciona, mas main.js está agora ficando mais longo e sua lógica mais difícil de entender. This works , but main.js is now getting longer and its logic is harder to understand. Vamos levar os códigos do "file picker" e do "hashing code" para módulos separados.

+ +

Criando módulos separados

+ +

filepicker.js

+ +

Primeiro criamos um novo arquivo no diretório "lib" chamado "filepicker.js". Copiamos o código do seletor de arquivos, e adicionamos a seguinte linha de código no fim dele:

+ +
exports.promptForFile = promptForFile;
+
+ +

Isso define a interface pública do novo módulo.

+ +

Então "filepicker.js" deve parecer com isto:

+ +
var {Cc, Ci} = require("chrome");
+
+function promptForFile() {
+  var window = require("sdk/window/utils").getMostRecentBrowserWindow();
+  const nsIFilePicker = Ci.nsIFilePicker;
+
+  var fp = Cc["@mozilla.org/filepicker;1"]
+           .createInstance(nsIFilePicker);
+  fp.init(window, "Select a file", nsIFilePicker.modeOpen);
+  fp.appendFilters(nsIFilePicker.filterAll | nsIFilePicker.filterText);
+
+  var rv = fp.show();
+  if (rv == nsIFilePicker.returnOK || rv == nsIFilePicker.returnReplace) {
+    var file = fp.file;
+    // Get the path as string. Note that you usually won't
+    // need to work with the string paths.
+    var path = fp.file.path;
+    // work with returned nsILocalFile...
+  }
+  return path;
+}
+
+exports.promptForFile = promptForFile;
+
+ +

md5.js

+ +

Próximo, crie um outro arquivo no "lib", chamado "md5.js". Copie o código do hashing, e adicione esta linha ao seu fim:

+ +
exports.hashFile = md5File;
+ +

O arquivo completo parece com isto:

+ +
var {Cc, Ci} = require("chrome");
+
+//retorna o código hexadecimal de dois dígitos para um byte
+function toHexString(charCode) {
+  return ("0" + charCode.toString(16)).slice(-2);
+}
+
+function md5File(path) {
+  var f = Cc["@mozilla.org/file/local;1"]
+          .createInstance(Ci.nsILocalFile);
+  f.initWithPath(path);
+  var istream = Cc["@mozilla.org/network/file-input-stream;1"]
+                .createInstance(Ci.nsIFileInputStream);
+  // abrindo para leitura
+  istream.init(f, 0x01, 0444, 0);
+  var ch = Cc["@mozilla.org/security/hash;1"]
+           .createInstance(Ci.nsICryptoHash);
+  // nós queremos usar o algoritmo MD5
+  ch.init(ch.MD5);
+  // isto diz para updateFromStream ler o arquivo todo
+  const PR_UINT32_MAX = 0xffffffff;
+  ch.updateFromStream(istream, PR_UINT32_MAX);
+  // passe false aqui para conseguir os dados binários de volta
+  var hash = ch.finish(false);
+
+  // converte o hash binário para hex string.
+  var s = Array.from(hash, (c, i) => toHexString(hash.charCodeAt(i))).join("");
+  return s;
+}
+
+exports.hashFile = md5File;
+ +

main.js

+ +

Finalmente, atualizamos o main.js para importar estes dois módulos e usá-los:

+ +
var filepicker = require("./filepicker.js");
+var md5 = require("./md5.js");
+
+require("sdk/ui/button/action").ActionButton({
+  id: "show-panel",
+  label: "Show Panel",
+  icon: {
+    "16": "./icon-16.png"
+  },
+  onClick: function() {
+    console.log(md5.hashFile(filepicker.promptForFile()));
+  }
+});
+ +

Você pode distribuir estes módulos para outros desenvolvedores, também. Eles podem copia-los em algum lugar do add-on, e inclui-los usando require() do mesmo modo.

+ +

Aprendendo Mais

+ +

Para ver alguns módulos que as pessoas já desenvolveram, veja a página community-developed. Para aprender como usar módulos de terceiros em seu próprio código, veja o tutorial adicionando itens de menu.

diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/getting_started_(jpm)/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/getting_started_(jpm)/index.html new file mode 100644 index 0000000000..9190e825ab --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/tutorials/getting_started_(jpm)/index.html @@ -0,0 +1,155 @@ +--- +title: Começando (jpm) +slug: Mozilla/Add-ons/SDK/Tutorials/Getting_Started_(jpm) +tags: + - Add-on SDK + - JPM +translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Getting_Started_(jpm) +--- +
+

O Add-on SDK inclui uma ferramenta de linha de comando que você usa para inicializar, executar, testar, e empacotar add-ons. A ferramenta de linha de comando atual é chamada de jpm, e é baseada no Node.js. Ela substitui a ferramenta antiga cfx.

+ +

Você pode usar o jpm do Firefox 38 em diante.

+ +

Este artigo descreve como desenvolver usando jpm.

+
+ +

Este tutorial ensina a criação de uma add-on simples usando o SDK.

+ +

Pré-requisitos

+ +

Para criar add-ons para Firefox usando o SDK, você precisará:

+ + + +

Inicializando um add-on vazio

+ +

No promp de comando, crie um novo diretório. Navegue até ele, digite jpm init, e tecle enter:

+ +
mkdir my-addon
+cd my-addon
+jpm init
+
+ +

Você será instado à fornecer algumas informações para seu add-on: isso será usado para criar o arquivo package.json do seu add-on. Por enquanto, apenas pressione enter para aceitar o padrão para cada propriedade. Para mais informação sobre jpm init, veja o jpm command reference.

+ +

Uma vez que você forneceu um valor ou aceitou o padrão para estas propriedades, será apresentado a você o conteúdo completo do "package.json" e instado a aceitá-lo.

+ +

Implementando o add-on

+ +

Agora você pode escrever o código do add-on. A menos que você mudou o valor de entrada ("main" no package.json), ele vai no arquivo "index.js" na raiz de seu add-on. Este arquivo foi criado para você no passo anterior. Abra-o e adicione o seguinte código:

+ +
var buttons = require('sdk/ui/button/action');
+var tabs = require("sdk/tabs");
+
+var button = buttons.ActionButton({
+  id: "mozilla-link",
+  label: "Visit Mozilla",
+  icon: {
+    "16": "./icon-16.png",
+    "32": "./icon-32.png",
+    "64": "./icon-64.png"
+  },
+  onClick: handleClick
+});
+
+function handleClick(state) {
+  tabs.open("http://www.mozilla.org/");
+}
+
+ +
+

Note que os "pontos de entrada" padrões para "index.js" no jpm, signifca que seu arquivo principal é "index.js", e é encontrado diretamente na raiz do seu add-on.

+ +

No cfx, o ponto de entrada padrão para "main.js", e é localizado no diretório "lib" na raiz no add-on.

+
+ +

Salve o arquivo.

+ +

Próximo, crie um diretório chamado "data" na raiz do add-on, e salve estes três ícones no diretório "data":

+ + + + + + + + + + + + + + + + +
icon-16.png
icon-32.png
icon-64.png
+ +

Volte ao promp de comando, digite:

+ +
jpm run
+ +

Este é o comando jpm para executar uma nova instância do Firefox com seu add-on instalado.

+ +

Quando o Firefox lança, no canto superior direito do navegador você verá um ícone com o logotipo do Firefox. Clique no ícone, e uma nova tab abrirá com o site http://www.mozilla.org/ carregado.

+ +

Isso é tudo que este add-on faz. Ele usa dois módulos SDK: o módulo action button, que lhe permite adicionar botões ao navegador, e o módulo tab, que lhe permite executar operações básicas com o módulo tabs. Neste caso, nós criamos um botão cujo ícone é o ícone do Firefox, e adicionamos um manipulado de click que carrega a página do Mozilla na nova tab.

+ +

Tente editar este arquivo. Por exemplo, nós poderíamos mudar a página que está sendo carregada:

+ +
var buttons = require('sdk/ui/button/action');
+var tabs = require("sdk/tabs");
+
+var button = buttons.ActionButton({
+  id: "mozilla-link",
+  label: "Visit Mozilla",
+  icon: {
+    "16": "./icon-16.png",
+    "32": "./icon-32.png",
+    "64": "./icon-64.png"
+  },
+  onClick: handleClick
+});
+
+function handleClick(state) {
+  tabs.open("https://developer.mozilla.org/");
+}
+ +

No promp de comando, execute jpm run novamente. Desta vez clicando lhe levará para https://developer.mozilla.org/.

+ +

Empacotando o add-on

+ +

Quando você terminou o add-on e estiver preparado para distribui-lo, você precisará empacotá-lo como um arquivo XPI. Esta é a forma instalável dos add-ons do Firefox. Você pode distribuir os arquivos XPI por si mesmo ou publicá-los em https://addons.mozilla.org então outros usuários podem baixar eles.

+ +

Para construir um XPI, apenas execute o comando jpm xpi do diretório do add-on:

+ +
jpm xpi
+
+ +

Você deveria ver uma mensagem como:

+ +
JPM info Successfully created xpi at /path/to/getting-started/@getting-started.xpi
+
+ +

Para testar que isso funciona, tente instalar o arquivo XPI em sua própria instalação do Firefox. Você pode fazer isso pressionando a combinação de teclas Ctrl+O (Cmd+O no Mac) de dentro do Firefox, ou selecionando o menu "Open" do menu "Arquivo" do Firefox. Isso trará uma caixa de diálogo de seleção de arquivo: navegue para o arquivo "@getting-started.xpi", abra-o e siga o prompt para instalar o add-on.

+ +

Resumo

+ +

Neste tutorial nós construímos e empacotamos um add-on usando três comandos:

+ + + +

Há três comandos principais que você usará quando desenvolvendo add-ons com SDK. Há documentação abrangente no reference documentation cobrindo todos os comandos  que você pode usar e todas as opções que eles levam.

+ +

O código do add-on por si usa dois módulos SDK, action button e tabs. Há documentação de referência para todas as APIS do SDK tanto as de alto nível quanto as de baixo nível.

+ +

O que vem agora?

+ +

Para ter uma ideia das coisas que você pode fazer com as APIs do SDK, tente trabalhar com alguns dos tutoriais.

diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/index.html new file mode 100644 index 0000000000..6d5484bc46 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/tutorials/index.html @@ -0,0 +1,144 @@ +--- +title: Tutoriais +slug: Mozilla/Add-ons/SDK/Tutorials +tags: + - Add-on SDK +translation_of: Archive/Add-ons/Add-on_SDK/Tutorials +--- +

Esta página lista artigos úteis e práticos sobre como executar tarefas específicas usando o SDK.

+ +
+

Começando

+ +
+
+
+
Instalação
+
Download, instalar, e inicializar o SDK no Windows, OS X e Linux.
+
+ +
+
Solução de problemas
+
Algumas dicas para resolver problemas comuns e conseguir mais ajuda.
+
+
+ +
+
+
Começando
+
Criação passo-a-passo de um add-on simples com o SDK.
+
+
+
+ +
+

Criando interfaces de usuário

+ +
+
+
+
Adicionando um botão de barra de ferramenta
+
Anexe um botão à barra de ferramentas de add-on do Firefox.
+
Adicione um item de menu ao Firefox
+
Adicione itens ao menu principal do Firefox.
+
+
+ +
+
+
Mostre um popup
+
Mostre um diálogo popup implementado com HTML e JavaScript.
+
Adicione um item ao menu de contexto
+
Adicione itens ao menu de contexto do Firefox.
+
+
+
+ +
+

Interagindo com o navegador

+ +
+
+
+
Abra uma página
+
Abra uma página web em um novo navegador ou janela usando o módulo tabs, e acesse seu conteúdo.
+
Observando páginas carregadas
+
Use o módulo tabs para conseguir notificação quando novas páginas são carregadas, e acesse seu conteúdo.
+
+
+ +
+
+
Capturando a lista de tabs abertas
+
Use o módulo tab para interagir pelas tabs atualmente abertas, e acesse seu conteúdo.
+
+
+
+ +
+

Modificando páginas web

+ +
+
+
+
Modificar páginas web baseado na URL
+
Crie um filtro para páginas web baseado em sua URL: sempre que uma página web cuja URL combinar com o filtro carregado, executa um script espeficado nela.
+
+
+ +
+
+
Modificar a página web ativa
+
Carrega dinamicamente um script dentro da página web ativa atualmente.
+
+
+
+ +
+

Técnicas de desenvolvimento

+ +
+
+
+
Restro de log
+
Registra mensagens para o console para propósito de diagnóstico.
+
Criando módulos reutilizáveis
+
Estruture seu add-on em módulos separados deixando mais fácil o desenvolvimento, depuração e manutenção. Crie pacotes reutilizáveis contendo seus módulos, assim outros desenvolvedores de add-on podem usá-los também.
+
Teste de unidade
+
Escrevendo e executando teste de unidade usando framework de teste do SDK.
+
Chrome authority
+
Conseguindo acesso ao objeto Components, permitindo a seu add-on carregar e usar qualquer objeto XPCOM.
+
Criando event targets
+
Permite aos objeto que você define emitir seus próprios eventos.
+
+
+ +
+
+
Observando load e unload
+
Receba notificações quando seu add-on é caregado ou descarregado pelo Firefox, e passa argumentos do seu add-on a partir da linha de comando.
+
Usando módulos de terceiros
+
Instale e use módulos adicionais que não são fornecidos com o SDK.
+
Localização
+
Escrever código localizável.
+
Desenvolvimento mobile
+
Develop add-ons for Firefox Mobile on Android.
+
Depuração do Add-on
+
Depure o JavaScript do seu add-on.
+
+
+
+ +
+

Colocando tudo junto

+ +
+
+
+
Add-on Annotator
+
Um guia para um add-on relativamente complexo.
+
+
+
+ +

 

diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/l10n/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/l10n/index.html new file mode 100644 index 0000000000..4a762bda9b --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/tutorials/l10n/index.html @@ -0,0 +1,380 @@ +--- +title: Localização +slug: Mozilla/Add-ons/SDK/Tutorials/l10n +tags: + - Add-on SDK + - Localização +translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/l10n +--- +

O SDK suporta localização de strings que aparecem no:

+ + + +

Ele, ainda, não suporta localização de conteúdo CSS ou Scripts.

+ +

Strings de Localização

+ +

Strings traduzidas são mantidas em um diretório chamado "locale" no diretório principal do seu add-on, um arquivo para cada locale. Os arquivos:

+ + + +

Suponha que seu add-on contém uma única string localizável, representada em Inglês como "Hello!", e você quer suprir com localizações US English e Francês.

+ +

Você adiciona dois arquivos ao diretório "locale":

+ +
my-addon/
+         data
+         lib
+         locale/
+                en-US.properties
+                fr-FR.properties
+
+ +

"en-US.properties" contém isto:

+ +
hello_id= Hello!
+
+ +

"fr-FR.properties" contém isto:

+ +
hello_id= Bonjour !
+
+ +

Agora que sempre que em seu código JavaScript ou HTML pedir  ao sistema de localização pela tradução do identificador hello_id, ele pegará a tradução correta para a localidade atual.

+ +

Usando Strings de Localização no HTML

+ +
+

Este exemplo usa a API action button, que está disponível somente do Firefox 29 em diante.

+
+ +

Para referenciar uma string localizada do HTML, adicione um atributo data-l10n-id à tag HTML onde você quiser que a string localizada apareça, e atribua o identificador a ele:

+ +
<html>
+  <body>
+    <h1 data-l10n-id="hello_id"></h1>
+  </body>
+</html>
+
+ +

Então você pode usar o arquivo HTML para construir sua interface, por exemplo dentro de um painel:

+ +
var button = require("sdk/ui/button/action").ActionButton({
+  id: "localized-hello",
+  label: "Localized hello",
+  icon: "./icon-16.png",
+  onClick: function() {
+    hello.show();
+  }
+});
+
+var hello = require("sdk/panel").Panel({
+  height: 75,
+  width: 150,
+  contentURL: require("sdk/self").data.url("my-panel.html")
+});
+ +

Dados os arquivos locale para "en-US" e "fr-FR" que fornece uma tradução para o hello_id, o painel agora mostrará o "Hello!" ou "Bonjour !", de acordo com a localidade atual:

+ +

+ +

A tradução é inserida dentro do nó que tem o atributo data-l10n-id. Qualquer conteúdo anteriormente existente é substituído.

+ +

A string é inserida como texto, então você não pode inserir HTML usando declarações como:

+ +
hello_id= <blink>Hello!</blink>
+
+ +

Localizando Atributos de Elementos

+ +
Esta característica é nova no Firefox 39
+ +


+ Você pode localizar certos atributos de elementos com um l10n-id configurando seu valor com o l10-id.attributeName no arquivo da propriedade como isto:

+ +
hello_id.accesskey= H
+ +

Os seguintes atributos são suportados:

+ + + +

Além disso, a localização dos atributos ARIA aria-label, aria-valuetext e aria-moz-dica são suportados com os mesmos apelidos que no Firefox OS:

+ + + +

Usando Strings de Localização no JavaScript

+ +

Para referenciar Strings de Localização do código principal do seu add-on, você faz isso:

+ +
var _ = require("sdk/l10n").get;
+console.log(_("hello_id!"));
+ +

A atribuição de "_" em particular não é requerida, mas é uma convenção da ferramente gettext e torna possível trabalhar com ferramentas existentes que esperam "_" para indicar Strings de Localização.

+ +
    +
  1. Importe o módulo l10n, atribua sua função get o "_" (underscore).
    2. +
  2. Envolva todas as referências a Strings de Localização com uma função _().
    3. +
+ +

Se você executar ela você verá a saída esperada para a localidade atual:

+ +
info: Hello!
+
+ +
info: Bonjour !
+
+ +

Observe que você não pode require() módulos nos scripts de conteúdo, você ainda não pode referenciar strings de localização nos scripts de conteúdo.

+ +

Plurais

+ +

O módulo l10n suporta formas plurais. Diferentes línguas tem diferentes regras para formação de plurais. Por exemplo, Inglês tem duas formas: uma forma singular para "one", e uma forma plural para "everything else, including zero":

+ +
one tomato
+no tomatoes
+two tomatoes
+
+ +

Mas a Russa tem diferentes formas para números terminados em 1 (exceto 11), números terminados em 2-4 (exceto 12-14) e outros números:

+ +
один помидор     // one tomato
+два помидора     // two tomatoes
+пять помидоров   // five tomatoes
+
+ +

O SDK usa dados do Unicode CLDR para descrever as diferentes formas de plural usadas pelas diferentes línguas.

+ +

Formas Plurais do Unicode CLDR

+ +

O projeto Unicode CLDR define um esquema que descreve a regras de plural de uma língua em particular. Neste esquema uma  língua mapeia cada abrangência distinta de números para um ou mais formas, identificado pelas categorias: zero, one, two, few, many, e other.

+ +

Inglês tem duas formas, que podem ser descritas pelo mapeamento "1" para "one" e "everything else" para "other":

+ +
one   → n is 1;
+other → everything else
+
+ +

A Russa usa quatro formas, que podem ser descritas como se segue:

+ +
one   → n mod 10 is 1 and n mod 100 is not 11;
+few   → n mod 10 in 2..4 and n mod 100 not in 12..14;
+many  → n mod 10 is 0 or n mod 10 in 5..9 or n mod 100 in 11..14;
+other → everything else
+
+ +

As regras de plural para todas as línguas podem ser encontrada na página de Regras para Plural das Línguas do CLDR (embora esta tabela esteja desatualizada se comparada com a CLDR XML source).

+ +

Formas Plurais no SDK

+ +

No código, você fornece uma parâmetro extra ao lado do identificador, descrevendo quantos itens há:

+ +
var _ = require("sdk/l10n").get;
+console.log(_("tomato_id"));
+console.log(_("tomato_id", 1));
+console.log(_("tomato_id", 2));
+console.log(_("tomato_id", 5));
+console.log(_("tomato_id", .5));
+ +

No arquivo .properties para cada língua você pode definir uma localização diferente para cada forma de plural possível naquela língua, usando palavras reservadas do CLDR. Então no Inglês nós teríamos duas localizações de plural (observe que a categoria "other" não leva palavra reservada do CLDR:

+ +
# en-US translations
+tomato_id[one]= %d tomato
+tomato_id= %d tomatoes
+
+ +

Na Russa nós teríamos quatro localizações de plural:

+ +
# ru-RU translations
+tomato_id[one]= %d помидор
+tomato_id[few]= %d помидора
+tomato_id[many]= %d помидоров
+tomato_id= %d помидоры
+
+ +

O módulo de localização por si só entende as definições CLDR para cada língua, permitindo a ele mapear, por exemplo, "2" no código e "few" no arquivo ru-RU.properties. Então ele pega e retorna a localização apropriada para a contagem fornecida.

+ +

Placeholders

+ +

O módulo l10n suporta placeholders, permitindo a você inserir uma string que não deveria ser localizada em uma que é. Os seguintes arquivos "en-US" e "fr-FR" ".properties" estão incluídos placeholders:

+ +
# en-US translations
+hello_id= Hello %s!
+
+ +
# fr-FR translations
+hello_id= Bonjour %s !
+
+ +

Para usar placeholders, forneça uma string placeholder depois do identificador:

+ +
var _ = require("sdk/l10n").get;
+console.log(_("hello_id", "Bob"));
+console.log(_("hello_id", "Alice"));
+ +

Na localidade Inglês "en-US", isto nos é dado:

+ +
info: Hello Bob!
+info: Hello Alice!
+
+ +

No "fr-FR" nós conseguimos:

+ +
info: Bonjour Bob !
+info: Bonjour Alice !
+
+ +

Ordenando Placeholders

+ +

Quando strings localizáveis podem levar dois ou mais placeholders, tradutores podem definir a ordem em que placeholders são inseridos, sem afetar o código.

+ +

Primeiramente, isto é importante porque diferentes línguas tem regras diferentes para ordernar palavras. Mesmo dentro de uma mesma língua, embora traduzida, tradutores deve ter liberdade para definir a ordem.

+ +

Por exemplo, suponha que nós queremos incluir uma string de localização designando a cidade de uma pessoa. Há dois placeholders: o nome da pessoa e o nome da cidade em que ela reside:

+ +
var _ = require("sdk/l10n").get;
+console.log(_("home_town_id", "Bob", "London"));
+ +

An English translator might want to choose between the following:

+ +
"<town_name> is <person_name>'s home town."
+
+ +
"<person_name>'s home town is <town_name>"
+
+ +

Para escolher a primeira opção, o arquivo .properties pode ordenar o placeholders como:

+ +
home_town_id= %2s is %1s's home town.
+
+ +

Isso nos dá a seguinte saída:

+ +
info: London is Bob's home town.
+
+ +

Usando Strings de localização em Preferências

+ +

Pela inclusão de uma estrutura "preferences" no arquivo "package.json" do seu add-on, você pode definir preferências para seu add-on que o usuário pode ver e editar usando o gerenciador de add-ons do Firefox.

+ +

Preferências tem um campo title obrigatório e um campo description opcional. Há strings que aparecem ao lado da preferência no gerenciador de Add-on, para ajudar a explicar ao usuário o que a preferência significa.

+ + + +

Por exemplo, suponha que seu "package.json" defina uma única preferência:

+ +
{
+    "preferences": [
+        {
+            "type": "string",
+            "name": "monster_name",
+            "value": "Gerald",
+            "title": "Name"
+        }
+    ],
+    "name": "monster-builder",
+    "license": "MPL 2.0",
+    "author": "me",
+    "version": "0.1",
+    "fullName": "Monster Builder",
+    "id": "monster-builder@me.org",
+    "description": "Build your own monster"
+}
+
+ +

Em seu arquivo "en-US.properties", inclua estes dois itens:

+ +
monster_name_title= Name
+monster_name_description= What is the monster's name?
+
+ +

Em seu arquivo "fr-FR.properties", inclui a tradução francesa:

+ +
monster_name_title= Nom
+monster_name_description= Quel est le nom du monstre ?
+
+ +

Agora quando o local do navegador estiver configurado para "en-US", os usuários verão este Gerenciador de Add-on:

+ +

+ +

Quando o local do navegador estiver configurado para "fr-FR", eles verão isto:

+ +

+ +

Os tipos de preferência de menulist e radio tem opções. O atributo label de cada opção é mostrado para o usuário. Se o arquivo de local tem uma entrada com o valor do atributo label prefixado com "{name}_options." como sua chave, onde {name} é o nome da preferência, seu valor é usado como rótulo por localização.

+ +

Usando identificadores

+ +

Se o sistema de localização não pode encontrar uma entrada para um identificador em particular usando a localidade atual, então ele apenas retorna o identificador por si mesmo.

+ +

Isto tem a bonita propriedade que você pode escrever add-on localizável, inteiramente funcional sem ter que escrever qualquer arquivo local. Você pode usar somente a linguagem padrão como seu identificador, e subsequentemente fornecer arquivos .properties para todos os locais adicionais que você quiser suportar.

+ +

Por exemplo, no caso acima você poderia usar "Hello!" como o identificador, e apenas ter um arquivo .properties para a localidade "fr-FR":

+ +
Hello!= Bonjour !
+
+ +

Então quando a localidade é "en-US", o sistema falharia ao encontrar o arquivo  .properties file, e retornaria "Hello!".

+ +

Porém, essa técnica torna difícil manter um add-on que tem muitas localizações, porque você estará usando a língua padrão tanto para strings de interface quanto chaves de tradução. Isto significa que se você quiser mudar o nome de uma string na língua padrão, ou consertar a digitação, então você quebrará todos os seus arquivos de tradução.

+ +

Locale Updater

+ +

O addon locale updater torna fácil atualizar arquivos de localidade. Uma vez que você o instalou, abra o Gerenciador de Add-on, e você verá um novo botão rotulado "Update l10n" próximo a cada add-on que você instalou:

+ +

+ +

Clique no botão e você será instado a enviar um arquivo .properties para aquele add-on. Se você fornecer um novo arquivo, o locale do add-on será atualizado com o novo arquivo.

+ +

Limitações

+ +

A localização atual suportada é o primeiro passo  ao inteiro suporte, e contem uma série de limitações.

+ + + +

Veja também - para desenvolvedores que localização em add-on que não são do SDK

+ + diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/lista_de_tabs_abertas/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/lista_de_tabs_abertas/index.html new file mode 100644 index 0000000000..d3d537037d --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/tutorials/lista_de_tabs_abertas/index.html @@ -0,0 +1,67 @@ +--- +title: Lista de Tabs Abertas +slug: Mozilla/Add-ons/SDK/Tutorials/Lista_de_Tabs_Abertas +tags: + - Add-on SDK + - Listando tabs abertas +translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/List_Open_Tabs +--- +
+

Para seguir este tutorial você precisará ter instalado o SDK e ter conhecimento básico sobre cfx.

+ +

Este tutorial usa a API action button, que está disponível somente do Firefox 29 em diante.

+
+ +

Para listar as tabs abertas, você pode iterar sobre o objeto tabs.

+ +

O add-on a seguir adiciona um action button que registra as URLs abertas nas tabs quando clicado:

+ +
require("sdk/ui/button/action").ActionButton({
+  id: "list-tabs",
+  label: "List Tabs",
+  icon: "./icon-16.png",
+  onClick: listTabs
+});
+
+function listTabs() {
+  var tabs = require("sdk/tabs");
+  for (let tab of tabs)
+    console.log(tab.url);
+}
+
+ +

Note que para fazer isso funcionar você precisa salvar um ícone para o botão no diretório "data" do seu add-on como "icon-15.png": você pode baixar o ícone daqui: .

+ +

Se você executar o add-on, carregar um grupo de tabs, e clicar no botão, você verá a saída no linha de comando do console que parece com isto:

+ +
info: http://www.mozilla.org/en-US/about/
+info: http://www.bbc.co.uk/
+
+ +

Você não consegue acesso direto a qualquer conteúdo hospedado na tab. Para acessar o conteúdo da tab você precisa anexar um script à tab usando tab.attach(). Este add-on anexa um script a todas as tabs abertas. O script adiciona uma borda vermelha ao documento da tab:

+ +
require("sdk/ui/button/action").ActionButton({
+  id: "list-tabs",
+  label: "List Tabs",
+  icon: "./icon-16.png",
+  onClick: listTabs
+});
+
+function listTabs() {
+  var tabs = require("sdk/tabs");
+  for (let tab of tabs)
+    runScript(tab);
+}
+
+function runScript(tab) {
+  tab.attach({
+    contentScript: "document.body.style.border = '5px solid red';"
+  });
+}
+
+ +

Aprendendo Mais

+ +

Para aprender mais sobre como trabalhar com tabs no SDK, veja a referência da API tabs.

+ +

Para aprender mais sobre execução de scripts em tabs, veja o tutorial sobre uso do tab.attach().

diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/listening_for_load_and_unload/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/listening_for_load_and_unload/index.html new file mode 100644 index 0000000000..5e3818036f --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/tutorials/listening_for_load_and_unload/index.html @@ -0,0 +1,60 @@ +--- +title: Capturando Load e Unload +slug: Mozilla/Add-ons/SDK/Tutorials/Listening_for_load_and_unload +translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Listening_for_load_and_unload +--- +
+

Para seguir este tutorial você precisará ter conhecimento básico de jpm.

+
+ +

Se seu add-on exporta uma função chamada main(), então aquela função será chamada sempre que o add-on for carregado, e será passada uma string descrevendo a razão de ele ter sido carregado bem como qualquer argumento passado para ele. Se seu add-on exporta uma função chamada onUnload(), então esta função será chamada quando o add-on for descarregado, e será passada uma string descrevendo a razão da descarga.

+ +

Você não tem que usar exports.main() ou exports.onUnload(). Você pode colocar o código do seu add-on no nível superior ao invés de envolver ele em uma atribuição de função para exports.main(). Ele será carregado nas mesmas circunstâncias, mas você não conseguirá acesso às razões da carga ou descarga dele bem como de seus argumentos.

+ +

exports.main()

+ +

O código main.js do seu add-on é executado assim que ele é carregado. Ele é carregado quando ele é instalado, habilitado ou quando inicia o Firefox.

+ +

Se seu add-on exporta uma função chamada main(), aquela função será chamada imediatamente depois que o main.js esteja completamente avaliado, e depois de todas as declarações require() de nível superior serem executadas (então geralmente depois de todas módulos dependentes serem carregados).

+ +
+
+
exports.main = function (options, callbacks) {};
+
+
+ +

options é um objeto descrevendo os parâmetros com os quais seu add-on foi carregado

+ +

options.loadReason

+ +

options.loadReason é uma das seguintes strings descrevendo a razão de seu add-on ter sido carregado:

+ +
install
+enable
+startup
+upgrade
+downgrade
+
+ +

exports.onUnload()

+ +

Se seu add-on exporta uma função chamada onUnload(), aquela função será chamando quando o add-on for descarregado.

+ +
+
+
exports.onUnload = function (reason) {};
+
+
+ +

reason

+ +

reason é uma das seguintes strings descrevendo a razão do add-on ter sido descarregado:

+ +
uninstall
+disable
+shutdown
+upgrade
+downgrade
+
+ +

Devido ao bug 627432, sua captura de descarga (onUnload) nunca será chamada com uninstall: ela somente é chamada com disable. Veja no comentário particular sobre este bug.

diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/logging/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/logging/index.html new file mode 100644 index 0000000000..088d694408 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/tutorials/logging/index.html @@ -0,0 +1,55 @@ +--- +title: Logging +slug: Mozilla/Add-ons/SDK/Tutorials/Logging +tags: + - Add-on SDK + - console +translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Logging +--- +
Para seguir este tutorial você precisa do SDK instalado e conhecimento básico de cfx.
+ +

O objeto DOM console é útil para depuração do JavaScript. Porque os objetos DOM não estão disponíveis para o código principal do add-on, o SDK fornece seu próprio objeto global console com a maiorira dos mesmos métodos do do console DOM, incluindo métodos para registrar erros, avisos, ou mensagens informativas. Você não tem que usar require() qualquer coisa para conseguir acesso ao console. Ele está disponível para você.

+ +

O método console.log() imprime mensagens informativas:

+ +
console.log("Hello World");
+
+ +

Tente:

+ + + +

O Firefox iniciará, e a linha a seguir aparecerá na janela de comando que você usou para executar cfx run:

+ +
info: Hello World!
+
+ +

console em Scripts de Conteúdo

+ +

Você pode usar console em scripts de conteúdo assim como no código principal do seu add-on. O add-on a seguir registra o conteúdo do HTML de toda a tab que o usuário carregar, chamando console.log() dentro do script de conteúdo:

+ +
require("sdk/tabs").on("ready", function(tab) {
+  tab.attach({
+    contentScript: "console.log(document.body.innerHTML);"
+  });
+});
+
+ +

Saída do console

+ +

Se você estiver executando seu add-on da linha de comando (por exemplo, executando cfx run ou cfx test) então as mensagens do console aparece no shell de comando usado.

+ +

Se você instalou o add-on no Firefox então as mensagens aparecerão no Console do Navegador do Firefox.

+ +

Mas note que por padrão, chamadas à console.log() não resultarão em qualquer saída no Console de Erro por qualquer add-on instalado: isso inclui add-ons instalados usando o Add-on Builder ou usando ferramentas como Extension Auto-installer.

+ +

Veja "Logging Levels" na documentação de referência para mais informações.

+ +

Aprendendo Mais

+ +

Para a API completa do console, veja sua referência da API.

diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/modifying_the_page_hosted_by_a_tab/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/modifying_the_page_hosted_by_a_tab/index.html new file mode 100644 index 0000000000..6b8f02c265 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/tutorials/modifying_the_page_hosted_by_a_tab/index.html @@ -0,0 +1,137 @@ +--- +title: Modificando a Página Aberta em uma Tab +slug: Mozilla/Add-ons/SDK/Tutorials/Modifying_the_Page_Hosted_by_a_Tab +tags: + - Add-on SDK +translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Modifying_the_Page_Hosted_by_a_Tab +--- +
+

Para seguir este tutorial, você precisará ter instalado add-on SDK e ter conhecimento básico jpm (Firefox 38 em diante) ou básico do cfx .

+ +

Este tutorial usa a API action button, que está disponível a partir do Firefox 29 em diante.

+
+ +

Para modificar uma página armazenada em uma tab em particular, carregue um ou mais scripts de conteúdo dentro dela usando o método attach() do objeto tab. A tarefa desses scripts é interagir com o conteúdo web.

+ +

Aqui está um exemplo simples:

+ +
var button = require("sdk/ui/button/action").ActionButton({
+  id: "style-tab",
+  label: "Style Tab",
+  icon: "./icon-16.png",
+  onClick: function() {
+    require("sdk/tabs").activeTab.attach({
+      contentScript: 'document.body.style.border = "5px solid red";'
+    });
+  }
+});
+ +

Execute esse exemplo, salve o ícone chamado "icon-16.png" no diretório "data" do add-on. Você To run this example, save an icon file named "icon-16.png" in add-on's "data" directory. Você pode baixar este ícone: .

+ +

This add-on creates a button with Mozilla favicon as an icon. It has a click handler which fetches the active tab and loads a script into the page hosted by the active tab. The script is specified using the contentScript option, and just draws a red border around the page.

+ +

Then open any web page in the browser window, and click the button . You should see a red border appear around the page, like this:

+ +

+ +

Mantendo o script de conteúdo em arquivo separado

+ +

No exemplo acima, nós passamos o script de conteúdo como uma string.

+ +

A menos que o script seja extremamente simples, o melhor é manter o script em um arquivo separado no diretório data do add-on. Isso deixa o código mais fácil para manter, depurar, e revisar. Faça isto, forneça a opção contentScriptFile não contentScript, cujo valor é uma URL apontando para um ou mais arquivos de script de conteúdo.

+ +

Por exemplo, se nós salvarmos o script acima no diretório data do add-on em um arquivo chamado my-script.js:

+ +
var self = require("sdk/self");
+
+var button = require("sdk/ui/button/action").ActionButton({
+  id: "style-tab",
+  label: "Style Tab",
+  icon: "./icon-16.png",
+  onClick: function() {
+    require("sdk/tabs").activeTab.attach({
+      contentScriptFile: self.data.url("my-script.js")
+    });
+  }
+});
+
+ +

Você pode carregar mais de um script, e os scripts podem interagir diretamente um com o outro. Então você pode carregar o jQuery, e então seu script de conteúdo pode usá-lo.

+ +

Carregue vários arquivos de script de conteúdo

+ +

O dado atribuído ao contentScriptFile pode ser um array. Os scripts serão carregados na mesma ordem em que estiverem no array.

+ +

No exemplo a seguir, nós carregaremos dois scripts, first.js & second.js. Ambos serão executados no mesmo contexto, então tudo publicamente definido no first.js será acessível do second.js.

+ +
// lib/main.js
+
+var self = require("sdk/self");
+var tabs = require("sdk/tabs");
+
+require("sdk/ui/button/action").ActionButton({
+  id: "load-several",
+  label: "load several scripts",
+  icon: "./icon-16.png",
+  onClick: function () {
+    tabs.activeTab.attach({
+      contentScriptFile: [self.data.url('first.js'),
+                          self.data.url('second.js')]
+    });
+  }
+});
+
+ +

Comunicando com o script de conteúdo

+ +

O script do seu add-on e os scripts de conteúdo não podem acessar diretamente as variáveis ou funções um do outro, mas eles podem trocar mensagens.

+ +

Para enviar mensagens de um lado para o outro, são usados o emitente de chamadas port.emit() e o recebendor port.on().

+ + + +

Vamos reescrever o exemplo acima para passar mensagens de um add-on para o script de conteúdo.

+ +

O script de conteúdo agora precisa parecer com isto:

+ +
// "self" é um objeto global no script de conteúdo
+// Espera por um "drawBorder"
+self.port.on("drawBorder", function(color) {
+  document.body.style.border = "5px solid " + color;
+});
+
+ +

No script do add-on, nós enviaremos ao script de conteúdo uma mensagem "drawBorder" usando o objeto retornado de attach():

+ +
var self = require("sdk/self");
+var tabs = require("sdk/tabs");
+
+var button = require("sdk/ui/button/action").ActionButton({
+  id: "style-tab",
+  label: "Style Tab",
+  icon: "./icon-16.png",
+  onClick: function() {
+    var worker = tabs.activeTab.attach({
+      contentScriptFile: self.data.url("my-script.js")
+    });
+    worker.port.emit("drawBorder", "red");
+  }
+});
+
+ +

A mensagem drawBorder não é uma mensagem embutida, é uma que este add-on definiu na chamada de port.emit().

+ +

Injetando CSS

+ +

Diferente da API page-mod, tab.attach() não permite a você injetar CSS diretamente na página.

+ +

Para modificar o estilo de uma página, você tem que usar JavaScript, como no exemplo acima.

+ +

Aprendendo Mais

+ +

Para aprender mais sobre como trabalhar com tabs no SDK, veja o tutorial Abrindo uma Página da Web, O tutorial Lista de Tabs Abertas, e a referência da API tabs.

+ +

Para aprender mais sobre scripts de conteúdo, veja o guia de scripts de conteúdo.

diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/modifying_web_pages_based_on_url/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/modifying_web_pages_based_on_url/index.html new file mode 100644 index 0000000000..4e846d75c7 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/tutorials/modifying_web_pages_based_on_url/index.html @@ -0,0 +1,228 @@ +--- +title: Modificando Página Web Baseado na URL +slug: Mozilla/Add-ons/SDK/Tutorials/Modifying_Web_Pages_Based_on_URL +tags: + - Add-on SDK + - content scripts +translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Modifying_Web_Pages_Based_on_URL +--- +
Para seguir este tutorial, você precisará instalar o SDK e ter conhecimento básico de jpm (Firefox 38 em diante) ou básico de cfx.
+ +

Para modificar qualquer página que combine com um padrão particular (por exemplo, "http://example.org/") a medida que elas são carregadas, use o módulo page-mod.

+ +

Para criar um page-mod, você precisa de duas coisas:

+ + + +

Um trecho simples de códingo onde o script de conteúdo é fornecido com a opção contentScript e o padrão de busca da URL é dado pela opção include como a seguir:

+ +
// Importe a API page-mod
+var pageMod = require("sdk/page-mod");
+
+// Crie um page-mod
+// Ele executará um script toda vez que uma URL ".org" é carregada
+// O script substitui o conteúdo da página por uma mensagem
+pageMod.PageMod({
+  include: "*.org",
+  contentScript: 'document.body.innerHTML = ' +
+                 ' "<h1>Page matches ruleset</h1>";'
+});
+
+ +

Faça o seguinte:

+ + + +

Abaixo é o que você deve ver.

+ +

+ +

Especificando o Padão a Combinar

+ +

O padrão de combinação usa a síntaxe match-pattern. Você pode passar uma única string como padrão a combinar ou um array.

+ +

Mantendo o Conteúdo do Script em um Arquivo Separado

+ +

No exemplo acima, nós fornecemos o script de conteúdo como uma string.

+ +

A menos que o script seja extremamente simples, é melhor manter o script em um arquivo separado. Isso torna o código mais fácil para manter, depurar, e revisar. Para fazer isso, você precisa:

+ + + +

Por exemplo, se você salvar o script acima no diretório data do add-on em um arquivo chamado my-script.js:

+ +
// Importe a API page-mod
+var pageMod = require("sdk/page-mod");
+// Importe a API self
+var self = require("sdk/self");
+
+// Crie um page-mod
+// Ele executará um script toda vez que uma URL ".org" é carregada
+// O script substitui o conteúdo da página por uma mensagem
+pageMod.PageMod({
+  include: "*.org",
+  contentScriptFile: self.data.url("my-script.js")
+});
+ +

Ou a partir do Firefox 34:

+ +
// Importe a API page-mod
+var pageMod = require("sdk/page-mod");
+
+// Crie um page-mod
+// Ele executará um script toda vez que uma URL ".org" é carregada
+// O script substitui o conteúdo da página por uma mensagem
+pageMod.PageMod({
+  include: "*.org",
+  contentScriptFile: "./my-script.js"
+});
+ +

Carregando Múltiplos Scripts de Conteúdo

+ +

Você pode carregar mais do que um script, e eles podem interagir um com o outro.

+ +

Por exmeplo, você poderia reescrever o my-script.js para usar o jQuery.

+ +
$("body").html("<h1>Page matches ruleset</h1>");
+
+ +

Então baixe o jQuery para o diretório data do add-on, e carregue o script e o jQuery juntos (tenha certeza de carregar o jQuery primeiro).

+ +
// Importe a API page-mod
+var pageMod = require("sdk/page-mod");
+// Importe a API self
+var self = require("sdk/self");
+
+// Crie um page-mod
+// Ele executará um script toda vez que uma URL ".org" é carregada
+// O script substitui o conteúdo da página por uma mensagem
+pageMod.PageMod({
+  include: "*.org",
+  contentScriptFile: [self.data.url("jquery-1.7.min.js"), self.data.url("my-script.js")]
+});
+
+ +

Você pode usar ambos contentScript e contentScriptFile no mesmo page-mod. Se você fizer isto, o script carregado usando contentScriptFile são carregados primeiro.

+ +
// Importe a API page-mod
+var pageMod = require("sdk/page-mod");
+// Importe a API self
+var self = require("sdk/self");
+
+// Crie um page-mod
+// Ele executará um script toda vez que uma URL ".org" é carregada
+// O script substitui o conteúdo da página por uma mensagem
+pageMod.PageMod({
+  include: "*.org",
+  contentScriptFile: self.data.url("jquery-1.7.min.js"),
+  contentScript: '$("body").html("<h1>Page matches ruleset</h1>");'
+});
+
+ +

Note, porém, que você não pode carregar um script de um site web. O script deve ser carregado do data.

+ +

Comunicando com o Script de Conteúdo

+ +

Seu script do add-on e o script de conteúdo não podem acessar diretamente a variável de um ou outro ou chamar função dos outros, mas eles podem enviar mensagens um para o outro.

+ +

Para enviar mensagens de um lado para o outro, use o emitente de chamadas port.emit() e receba respostas usando port.on().

+ + + +

Vamos reescrever o exemplo acima para passar uma mensagem do add-on para o script de conteúdo. A mensagem conterá o novo conteúdo para inserir dentro do documento

+ +

O script de conteúdo agora precisa parecer com isto:

+ +
// "self" é um objeto global no script de conteúdo
+// Espera pelas mensagens, e substitui o conteúdo do
+// documento com a mensagem recebida
+self.port.on("replacePage", function(message) {
+  document.body.innerHTML = "<h1>" + message + "</h1>";
+});
+
+ +

No script do add-on, nós enviaremos ao script de conteúdo uma mensagem dentro do onAttach.

+ +
// Importe a API page-mod
+var pageMod = require("sdk/page-mod");
+// Importe a API self
+var self = require("sdk/self");
+
+// Crie um page-mod
+// Ele executará um script toda vez que uma URL ".org" é carregada
+// O script substitui o conteúdo da página por uma mensagem
+pageMod.PageMod({
+  include: "*.org",
+  contentScriptFile: self.data.url("my-script.js"),
+  // Envia ao script de conteúdo uma mensagem dentro de onAttach
+  onAttach: function(worker) {
+    worker.port.emit("replacePage", "Page matches ruleset");
+  }
+});
+
+ +

A mensagem replacePage não é uma mensagem embutida: é uma mensagem definida pelo add-on na chamada do port.emit().

+ +
+

Injetando CSS

+ +

Note que a característica descrita nesta seção é experimental no momento. Nós devemos provavelmente continuar suportando essa característica, mas os detalhes da API devem mudar.

+ +

Em vez de injetar JavaScript na página, você pode injetar CSS definindo a opção do contentStyle do mod-page.

+ +
var pageMod = require("sdk/page-mod").PageMod({
+  include: "*",
+  contentStyle: "body {" +
+                "  border: 5px solid green;" +
+                "}"
+});
+
+ +

Como com o contentScript, há uma opção correspondente para contentStyleFile que leva uma URL de um arquivo CSS situado no diretório "data"; é uma boa prática usar essa opção ao invés de contentStyle se o CSS é muito complexo.

+ +
var pageMod = require("sdk/page-mod").PageMod({
+  include: "*",
+  contentStyleFile: require("sdk/self").data.url("my-style.css")
+});
+
+ +

Ou, a partir do Firefox 34, você pode usar a versão mais simples:

+ +
var pageMod = require("sdk/page-mod").PageMod({
+  include: "*",
+  contentStyleFile: "./my-style.css"
+});
+
+ +

Aprendendo mais

+ +

Para aprender mais sobre o page-mod, veja a referência da API page. Em particular, o construtor PageMod leva várias opções adicionais para controlar seu comportamento:

+ + + +

Para aprender mais sobre o script de conteúdo,, veja o guia content scripts.

diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/mostrar_um_popup/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/mostrar_um_popup/index.html new file mode 100644 index 0000000000..b66c9fb06a --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/tutorials/mostrar_um_popup/index.html @@ -0,0 +1,165 @@ +--- +title: Mostrar um Popup +slug: Mozilla/Add-ons/SDK/Tutorials/Mostrar_um_Popup +tags: + - Add-on SDK + - Painel +translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Display_a_Popup +--- +
+

Para seguir este tutorial você precisará ter instalado o SDK e ter conhecimento básico sobre cfx.

+ +

Este tutorial usa a API action button, que está disponível somente do Firefox 29 em diante.

+
+ +

Para mostrar um popup de diálogo, use o módulo panel. Um painel de conteúdo é definido usando HTML. Você pode executar scripts no painel: embora o script em execução no painel não pode acessar diretamente o código de seu add-on, você pode trocar mensagens entre o script do painel e o código do add-on.

+ +

Neste tutorial nós criaremos um add-on que adiciona um action button à barra de ferramentas que mostra um painel quando clicado. O painel contém apenas um elemento <textarea>:quando o usuário aperta a tecla return, o conteúdo da <textarea> é enviado ao código principal do add-on. O código principal do add-on repassa a mensagem ao console. 

+ +

O add-on consiste em seis arquivos:

+ + + +

O "main.js" se parece com isso:

+ +
var data = require("sdk/self").data;
+// Constrói um painel, carrega seu conteúdo do arquivo
+// "text-entry.html" no diretório "data", e carrega o script "get-text.js"
+// para ele.
+var text_entry = require("sdk/panel").Panel({
+  contentURL: data.url("text-entry.html"),
+  contentScriptFile: data.url("get-text.js")
+});
+
+// Cria um botão
+require("sdk/ui/button/action").ActionButton({
+  id: "show-panel",
+  label: "Show Panel",
+  icon: {
+    "16": "./icon-16.png",
+    "32": "./icon-32.png",
+    "64": "./icon-64.png"
+  },
+  onClick: handleClick
+});
+
+//Mostra o painel quando o usuário clica no botão
+function handleClick(state) {
+  text_entry.show();
+}
+
+//Quando o painel é mostrado ele gera um evento chamado
+//"show": nós esperaremos por este evento e quando ele ocorrer
+//enviamos nosso próprio evento "show" para o script do painel,
+//então o script pode preparar o painel para mostrar.
+text_entry.on("show", function() {
+  text_entry.port.emit("show");
+});
+
+//Espera pela mensagem chamada "text-entered" vinda do
+//script do conteúdo. A carga útil da mensagem é o texto
+//digitado pelo usuário.
+//Nesta implementação nós passaremos o texto para o console.
+text_entry.port.on("text-entered", function (text) {
+  console.log(text);
+  text_entry.hide();
+});
+ +

O conteúdo do script "get-text.js" parece com isto:

+ +
+
//Quando o usuário digita return, envia a mensagem "text-entered"
+// para o main.js.
+//A carga útil da mensagem é o conteúdo da caixa de edição.
+var textArea = document.getElementById("edit-box");
+textArea.addEventListener('keyup', function onkeyup(event) {
+  if (event.keyCode == 13) {
+    // Remove a nova linha.
+    text = textArea.value.replace(/(\r\n|\n|\r)/gm,"");
+    self.port.emit("text-entered", text);
+    textArea.value = '';
+  }
+}, false);
+//Espera pelo evento "show" vim do
+//código principal do add-on. O que significa que o
+//painel sobre será mostrado.
+//
+//Configura o foco para a área de texto então o usuário pode
+//começar a digitar.
+self.port.on("show", function onShow() {
+  textArea.focus();
+});
+ +
 
+
+ +

Finalmente, o arquivo "text-entry.html" define o elemento <textarea>:

+ +
+
+
<html>
+<head>
+    <style type="text/css" media="all">
+      textarea {
+        margin: 10px;
+      }
+      body {
+        background-color: gray;
+      }
+    </style>
+  </head>
+<body>
+    <textarea rows="13" cols="33" id="edit-box"></textarea>
+  </body>
+</html>
+ +
 
+
+
+ +

Finalmente, salve estes três ícones no diretório "data":

+ + + + + + + + + + + + + + + + +
icon-16.png
icon-32.png
icon-64.png
+ +

Teste: o "main.js" está salveo no diretório lib do add-on, e os outros cinco arquivos vão no diretório data do add-on:

+ +
my-addon/
+         data/
+              get-text.js
+              icon-16.png
+              icon-32.png
+              icon-64.png
+              text-entry.html
+         lib/
+             main.js
+
+ +

Execute o add-on, clique no botão, e você deverá ver o painel. Digite algum texto e pressione "return" e você deverá ver a saída no console.

+ +

Do Firefox 30 em diante, se você usar o toggle button, você pode anexar o painel ao botão.

+ +

Aprendendo Mais

+ +

Para aprender mais sobre o módulo panel, veja a referência da API panel.

+ +

Para aprender mais sobre buttons, veja referência da API action button e toggle button.

diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/unit_testing/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/unit_testing/index.html new file mode 100644 index 0000000000..2e65659ed5 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/sdk/tutorials/unit_testing/index.html @@ -0,0 +1,127 @@ +--- +title: Teste de unidade +slug: Mozilla/Add-ons/SDK/Tutorials/Unit_testing +tags: + - Add-on SDK + - JPM +translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Unit_testing +--- +
+

Para seguir este tutorial você precisará ter conhecimento básico de jpm e ter seguido o tutorial de criação de módulos reutilizáveis.

+
+ +
+

Se você está migrando código de teste do cfx para o jpm, veja o guia de migração do cfx, em particular a seção loading modules from test code.

+
+ +

O SDK fornece um framework para ajudar a criar e executar testes de unidade para seu código. Para demonstrar como ele funciona nós escreveremos um teste de unidade para um módulo simples de codificação Base64.

+ +

Um módulo simples Base64

+ +

Em uma página web, você pode executar uma codificação Base64 e decodificação usando as funções btoa() e atob(). Infelizmente essas funções pertencem ao objeto window: uma vez que o objeto não está disponível no código principal do add-on, atob() e btoa() não estão disponíveis de qualquer forma. Então nós criaremos um módulo base64 para exibir estas funções da plataforma.

+ +

Para começar, crie um novo diretório, navegue para ele, e execute o jpm init. Agora crie um novo arquivo chamado "base64.js", e de lhe o seguinte conteúdo:

+ +
const { atob, btoa } = require("chrome").Cu.import("resource://gre/modules/Services.jsm", {});
+
+exports.atob = a => atob(a);
+exports.btoa = b => btoa(b);
+
+ +

Este código exporta duas funções, que chamamos btoa() and atob(). Para mostrar o módulo em uso, edit o arquivo "index.js" como segue:

+ +
var base64 = require("./base64");
+
+var button = require("sdk/ui/button/action").ActionButton({
+  id: "base64",
+  label: "base64",
+  icon: "./icon-16.png",
+  onClick: function() {
+    encoded = base64.btoa("hello");
+    console.log(encoded);
+    decoded = base64.atob(encoded);
+    console.log(decoded);
+  }
+});
+ +

Para executar esse exemplo você também terá que ter um ícone chamado "icon-16.png" salvo no diretório data do add-on. Você pode baixar este ícone: .

+ +

Agora o "index.js" importa o módulo base64 e chama suas duas funções exportadas. Se nós executarmos o add-on e clicarmos no botão, nós devemos ver a seguinte saída:

+ +
info: aGVsbG8=
+info: hello
+
+ +

Testando o módulo Base64

+ +

Navegue para o diretório test e delete o arquivo test-index.js. Em seu lugar crie um arquivo chamado test-base64.js com o seguinte conteúdo:

+ +
var base64 = require("../base64");
+
+exports["test atob"] = function(assert) {
+      assert.ok(base64.atob("aGVsbG8=") == "hello", "atob works");
+}
+
+exports["test btoa"] = function(assert) {
+  assert.ok(base64.btoa("hello") == "aGVsbG8=", "btoa works");
+}
+
+exports["test empty string"] = function(assert) {
+  assert.throws(function() {
+                  base64.atob();
+                },
+                "empty string check works");
+}
+
+require("sdk/test").run(exports);
+
+ +
+

Note que com o  jpm nós devemos dar o caminho exato do módulo base64.js.

+
+ +

Esse arquivo: exporta três funções, cada qual espera receber um único argumento que é o objeto assert. assert é fornecida pelo módulo test/assert e implementa o CommonJS Unit Testing specification.

+ + + +

Neste ponto seu add-on deve parecer com isto:

+ +
  /base64
+      /data
+          icon-16.png
+      package.json
+      README.md
+      index.js
+      base64.js
+      /test
+          test-base64.js
+
+ +

Agora execute o jpm --verbose test da pasta principal do add-on. Você deve ver algo como isto:

+ +
console.info: jpm-utest: executing './test/test-base64.test atob'
+console.info: jpm-utest: pass: atob works
+console.info: jpm-utest: executing './test/test-base64.test btoa'
+console.info: jpm-utest: pass: btoa works
+console.info: jpm-utest: executing './test/test-base64.test empty string'
+console.info: jpm-utest: pass: empty string check works
+
+3 of 3 tests passed.
+All tests passed!
+ +

O que aconteceu aqui é que o jpm test:

+ + + +

Obviamente, você não tem que passar a opção --verbose para o jpm se você não quiser; fazendo assim torna a saída mais fácil de ler.

diff --git a/files/pt-br/mozilla/add-ons/temas/background/index.html b/files/pt-br/mozilla/add-ons/temas/background/index.html new file mode 100644 index 0000000000..856e419f31 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/temas/background/index.html @@ -0,0 +1,110 @@ +--- +title: Temas de fundo +slug: Mozilla/Add-ons/Temas/Background +tags: + - Aparência do Firefox + - Complementos + - Firefox + - Personalização + - Tema +translation_of: Mozilla/Add-ons/Themes/Lightweight_themes +--- +

Como criar o seu próprio tema

+ +
+

Os temas são feitos de arquivos gráficos de imagens, para o cabeçalho, semelhantes ao utilizado como aparência padrão de fundo do Firefox UI.

+ +

Acabou seu projeto? Você pode enviá-lo agora mesmo!

+ +

Criando um tema: Imagem de Cabeçalho

+ +

A imagem do cabeçalho é mostrada no topo da janela do navegador, aninhada atrás da barra de ferramentas, barra de endereço, barra de pesquisa e barra de abas. Ela é ancorada no canto superior direito da janela do navegador.

+ +

+ + + +

Requisitos de Imagem

+ + + +

Dicas

+ + + +

Recursos de Editores de Imagem Em Linha

+ + + +

Criando um tema: Imagem de Rodapé

+ +

Em versões antigas do Firefox, ou em versões recentes com certas extensões instaladas, a imagem de rodapé é mostrada como o fundo da parte inferior da janela do navegador, atrás de extensões e barras de pesquisa. Ela é ancorada no canto inferior esquerdo da janela do navegador. Imagens de rodapé são opcionais.

+ +

+ + + +

Requisitos de Imagem

+ + + +

Dicas

+ + + +

Submentendo as Imagens de seus Temas

+ +

Para enviar suas imagens, vá para a página de  Submissão de Temas:

+ +
    +
  1. Nomeie seu tema — aplique um nome único ao seu tema. Nomes duplos não são permitidos, então, talvez, você precise tentar algumas vezes, até encontrar um nome único disponível.
    2. +
  2. Escolha uma categoria e as etiquetas — selecione uma categoria e insira algumas etiquetas para melhor descrever o seu tema. Tenha em mente que o revisor poderá rejeitá-lo se, obviamente, a categoria e/ou etiquetas não estiverem relacionadas a ele corretamente.
    3. +
  3. Descreva o seu tema — escreva uma descrição curta do seu tema. Tenha em mente que o revisor poderá rejeitá-lo, se essa descrição não for uma representação exata dele.
    4. +
  4. Selecione uma licença para seu tema — decida sobre uma licença de direitos autorais para seu trabalho. Leia mais sobre os tipos de licenças Creative Commons. +
      +
    • Importante: Por favor, certifique-se que você tem o direito de usar a imagem em seu tema!
      • +
    +
    5. +
  5. Envie suas imagems — certifique-se que elas têm menos de 300KB de tamanho e estão no formato JPG, ou PNG!
    6. +
  6. Seleciona a cor do texto e abas — você pode escolher a cor ("de fundo") da aba e a cor do texto que melhor combinam com sua imagem de cabeçalho.
    7. +
  7. Visualize seu tema — tudo pronto para você experimentar o seu tema! Simplesmente passe o cursor sobre a imagem acima do botão "Enviar tema" e veja como ele fica, instantaneamente: )
    8. +
  8. Envie seu tema —  se tudo parece certo, clique no botão Enviar tema e pronto! Você pode ver todos os temas que escreveu na sua página de perfil. +
      +
    • Dica: para garantir que o seu tema será aprovado para a galeria, certifique-se que ele está em conformidade com as diretrizes de conteúdo e termos de serviço!
      • +
    +
    9. +
+ +

+ +

ENVIE SEu TemA AGORA

+ +

 

+ +

Mais Tutoriais

+ +

Mozilla Themes Focal Point on Sizing - Um tutorial sobre os temas, com foco em dimensões, por VanillaOrchids.

+
diff --git a/files/pt-br/mozilla/add-ons/temas/index.html b/files/pt-br/mozilla/add-ons/temas/index.html new file mode 100644 index 0000000000..7f38f0f3e4 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/temas/index.html @@ -0,0 +1,55 @@ +--- +title: Temas +slug: Mozilla/Add-ons/Temas +tags: + - Add-ons + - Aparência & Comportamento + - Complementos + - Mozilla-Firefox + - Temas +translation_of: Mozilla/Add-ons/Themes +--- +

Os temas são as capas, ou coberturas, dos diferentes aplicativos Mozilla. Eles permitem que se altere a aparência da interface de acordo com o seu gosto. Um tema pode, simplesmente, mudar as cores da interface de utilização, ou pode mudar cada parte da sua aparência. A documentação sobre temas está desatualizada, mas estamos na esperança de obter alguma ajuda para atualizá-la, em breve.

+ +
+
+

Documentação

+ +
+
Construindo um tema
+
Um tutorial para construir um tema simples no Firefox. Obs: Conteúdo Obsoleto
+
Problemas Comuns e Suas Soluções
+
Alguns problemas comuns, que ocorrem quando os editores AMO inspecionam os temas e como corrigí-los.
+
Temas leves
+
Construindo temas leves para Firefox
+
Criando uma capa para o SeaMonkey 2
+
Uma introdução para criar novos temas para o SeaMonkey 2.
+
Assegurando-se de que o Seu Tema Funciona Com Escritas RTL
+
Como ter certeza de que o seu tema vai aparecer certinho para Hebreus, Árabes, Persas e Paquistaneses.
+
Acondicionando Temas
+
Como Empacotar Temas para Firefox e Thunderbird.
+
Outro Tutorial
+
Outro tutorial no construção de temas para Mozilla.
+
Documentos Obsoletos
+
Esses documentos são muito velhos e nunca serão atualizados, mas nós os mantemos, para o caso de serem fonte de informações úteis às pessoas atualizar a documentação Tema
+
+
+ +
+

Buscando Ajuda

+ + + +

Ferramentas

+ + +
+
+ +

 

diff --git a/files/pt-br/mozilla/add-ons/temas/using_the_amo_theme_generator/index.html b/files/pt-br/mozilla/add-ons/temas/using_the_amo_theme_generator/index.html new file mode 100644 index 0000000000..a63eb7b624 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/temas/using_the_amo_theme_generator/index.html @@ -0,0 +1,137 @@ +--- +title: Usando o Gerador de Temas AMO +slug: Mozilla/Add-ons/Temas/Using_the_AMO_theme_generator +tags: + - AMO + - Extensões + - Firefox + - Gerador de Temas + - Guía + - Mozilla + - Tema + - Temas + - Tutorial + - extensão +translation_of: Mozilla/Add-ons/Themes/Using_the_AMO_theme_generator +--- +

{{AddonSidebar}}

+ +

O gerador de temas na addons.mozilla.org (AMO) guia você pelo processo da criação de um tema para o Firefox. Uma vez que você já tenha definido as cores e a imagem para o seu tema, o gerador submeterá seu trabalho à AMO. Você pode publicar os temas na AMO, ou gerenciar a sua distribuição.

+ +

Comece

+ +
+

Você precisa entrar em sua conta no Firefox para acessar o Gerador de Temas.

+
+ +

Se você preferir publicar o seu tema na addons.mozilla.org (AMO), comece pela listed Theme Generator page 

+ +

Por outro lado, se você escolher distribuí-lo, vá para a unlisted Theme Generator Page. Para mais informações sobre distribuição, visite Signing and distributing your add-on.

+ +
+

Nota: Você pode gerar um tema mais elaborado, por exemplo, que use múltiplas imagens, criando um tema estático. Para começar os Temas Estáticos, dê uma olhada em: Theme concepts.

+
+ +

Para usar o Gerador de Temas AMO, preencha os campos com as informações sobre o seu tema novo.

+ +

+ +

Comece dando um nome ao seu novo tema.

+ +

Ao escolher uma imagem para o cabeçalho, ela deverá ter:

+ + + +

Nos exemplos acima, a imagem desaparece em uma cor sólida, mantendo seu tamanho.

+ +

Os valores das cores podem ser inseridos em hex, rgb, ou rgba. Você também pode usar o seletor de cores para escolher as que preferir em seu tema:

+ +

+ +

À medida que você for escolhendo as cores, elas vão sendo exibidas no exemplo abaixo do seletor, assim você pode brincar com elas, até encontrar a combinação exata para a sua criação. O bloco maior representa a intensidade da cor, o deslizante arco-íris permite que você selecione a tonalidade e o deslizante mais à direita define a sua opacidade.

+ +

Uma vez que o campo de entrada de cor perder o foco, seu formato será convertido para rgba. Os componentes da cor em RGB (red, green, blue = vermelha, verde, azul) podem variar de 0 a 255, enquanto o "a" em RGBA significa alfa e controla a opacidade da cor. Os valores válidos para alfa variam entre 0 e 1 e o valor padrão é 1.0, ou, completamente opaco.

+ +
+

Você pode usar a Firefox Color extension para antever a sua criação.

+
+ +

As cores na imagem a seguir mostram como você pode definí-las para o seu tema. Todas, menos a Área de fundo do cabeçalho e a Área de texto e ícones do cabeçalho, são opcionais:

+ +

+ +
+
O Fundo da área do cabeçalho
+
A cor de fundo da área de cabeçalho, exibida na área não coberta, ou visível através da imagem de cabeça. Manifest field: accentcolor.
+
Área de texto e ícones do cabeçalho
+
As cores do texto e dos ícones na região do cabeçalho, com exceção da aba ativa. Manifest field: textcolor.
+
Área de fundo da barra de ferramentas (opcional)
+
A cor de fundo da barra de navegação, a barra de favoritos e a aba selecionada. Manifest field: toolbar.
+
Área de texto e ícones da barra de ferramentas (opcional)
+
A cor do texto e dos ícones na barra de ferramentas e a aba ativa. Manifest field: toolbar_text.
+
Área de fundo dos campos da barra de ferramentas (opcional)
+
A cor de fundo para os campos na barra de ferramentas, tais como a barra de pesquisa de URL. Manifest field: toolbar_field.
+
Campo da área de texto na barra de ferramentas (opcional)
+
A cor do texto para os campos na barra de ferramentas, tais como a barra de pesquisa de URL. Manifest field: toolbar_field_text.
+
+ +

Ao fornecer as informações, você verá uma prévia do seu tema no navegador, na parte final do formulário.

+ +

Quando completar as informações necessárias, clique no botão Finish Theme para continuar.

+ +
+

Temas submetidos para sua própria distribuição serão sancionadas imediatamente e um arquivo XPI gerado poderá ser baixado.

+
+ +

Enviando seu tema

+ +

Se você estiver publicando o seu tema na addons.mozilla.org (AMO), a segunda página do criador de temas pedirá que você o descreva. Você, então, deverá fornecer as seguintes informações:

+ +
+
Nome
+
Este é o nome que será exibido na AMO e pode ser diferente do nome mostrado quando o seu tema for instalado no Firefox.
+
Add-on URL
+
Este é o endereço a partir do qual o seu tema pode ser baixado. Você pode editar a parte final do valor (após https://addons.mozilla.org/), mas, por favor, use, apenas, letras, números, subtraços e traços no seu URL.
+
Resumo (necessário)
+
Descreva seu tema. Você dispõe de 250 caracteres para fazê-lo.
+
Selecione uma categoria (necessária)
+
Selecionar uma categoria exata para o seu tema ajuda as pessoas a encontrá-lo na AMO. As seguintes categorias estão disponíveis: +
    +
  • Abstrato
    • +
  • Causas
    • +
  • Moda
    • +
  • Filme e TV
    • +
  • Firefox
    • +
  • Foxkeh
    • +
  • Férias
    • +
  • Música
    • +
  • Natureza
    • +
  • Outra
    • +
  • Cenário
    • +
  • Estação do ano
    • +
  • Esportes
    • +
  • Websites
    • +
+
+
Email de suporte
+
O endereço de email pelo qual as pessoas podem contactar você, caso elas tenham algum problema com o seu tema.
+
Website de suporte
+
A URL para o sítio a partir do qual você oferece suporte ao seu tema.
+
Licença (necessária)
+
A licença sob a qual o seu tema será publicado vai depender das escolhas que você fizer ao responder as seguintes perguntas: +
    +
  • Outras pessoas podem compartilhar o seu tema, desde que mantenham a sua autoria?
    • +
  • As pessoas poderão fazer uso comercial do seu tema?
    • +
  • As pessoas poderão criar trabalhos inspirados em seu tema?
    • +
+
+
+ +

Uma vez que você tiver preenchido todas as informações requeridas, poderá completar o processo de envio ao clicar no botão Submit Version. Você verá alguma coisa que se pareça com isto:

+ +

diff --git a/files/pt-br/mozilla/add-ons/webextensions/anatomia_de_uma_webextension/index.html b/files/pt-br/mozilla/add-ons/webextensions/anatomia_de_uma_webextension/index.html new file mode 100644 index 0000000000..231797ec59 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/anatomia_de_uma_webextension/index.html @@ -0,0 +1,115 @@ +--- +title: Anatomia de uma WebExtension +slug: Mozilla/Add-ons/WebExtensions/Anatomia_de_uma_WebExtension +tags: + - Extensões + - WebExtensions +translation_of: Mozilla/Add-ons/WebExtensions/Anatomy_of_a_WebExtension +--- +

Uma extensão consiste de uma coleção de arquivos, empacotados para distribuição e instalação. Nesse artigo vamos falar rapidamente sobre os arquivos que podem estar presentes em uma extensão.

+ +

Toda extensão contém um arquivo chamado "manifest.json". Ele pode conter ponteiros para quatro outros tipos de arquivos:

+ + + +

+ +

manifest.json

+ +

Esse é o único arquivo que está presente em toda WebExtension. Ele contém metadados básicos sobre a extensão, tais como o nome, a versão e as permissões que ela necessita. Também provê ponteiros para outros arquivos na extensão.

+ +

Para mais detalhes sobre o arquivo "manifest.json", acesse a página de referência.

+ +

Background pages

+ +

Muitas vezes as WebExtensions precisam manter um estado ou performance operativa de longa duração, independentemente do ciclo de vida das páginas ou janelas do navegador. As background pages e os scripts servem pra isso.

+ +

Background scripts são carregados assim que a extensão tem sua carga concluída, e permanecem carregados até que ela seja desativada ou desinstalada. No script você pode fazer uso de qualquer uma das WbExtensions APIs.

+ +

Os background scripts não possuem acesso direto às páginas web. No entanto, eles podem carregar scripts de conteúdo na página, e podem se comunicar com os scripts de conteúdo usando uma API de envio de mensagens.

+ +

Você pode incluir uma background page usando a chave background no "manifest.json". Você não precisa informar a sua própria background page. Se você incluir uma página de background, um arquivo vazio será criado.

+ +
// manifest.json
+
+"background": {
+  "scripts": ["background-script.js"]
+}
+ +

No entanto, você pode escolher informar a página de background como um arquivo HTML a parte:

+ +
// manifest.json
+
+"background": {
+  "page": "background-page.html"
+}
+ +

Scripts de conteúdo

+ +

Use os scripts de conteúdo para acessar e manipular páginas web. Scripts de conteúdo são carregados dentro das páginas web e executados em um contexto particular nessa página.

+ +

Eles podem ver e manipular páginas DOM,

+ +

Scripts de conteúdo podem ver e manipular o DOM das páginas, da mesma forma como os scripts normais carregados pela página.

+ +

Ao contrário dos scripts normais, os scripts de conteúdo podem:

+ + + +

Scripts de conteúdo não podem acessar diretamente os scripts normais da página, mas podem trocar mensagens com eles através do uso da API window.postMessage.

+ +

Normalmente, quando falamos de scripts de conteúdo, estamos nos referindo a JavaScript, mas é possível injetar CSS em paginas web que utilizam o mesmo mecanismo.

+ +

Você pode injetar scripts de conteúdo em páginas web de duas formas: anexando os scripts para todas as páginas correspondentes a um padrão de URL, ou através de programação a partir de um script de background.

+ +

Para injetar scripts em páginas com base na URL, use a chave content_scripts no "manifest.json", informando um ou mais scripts e um array com os padrões:

+ +
// manifest.json
+
+"content_scripts": [
+  {
+    "matches": ["*://*.mozilla.org/*"],
+    "js": ["my-script.js"]
+  }
+]
+ +

Se a URL da página corresponder aos padrões passados na chave matches, os scripts passados na chave js serão carregados.

+ +

Para injetar os scripts na página via programação (por exemplo, quando o usuário clicar em um botão) use a API tabs:

+ +
// background.js
+
+chrome.tabs.executeScript({
+  file: "my-script.js"
+});
+ +

Aprenda mais sobre scripts de conteúdo lendo sua documentação.

+ +

Ações de navegador

+ +

Uma "ação de navegador" é um botão que você pode adicionar na barra de ferramentas do Firefox. O botão tem um ícone. Você pode informar múltiplos ícones em diferentes tamanhos:  fazendo isso, o navegador irá selecionar o ícone mais adequado para a densidade de pixels da tela.

+ +

Opcionalmente, você pode definir um popup para o botão usando HTML, CSS e JavaScript.

+ +

Se você não definir um popup, quando o usuário clicar no botão um evento será disparado, que pode ser ouvido nos scripts de background.

+ +

Se você define um popup, o evento não é disparado: ao invés disso, o popup será mostrado para que o usuário possa interagir. Os scripts executados em popup são capazes de utilizar WebExtension APIs.

+ +

Para aprender mais sobre ações de navegador, consulte a página da API.

+ +

Recursos acessíveis na web

+ +

Recursos acessíveis na web são recursos como imagens, HTML, CSS, JavaScript, que podem ser incluídos na extensão e quer tornar acessível aos scripts de conteúdo e aos scripts da página. Eles podem ser referenciados a partir de scripts de página e de conteúdo, usando um URI scheme especial.

+ +

Por exemplo, se um script de conteúdo quer inserir algumas imagens em páginas da web, você pode incluí-los na extensão e torná-los acessíveis na web. Em seguida o script de conteúdo pode criar e acrescentar tags img que fazem referência às imagens através do atributo src.

+ +

Para entender mais, veja a documentação sobre chaves no manifest.json em recursos acessíveis na web.

diff --git a/files/pt-br/mozilla/add-ons/webextensions/api/alarms/index.html b/files/pt-br/mozilla/add-ons/webextensions/api/alarms/index.html new file mode 100644 index 0000000000..a4e4bd3254 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/api/alarms/index.html @@ -0,0 +1,52 @@ +--- +title: alarms +slug: Mozilla/Add-ons/WebExtensions/API/alarms +tags: + - alarm +translation_of: Mozilla/Add-ons/WebExtensions/API/alarms +--- +
{{AddonSidebar}}
+ +

Executar um código agendado para um horário específico no futuro. Isto é como o setTimeout() e setInterval(), exceto essas funções não funcionam no segundo plano com páginas carregadas sob demanda.

+ +

Para usar estas API você precisa ter a "alarms" permission.

+ +

Tipos

+ +
+
{{WebExtAPIRef("alarms.Alarm")}}
+
Informações sobre um alarme em particular.
+
+ +

Funções

+ +
+
{{WebExtAPIRef("alarms.create()")}}
+
Cria um alarme.
+
{{WebExtAPIRef("alarms.get()")}}
+
Obtém um alarme específico dado seu nome.
+
{{WebExtAPIRef("alarms.getAll()")}}
+
Obtém todos os alarmes agendados.
+
{{WebExtAPIRef("alarms.clear()")}}
+
Limpa um alarme específico dado seu nome.
+
{{WebExtAPIRef("alarms.clearAll()")}}
+
Limpa todos os alarmes agendados.
+
+ +

Eventos

+ +
+
{{WebExtAPIRef("alarms.onAlarm")}}
+
Disparado quando o alarme acaba.
+
+ +

Compatibilidade dos browsers

+ +

{{Compat("webextensions.api.alarms")}} {{WebExtExamples("h2")}}

+ +
Agradecimentos + +

Esta API é baseada na API Chromium's chrome.alarms .

+ +

Dados de compatibilidade do Microsoft Edge fornecidos pela Microsoft Corporation aqui inclusos sob a Creative Commons Attribution 3.0 United States License.

+
diff --git a/files/pt-br/mozilla/add-ons/webextensions/api/bookmarks/index.html b/files/pt-br/mozilla/add-ons/webextensions/api/bookmarks/index.html new file mode 100644 index 0000000000..75aa9ada3c --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/api/bookmarks/index.html @@ -0,0 +1,119 @@ +--- +title: bookmarks +slug: Mozilla/Add-ons/WebExtensions/API/bookmarks +translation_of: Mozilla/Add-ons/WebExtensions/API/bookmarks +--- +
{{AddonSidebar}}
+ +

A API WebExtensions {{WebExtAPIRef("bookmarks")}} permite uma extensão interagir e manipular o sistema de favoritos do navegador. Você pode pode usá-lo para favoritar páginas, obter favoritos existentes e, editar, remover ou organizar os favoritos.

+ +

Para utilizar esta API, uma extensão deve ser requisitada para o "bookmarks" permission em seu arquivo manifest.json .

+ +

Tipos

+ +
+
{{WebExtAPIRef("bookmarks.BookmarkTreeNode")}}
+
Representa um favorito ou um diretório de favoritos como árvore.
+
{{WebExtAPIRef("bookmarks.BookmarkTreeNodeType")}}
+
O enum {{jsxref("String")}} o qual descreve se um nó na árvore é ou não um favorito, uma pasta ou um separador.
+
{{WebExtAPIRef("bookmarks.BookmarkTreeNodeUnmodifiable")}}
+
O enum {{jsxref("String")}} o qual especifica porque um favorito ou uma pasta não pode ser modificado.
+
{{WebExtAPIRef("bookmarks.CreateDetails")}}
+
Contém informações ao qual é passada para a função {{WebExtAPIRef("bookmarks.create()")}} quando um novo favorito é criado.
+
+ +

Funções

+ +
+
{{WebExtAPIRef("bookmarks.create()")}}
+
Cria um favorito ou uma pasta.
+
{{WebExtAPIRef("bookmarks.get()")}}
+
Retrieves one or more {{WebExtAPIRef("bookmarks.BookmarkTreeNode", "BookmarkTreeNode")}}s, given a bookmark's ID or an array of bookmark IDs.
+
{{WebExtAPIRef("bookmarks.getChildren()")}}
+
Recupera os filhos especificados {{WebExtAPIRef("bookmarks.BookmarkTreeNode", "BookmarkTreeNode")}}.
+
{{WebExtAPIRef("bookmarks.getRecent()")}}
+
Recupera um número requisitado de favoritos adicionados recentemente.
+
{{WebExtAPIRef("bookmarks.getSubTree()")}}
+
Recupera uma parte da árvore de favoritos, iniciando por um nó previamente especificado.
+
{{WebExtAPIRef("bookmarks.getTree()")}}
+
Recupera a árvore de favoritos inteira em um array de objetos {{WebExtAPIRef("bookmarks.BookmarkTreeNode", "BookmarkTreeNode")}}.
+
{{WebExtAPIRef("bookmarks.move()")}}
+
Move o especificado {{WebExtAPIRef("bookmarks.BookmarkTreeNode", "BookmarkTreeNode")}} para um novo local dentro da árvore de favoritos.
+
{{WebExtAPIRef("bookmarks.remove()")}}
+
Remove um favorito ou uma pasta de favoritos vazia dado o ID do nó.
+
{{WebExtAPIRef("bookmarks.removeTree()")}}
+
Remove recursivamente uma pasta de favoritos; isto é; dado o ID do nó da pasta e todos seus descendentes.
+
{{WebExtAPIRef("bookmarks.search()")}}
+
Procura por {{WebExtAPIRef("bookmarks.BookmarkTreeNode", "BookmarkTreeNode")}}s que batam com o conjunto de critérios especificados.
+
{{WebExtAPIRef("bookmarks.update()")}}
+
Atualiza o título e/ou autor do favorito de uma URL, ou o nome de uma pasta de favoritos dado o ID do favorito.
+
+ +

Eventos

+ +
+
{{WebExtAPIRef("bookmarks.onCreated")}}
+
Disparado quando um favorito ou uma pasta é criado.
+
{{WebExtAPIRef("bookmarks.onRemoved")}}
+
Disparado quando um favorito ou uma pasta é removido. Quando uma pasta é removida recursivamente, uma simples notificação é disparada para o diretório, e nenhum para seu conteúdo.
+
{{WebExtAPIRef("bookmarks.onChanged")}}
+
Disparado quando um favorito ou pasta é modificado. Atualmente, somente mudanças no title e url o disparam.
+
{{WebExtAPIRef("bookmarks.onMoved")}}
+
Disparado quando um favorito ou pasta é movido para uma pasta pai diferente ou para um novo local dentro deste pasta.
+
{{WebExtAPIRef("bookmarks.onChildrenReordered")}}
+
Fired when the user has sorted the children of a folder in the browser's UI. This is not called as a result of a {{WebExtAPIRef("bookmarks.move", "move()")}}.
+
{{WebExtAPIRef("bookmarks.onImportBegan")}}
+
Disparado quando uma sessão de importação de favoritos começa. Custosos observers {{WebExtAPIRef("bookmarks.onCreated")}} atualizam até o {{WebExtAPIRef("bookmarks.onImportEnded")}} ser disparado. Observers deveriam ainda manipular outras notificações imediatamente.
+
{{WebExtAPIRef("bookmarks.onImportEnded")}}
+
Disparado quando uma sessão de importação de favoritos é finalizada.
+
+ +

Compatibilidade nos navegadores

+ +

{{Compat("webextensions.api.bookmarks")}}

+ + + +

{{WebExtExamples("h2")}}

+ +
Agradecimentos + +

Esta API é baseada na API Chromium chrome.bookmarks . Esta documentação é derivada do bookmarks.json no código do Chromium.

+ +

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

+
+ + diff --git a/files/pt-br/mozilla/add-ons/webextensions/api/browseraction/index.html b/files/pt-br/mozilla/add-ons/webextensions/api/browseraction/index.html new file mode 100644 index 0000000000..29eae4f07f --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/api/browseraction/index.html @@ -0,0 +1,128 @@ +--- +title: browserAction +slug: Mozilla/Add-ons/WebExtensions/API/browserAction +tags: + - API + - Add-ons + - Extensões + - Interfaces + - Não Padrão + - Referencia + - browserAction +translation_of: Mozilla/Add-ons/WebExtensions/API/browserAction +--- +
{{AddonSidebar}}
+ +

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:

+ + + +

Tipos

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

Funções

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

Eventos

+ +
+
{{WebExtAPIRef("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

+ +

{{Compat("webextensions.api.browserAction")}}

+ + + +

{{WebExtExamples("h2")}}

+ +
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.

+
+ + diff --git a/files/pt-br/mozilla/add-ons/webextensions/api/browsersettings/index.html b/files/pt-br/mozilla/add-ons/webextensions/api/browsersettings/index.html new file mode 100644 index 0000000000..197bc1ab3e --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/api/browsersettings/index.html @@ -0,0 +1,60 @@ +--- +title: browserSettings +slug: Mozilla/Add-ons/WebExtensions/API/browserSettings +tags: + - Extensões + - Referencia +translation_of: Mozilla/Add-ons/WebExtensions/API/browserSettings +--- +
{{AddonSidebar}}
+ +
Habilita uma extensão para modificar certas configurações globais do navegador. Cada propriedade desta API é um objeto {{WebExtAPIRef("types.BrowserSetting", "BrowserSetting")}}, provendo a capacidade de modificar uma configuração particular.
+ +
 
+ +
Devido estas serem configurações globais, é possível haver conflito entre extensões. Veja a documentação BrowserSetting.set() para detalhes de como ligar com conflitos .
+ +
 
+ +
+

Para usar esta API você precisa ter a permissão "browserSettings".

+
+ +

Propriedades

+ +
+
{{WebExtAPIRef("browserSettings.allowPopupsForUserEvents")}}
+
Determina se o código em execução nas páginas podem mostrar popups em resposta a eventos do usuário.
+
{{WebExtAPIRef("browserSettings.cacheEnabled")}}
+
Determina se o cache do navegador está ou não habilitado.
+
{{WebExtAPIRef("browserSettings.closeTabsByDoubleClick")}}
+
Determina se a aba selecionada pode ser fechada com um duplo click.
+
{{WebExtAPIRef("browserSettings.contextMenuShowEvent")}}
+
Determina o evento do mouse que dispara um menu de contexto de popup.
+
{{WebExtAPIRef("browserSettings.homepageOverride")}}
+
Lê o valor da página inicial do navegador.
+
{{WebExtAPIRef("browserSettings.imageAnimationBehavior")}}
+
Determina como o navegador trata imagens animadas.
+
{{WebExtAPIRef("browserSettings.newTabPageOverride")}}
+
Lê o valor da nova aba do navegador.
+
{{WebExtAPIRef("browserSettings.newTabPosition")}}
+
Controla a posição de abas recentemente abertas relativa as abas já presentes.
+
{{WebExtAPIRef("browserSettings.openBookmarksInNewTabs")}}
+
Determina se os favoritos são abertos na aba atual ou em uma nova aba.
+
{{WebExtAPIRef("browserSettings.openSearchResultsInNewTabs")}}
+
Determina se a busca de resultados é aberta na aba atual ou em uma nova.
+
{{WebExtAPIRef("browserSettings.openUrlbarResultsInNewTabs")}}
+
Determina se as sugestões do autocompletar da barra de endereços são abertas  na aba atual ou em uma nova.
+
{{WebExtAPIRef("browserSettings.overrideDocumentColors")}}
+
Controla se as cores de escolha do usuário sobrescreverão as cores das páginas.
+
{{WebExtAPIRef("browserSettings.useDocumentFonts")}}
+
Controle se o navegador usará as fontes especificadas pela página web ou somente fontes embutidas.
+
{{WebExtAPIRef("browserSettings.webNotificationsDisabled")}}
+
Previne que os sites exibam notificações usando a API Web Notification.
+
+ +

Compatibilidade de browser

+ +

{{Compat("webextensions.api.browserSettings")}}

+ +

{{WebExtExamples("h2")}}

diff --git a/files/pt-br/mozilla/add-ons/webextensions/api/browsingdata/index.html b/files/pt-br/mozilla/add-ons/webextensions/api/browsingdata/index.html new file mode 100644 index 0000000000..e956a583ab --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/api/browsingdata/index.html @@ -0,0 +1,120 @@ +--- +title: browsingData +slug: Mozilla/Add-ons/WebExtensions/API/browsingData +translation_of: Mozilla/Add-ons/WebExtensions/API/browsingData +--- +
{{AddonSidebar}}
+ +

Habilita extensões a limpar os dados que estão acumulados enquando o usuário navega.

+ +

Na API browsingData, os dados de navegação são divididos em tipos:

+ + + +

Você pode usar a função {{WebExtAPIRef("browsingData.remove()")}} para remover qualquer combinação desses tipos. Há também funções específicas para remover cada tipo de data em particular, como por exemplo {{WebExtAPIRef("browsingData.removePasswords()", "removePasswords()")}}, {{WebExtAPIRef("browsingData.removeHistory()", "removeHistory()")}} e assim por diante.

+ +

Todas funções browsingData.remove[X]() pegam o objeto {{WebExtAPIRef("browsingData.RemovalOptions")}} que você usa para controlar outros dois aspectos da remoção de dados:

+ + + +

Finalmente, a API {{WebExtAPIRef("browsingData.settings()")}} fornece uma função que retorna o atual valor das configurações da funcionalidade "Limpar Histórico".

+ +

Para usar esta API você deve ter a permissão de API "browsingData".

+ +

Tipos

+ +
+
{{WebExtAPIRef("browsingData.DataTypeSet")}}
+
Objeto usado para especificar o tipo de dado para remoção: por exemplo, histórico, downloads, senhas e assim por diante.
+
{{WebExtAPIRef("browsingData.RemovalOptions")}}
+
Objeto usado para especificar o quanto tempo para remoção de dados, e se remover dados adicionados em uma navegação web normal, por aplicativos hospedados ou por add-ons.
+
+ +

Methods

+ +
+
{{WebExtAPIRef("browsingData.remove()")}}
+
Remove os dados de navegação especificado pelo seu tipo.
+
{{WebExtAPIRef("browsingData.removeCache()")}}
+
Limpa o cache do navegador.
+
{{WebExtAPIRef("browsingData.removeCookies()")}}
+
Remove os cookies.
+
{{WebExtAPIRef("browsingData.removeDownloads()")}}
+
Remove a lista de arquivos baixados.
+
{{WebExtAPIRef("browsingData.removeFormData()")}}
+
Limpa os dados de um formulário salvo.
+
{{WebExtAPIRef("browsingData.removeHistory()")}}
+
Limpa o histórico do navegador.
+
{{WebExtAPIRef("browsingData.removeLocalStorage()")}}
+
Limpa qualquer local storage criado por websites.
+
{{WebExtAPIRef("browsingData.removePasswords()")}}
+
Limpa passwords salvos.
+
{{WebExtAPIRef("browsingData.removePluginData()")}}
+
Limpa os dados associados com plugins.
+
{{WebExtAPIRef("browsingData.settings()")}}
+
Obtém o valor atual de configuração da funcionalidade "Limpar Histórico" do navegador.
+
+ +

Compatibilidade de browser

+ + + +

{{Compat("webextensions.api.browsingData", 2)}}

+ + + +

{{WebExtExamples("h2")}}

+ +
Agradecimentos + +

Esta API é baseada na API chrome.browsingData do Chromium.

+ +

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

+
+ + diff --git a/files/pt-br/mozilla/add-ons/webextensions/api/clipboard/index.html b/files/pt-br/mozilla/add-ons/webextensions/api/clipboard/index.html new file mode 100644 index 0000000000..4399588cb3 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/api/clipboard/index.html @@ -0,0 +1,34 @@ +--- +title: clipboard +slug: Mozilla/Add-ons/WebExtensions/API/clipboard +tags: + - Área de transferência +translation_of: Mozilla/Add-ons/WebExtensions/API/clipboard +--- +
{{AddonSidebar}}
+ +

A API de área de transferência habilita uma extensão para copiar itens para a área de transferência do sistema. Atualmente a API suporta apenas a cópia de imagens, mas é pretendido suportar a cópia de texto e HTML no futuro.

+ +

Esta API WebExtension existe primariamente por causa que o padrão da API web para área de transferência não suporta escrita de imagens. Se e quando esta funcionalidade for adicionada na API wb padrão, esta API pode ser depreciada.

+ +

Leitura da área de transfência não é suportada por esta API, devido esta já poder ser lida usando as APIs padrão da plataforma web. Veja interagindo com a área de transferência.

+ +

Esta API é baseada na API clipboard do Chrome's API, mas esta API está disponível somente para o Chrome.

+ +

Para utilizar esta API voce precisa ter a permissão "clipboardWrite".

+ +

Funções

+ +
+
{{WebExtAPIRef("clipboard.setImageData()")}}
+
Copia uma imagem para a área de transferência.
+
+ +

Compatibilidade do navegador

+ +

{{Compat("webextensions.api.clipboard", 1, 1)}} {{WebExtExamples("h2")}}

+ +
Agradecimentos + +

Esta API é baseada na API Chromium chrome.clipboard.

+
diff --git a/files/pt-br/mozilla/add-ons/webextensions/api/commands/index.html b/files/pt-br/mozilla/add-ons/webextensions/api/commands/index.html new file mode 100644 index 0000000000..876c09a9a9 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/api/commands/index.html @@ -0,0 +1,83 @@ +--- +title: commands +slug: Mozilla/Add-ons/WebExtensions/API/commands +translation_of: Mozilla/Add-ons/WebExtensions/API/commands +--- +
{{AddonSidebar}}
+ +

Escuta por usuário executando comandos que você registrou usando o commands manifest.json key.

+ +

Tipos

+ +
+
{{WebExtAPIRef("commands.Command")}}
+
Objeto representando um comando. Contém a informação especificada no comando commands manifest.json key.
+
+ +

Funções

+ +
+
{{WebExtAPIRef("commands.getAll")}}
+
+

Obtém todos os comandos registrados para esta extensão.

+
+
{{WebExtAPIRef("commands.reset")}}
+
+

Reseta a descrição do comando dado e atalho para os valores dados na chave do manifesto.

+
+
{{WebExtAPIRef("commands.update")}}
+
+

Modifica a descrição ou atalho dado um comando.

+
+
+ +

Eventos

+ +
+
{{WebExtAPIRef("commands.onCommand")}}
+
+
Disparado quando um comando é executado usando seu atalho associado ao teclado.
+
+
+ +

Compatibilidade do navegador

+ +

{{Compat("webextensions.api.commands")}}{{WebExtExamples("h2")}}

+ +
Agradecimentos + +

Esta API é baseada na API chrome.commands do Chromium.

+ +

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

+
+ + diff --git a/files/pt-br/mozilla/add-ons/webextensions/api/contentscripts/index.html b/files/pt-br/mozilla/add-ons/webextensions/api/contentscripts/index.html new file mode 100644 index 0000000000..f158dcdee4 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/api/contentscripts/index.html @@ -0,0 +1,38 @@ +--- +title: contentScripts +slug: Mozilla/Add-ons/WebExtensions/API/contentScripts +translation_of: Mozilla/Add-ons/WebExtensions/API/contentScripts +--- +
{{AddonSidebar}}
+ +

Use esta API para registrar o conteúdo de scripts. Registrando um conteúdo de scripts instrui o navegador para inserir conteúdo de script fornecido em páginas que batem com um padrão de URL fornecida.

+ +

Esta API é muito similar a chave do "content_scripts"  no manifest.json key, exceto pelo  "content_scripts", o conjunto de conteúdo de scripts a padrões associados são fixados no momento da instalação. Com a API contentScripts, uma extensão pode registrar e desregistrar scripts em tempo de execução.

+ +

Para usar a API, invoque {{WebExtAPIRef("contentScripts.register()")}} passando um objeto definido para registrar os scripts, os padrões de URL e outras opções. Ele retorna uma Promise que é resolvida com o objeto {{WebExtAPIRef("contentScripts.RegisteredContentScript")}}.

+ +

O objeto RegisteredContentScript represente os scripts que foram registrados com a chamada register(). Ele define um método unregister() que você pode usar para desregistrar o conteúdo de scripts. O conteúdo de scripts também são desregistrados automaticamente quando a página que os criou é destruida. Por exemplo, se estão registrados para uma página em segundo plano serão desregistrados automaticamente quando esta página for destruida, e se eles estão registrados para uma barra lateral ou popup, também serão desregistrados automaticamente quando essas forem fechadas.

+ +

Não há permissão para a API contentScripts, mas uma extensão pode ter a permissão de host apropriada para algum padrão passado para o register().

+ +

Tipos

+ +
+
{{WebExtAPIRef("contentScripts.RegisteredContentScript")}}
+
+

Um objeto deste tipo é retornado pela função {{WebExtAPIRef("contentScripts.register()")}} . Ele representa o conteúdo dos scripts que foram registrados por aquela chamada, e podem ser usados para desregistrar o conteúdo do script.

+
+
+ +

Funções

+ +
+
{{WebExtAPIRef("contentScripts.register()")}}
+
Registra o conteúdo dos scripts fornecidos.
+
+ +

Compatibilidade do navegador

+ +

{{Compat("webextensions.api.contentScripts", 10, 1)}}

+ +

 {{WebExtExamples("h2")}}

diff --git a/files/pt-br/mozilla/add-ons/webextensions/api/contextualidentities/index.html b/files/pt-br/mozilla/add-ons/webextensions/api/contextualidentities/index.html new file mode 100644 index 0000000000..652e9d08b2 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/api/contextualidentities/index.html @@ -0,0 +1,62 @@ +--- +title: contextualIdentities +slug: Mozilla/Add-ons/WebExtensions/API/contextualIdentities +tags: + - Extensões Web + - Identidade contextual +translation_of: Mozilla/Add-ons/WebExtensions/API/contextualIdentities +--- +
{{AddonSidebar}}
+ +

Trabalhar com identidades contextuais: listar, criar, remover e atualizar identidades contextuais.

+ +

"Identidades conceituais", também conhecido como "containers",  consiste em uma funcionalidade do navegador cuja premissa é que usuários assumem multiplas identidades quando navegam na internet, e desejam manter alguma separação entre tais identidades. Por exemplo, um usuário pode considerar sua "identidade de trabalho" separada de sua "identidade pessoal", e não desejar compartilhar cookies entre esses dois contextos.

+ +

Com a funcionalidade de identidades contextuais, cada uma possui um nome, cor e um ícone. Novas abas são atribuidas a uma identidade, e o nome, ícone e cor aparecerão na barra de endereço. Internamente, cada identidade guarda seu próprio cookie e não os compartilha entre outras abas.

+ +

Identidade contextual é uma funcionalidade experimental no Firefox e está habilitado apenas no Firefox Nightly. Para habilitá-lo em outras versões do Firefox, atribua true as seguintes preferências: privacy.userContext.enabled. Observe que embora identidades contextuais estejam disponíveis no Firefox para Android, não há uma interface gráfica funcionando com ela para esta versão de navegador.

+ +

Antes do Firefox 57, a API contextualIdentities é disponível apenas se a funcionalidade de identidade contextual está habilitada por si mesma. Se uma extensão tentou usar a API contextualIdentities API sem a funcionalidade estar habilitada, então as chamadas do método deveria resolver suas promises com false.

+ +

Para o Firefox 57 em diante, se uma extensão que usa a API contextualIdentities está instalada, então a funcionalidade de identidade contextual será habilitada automaticamente. Observe que embora ainda é possível para o usuário desabilitar a funcionalidade usando a preferência "privacy.userContext.enabled". Isse isso ocorrer, então a chamada do método contextualIdentities rejeitará suas promises com uma mensagem de erro.

+ +

Para mais informações sobre identidade contextual no Firefox veja este guia.

+ +

Identidades contextuais atualmente não são suportadas em outros navegadores.

+ +

Para usar esta API você precisará incluir a permissão "contextualIdentities" em seu arquivo manifest.json.

+ +

Tipos

+ +
+
{{WebExtAPIRef("contextualIdentities.ContextualIdentity")}}
+
Contém informações sobre uma identidade contextual.
+
+ +

Funções

+ +
+
{{WebExtAPIRef("contextualIdentities.create()")}}
+
Cria uma nova identidade contextual.
+
{{WebExtAPIRef("contextualIdentities.get()")}}
+
Recupera uma única identidade contextual, dado o ID do cookie que armazena.
+
{{WebExtAPIRef("contextualIdentities.query()")}}
+
Recupera todas identidades contextuais, ou todas com um nome em particular.
+
{{WebExtAPIRef("contextualIdentities.update()")}}
+
Atualiza as propriedades existentes de uma identidade contextual.
+
{{WebExtAPIRef("contextualIdentities.remove()")}}
+
Exclui uma identidade contextual.
+
+

Eventos

+
+
{{WebExtAPIRef("contextualIdentities.onCreated")}}
+
Disparado quando uma identidade contextual é criada.
+
{{WebExtAPIRef("contextualIdentities.onRemoved")}}
+
Disparado quando uma identidade contextual é removida.
+
{{WebExtAPIRef("contextualIdentities.onUpdated")}}
+
Disparado quando uma ou mais propriedades de uma identidade contextual é atualizada.
+
+ +

Compatibilidade de navegador

+ +

{{Compat("webextensions.api.contextualIdentities")}} {{WebExtExamples("h2")}}

diff --git a/files/pt-br/mozilla/add-ons/webextensions/api/cookies/index.html b/files/pt-br/mozilla/add-ons/webextensions/api/cookies/index.html new file mode 100644 index 0000000000..ac53214831 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/api/cookies/index.html @@ -0,0 +1,162 @@ +--- +title: cookies +slug: Mozilla/Add-ons/WebExtensions/API/cookies +translation_of: Mozilla/Add-ons/WebExtensions/API/cookies +--- +
{{AddonSidebar}}
+ +

Habilita extensões a obter e atribuir cookies, e ser notificado quando eles mudam.

+ +

Para usar esta API, você precisa incluir a API permission "cookies" em seu arquivo manifest.json, bem como a host permissions para os sites cujos cookies você precisa acessar. Veja cookie Permissions.

+ +

Permissões

+ +

Para usar esta API, uma extensão especificar a "cookies" API permission em seu arquivo manifest, junto com a host permissions para qualquer site que deseja acessar os cookies. O add-on pode ler ou escrever qualquer cookie no qual poderia ser lido ou escrito pela URL correspondente nas permissões de host, por exemplo:

+ +
+
http://*.example.com/
+
+

Uma extensão com esta permissão de host pode:

+ +
    +
  • Ler um cookie inseguro para www.example.com, com qualquer caminho.
    • +
  • Escrever um cookie seguro ou inseguro para www.example.com, com qualquer caminho.
    • +
+ +

não pode:

+ +
    +
  • Ler um cookie seguro de www.example.com.
    • +
+
+
http://www.example.com/
+
+

Uma extensão com esta permissão de host pode:

+ +
    +
  • Ler um cookie não seguro para www.example.com, com qualquer caminho.
    • +
  • Ler um cookie não seguro para .example.com, com qualquer caminho.
    • +
  • Escrever um cookie seguro ou não seguro para www.example.com com qualquer caminho.
    • +
  • Escrever um cookie seguro ou não seguro para .example.com com qualquer caminho.
    • +
+ +

não pode:

+ +
    +
  • Ler ou escrever um cookie para foo.example.com.
    • +
  • Ler ou escrever um cookie para foo.www.example.com.
    • +
+
+
*://*.example.com/
+
+

Uma extensão com esta permissão de host pode:

+ +
    +
  • Ler ou escrever um cookie seguro ou inseguro para www.example.com com qualquer caminho.
    • +
+
+
+ +

Isolamento de primera parte

+ +

Cookies de terceiros são aquleles enviados por sites em que você está num dado momento, por exemplo:

+ +
    +
  1. Você acessa bbc.com. Ele contém uma publicidade do tracker.com que atribui um cookie associado com o domínio "tracker.com".
    2. +
  2. Você acessa cnn.com. Ele também contém uma publicidade do tracker.com que atribui um cookie associado ao domínio "tracker.com".
    3. +
  3. Eventualmente ambos os cookies podem ser enviados para tracker.com. Quem então pode descobrir que o mesmo usuário visitou ambos os sites.
    4. +
+ +

Quando um isolamento de primeira parte está ativo, cookies são ainda qualificados pelo domínio da página original visitada pelo usuário (essencialmente, o domínio exibe o usuário na barra da URL, também conhecido como "domínio de primeira parte). Isto significa que não é possivel para um rastreador correlacionar o cookie da bbc.com com o cookie da cnn.com, então o rastreador não pode monitorar um simples usuários através de ambos os sites.

+ +

Isolamento de primera parte pode ser habilitado diretamente pelo usuário ajustando a configuração do navegador , e pode ser atribuia do extensões usando a configuração firstPartyIsolate atribuida a API privacy. Observe que este isolamento de primeira parte está habilitado por padrão no navegador Tor.

+ +

Na API cookies, o domínio de primeira parte é representado usando o atributo firstPartyDomain. Todos os cookies atribuidos enquanto o isolamento de primeira parte está habilitado terá este atributo atribuito para o domínio da página original. No exemplo acima, deveria ser "bbc.com" para um cookie e "cnn.com" para outro. Todos os cookies atribuidos pelos websites enquanto o isolamento de primeira parte estiver desabilitado terão sua propriedade atribuida a uma string vazia.
+
+ As APIs {{WebExtAPIRef("cookies.get()")}}, {{WebExtAPIRef("cookies.getAll()")}}, {{WebExtAPIRef("cookies.set()")}} and {{WebExtAPIRef("cookies.remove()")}} aceitam a opção firstPartyDomain.
+
+ Quando o isolamento de primeira parte está habilitado, você deve informar esta opção ou a chamada da API irá falhar e retornar uma promise rejeitada. For get(), set(), and remove() you must pass a string value. Para um getAll(), você pode passar null, e irá obter todos os cookies que possuem ou não um valor não vazio para o firstPartyDomain.
+
+ Quando o isolamento de primeira parte está desabilitado, o parâmetro firstPartyDomain é opcional por padrão é uma string vazia.  Uma string não vazia pode ser utilizada para recuperar ou podificar cookies de isolamento de primeira parte.  Da mesma forma, passando null como firstPartyDomain para o getAll() retornará todos os cookies.

+ +

Tipos

+ +
+
{{WebExtAPIRef("cookies.Cookie")}}
+
Representa a informação sobre um cookie HTTP.
+
{{WebExtAPIRef("cookies.CookieStore")}}
+
Representa um cookie armazenado no navegador.
+
{{WebExtAPIRef("cookies.OnChangedCause")}}
+
Representa o motivo da mudança de um cookie.
+
+ +

Métodos

+ +
+
{{WebExtAPIRef("cookies.get()")}}
+
Recupera informações sobre um único cookie.
+
{{WebExtAPIRef("cookies.getAll()")}}
+
Recupera todos os cookies com o padrão de um conjunto de filtros fornecido.
+
{{WebExtAPIRef("cookies.set()")}}
+
Atribui um cookie com um dado fornecido; pode sobrescrever cookies equivalentes caso existam.
+
{{WebExtAPIRef("cookies.remove()")}}
+
Remove um cookie pelo nome.
+
{{WebExtAPIRef("cookies.getAllCookieStores()")}}
+
Lista todos os cookies armazenados.
+
+ +

Manipulador de eventos

+ +
+
{{WebExtAPIRef("cookies.onChanged")}}
+
Disparado quando um cookie é criado ou removido.
+
+ +
+
+
    +
+
+
+ +

Compatibilidade de navegadores

+ +

{{Compat("webextensions.api.cookies")}}

+ +

{{WebExtExamples("h2")}}

+ +
Agradecimentos + +

Esta API é baseada na API chrome.cookies do Chromium. Esta documentação é derivada do cookies.json no código do Chromium.

+
+ + diff --git a/files/pt-br/mozilla/add-ons/webextensions/api/index.html b/files/pt-br/mozilla/add-ons/webextensions/api/index.html new file mode 100644 index 0000000000..955086de10 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/api/index.html @@ -0,0 +1,53 @@ +--- +title: JavaScript APIs +slug: Mozilla/Add-ons/WebExtensions/API +tags: + - NeedsTranslation + - TopicStub + - WebExtensions +translation_of: Mozilla/Add-ons/WebExtensions/API +--- +
{{AddonSidebar}}
+ +
+

JavaScript APIs for WebExtensions can be used inside the extension's background scripts and in any other documents bundled with the extension, including browser action or page action popups, sidebars, options pages, or new tab pages. A few of these APIs can also be accessed by an extension's content scripts (see the list in the content script guide).

+ +

To use the more powerful APIs you need to request permission in your extension's manifest.json.

+ +

You can access the APIs using the browser namespace:

+ +
function logTabs(tabs) {
+  console.log(tabs);
+}
+
+browser.tabs.query({currentWindow: true}, logTabs);
+
+ +
+

Many of the APIs are asynchronous, returning a Promise:

+ +
function logCookie(c) {
+  console.log(c);
+}
+
+function logError(e) {
+  console.error(e);
+}
+
+var setCookie = browser.cookies.set(
+  {url: "https://developer.mozilla.org/"}
+);
+setCookie.then(logCookie, logError);
+
+ +
+

Note that this is different from Google Chrome's extension system, which uses the chrome namespace instead of browser, and which uses callbacks instead of promises for asynchronous functions. As a porting aid, the Firefox implementation of WebExtensions APIs supports chrome and callbacks as well as browser and promises. Mozilla has also written a polyfill which enables code that uses browser and promises to work unchanged in Chrome: https://github.com/mozilla/webextension-polyfill.

+ +

Firefox also implements these APIs under the chrome namespace using callbacks. This allows code written for Chrome to run largely unchanged in Firefox for the APIs documented here.

+ +

Microsoft Edge uses the browser namespace, but doesn't yet support promise-based asynchronous APIs. In Edge, for the time being, asynchronous APIs must use callbacks.

+ +

Not all browsers support all the APIs: for the details, see Browser support for JavaScript APIs.

+
+ +
{{SubpagesWithSummaries}}
diff --git a/files/pt-br/mozilla/add-ons/webextensions/api/menus/index.html b/files/pt-br/mozilla/add-ons/webextensions/api/menus/index.html new file mode 100644 index 0000000000..f63d411e76 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/api/menus/index.html @@ -0,0 +1,205 @@ +--- +title: menus +slug: Mozilla/Add-ons/WebExtensions/API/menus +tags: + - API + - Add-ons + - Extensions + - Interface + - Non-standard + - Reference + - WebExtensions + - contextMenus + - menus +translation_of: Mozilla/Add-ons/WebExtensions/API/menus +--- +
{{AddonSidebar}}
+ +

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 API browser.menus adiciona alguns recursos à API do Chrome.

+ +

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

+ +

Para usar essa API, você precisa da permissão de menus. Você também pode usar o alias contextMenus em vez de menus, mas se usar, a API deve ser acessada como browser.contextMenus.

+ +

Exceto para menus.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étodo {{WebExtAPIRef("menus.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 evento {{WebExtAPIRef("menus.onClicked")}}. Este ouvinte será passado

+ +

Listen for clicks on your menu item by adding a listener to the {{WebExtAPIRef("menus.onClicked")}} event. Este ouvinte receberá um objeto {{WebExtAPIRef("menus.OnClickData")}} que contém os detalhes do evento.

+ +

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

+ + + +

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 a chave "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ção icons para o {{WebExtAPIRef("menus.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

+ +
+
{{WebExtAPIRef("menus.ContextType")}}
+
Os diferentes contextos em que um menu pode aparecer.
+
{{WebExtAPIRef("menus.ItemType")}}
+
O tipo de item de menu: "normal", "checkbox", "radio", "separator".
+
{{WebExtAPIRef("menus.OnClickData")}}
+
Informação enviada quando um item do menu é clicado.
+
+ +

Propriedades

+ +
+
{{WebExtAPIRef("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

+ +
+
{{WebExtAPIRef("menus.create()")}}
+
Cria um novo item de menu.
+
{{WebExtApiRef("menus.getTargetElement()")}}
+
Retorna o elemento para um info.targetElementId determinado.
+
{{WebExtApiRef("menus.overrideContext()")}}
+
Oculta todos os itens de menu padrão do Firefox para fornecer uma interface de usuário personalizada do menu de contexto.
+
{{WebExtAPIRef("menus.refresh()")}}
+
Atualiza um menu que está sendo exibido no momento.
+
{{WebExtAPIRef("menus.remove()")}}
+
Remove um item do menu.
+
{{WebExtAPIRef("menus.removeAll()")}}
+
Remove todos os itens do menu adicionados por esta extensão.
+
{{WebExtAPIRef("menus.update()")}}
+
Atualiza um item do menu criado anteriormente.
+
+ +

Eventos

+ +
+
{{WebExtAPIRef("menus.onClicked")}}
+
Ativado quando um item de menu é clicado.
+
{{WebExtAPIRef("menus.onHidden")}}
+
Ativado quando o navegador esconde um menu.
+
{{WebExtAPIRef("menus.onShown")}}
+
Ativado quando o navegador mostra um menu.
+
+ +

Compatibilidade do navegador

+ +

{{ Compat("webextensions.api.menus", 1, "true") }}

+ +

{{WebExtExamples("h2")}}

+ +
Reconhecimentos + +

Esta API é baseada na API chrome.contextMenus do Chromium. Esta documentação é derivada do context_menus.json do código do Chromium .

+
+ + diff --git a/files/pt-br/mozilla/add-ons/webextensions/api/tabs/index.html b/files/pt-br/mozilla/add-ons/webextensions/api/tabs/index.html new file mode 100644 index 0000000000..b6f69f193b --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/api/tabs/index.html @@ -0,0 +1,223 @@ +--- +title: tabs +slug: Mozilla/Add-ons/WebExtensions/API/tabs +tags: + - API + - Add-ons + - Extensions + - Interface + - NeedsTranslation + - Non-standard + - Reference + - TopicStub + - WebExtensions + - tabs +translation_of: Mozilla/Add-ons/WebExtensions/API/tabs +--- +
{{AddonSidebar}}
+ +

Interact with the browser's tab system.

+ +

You can use this API to get a list of opened tabs, filtered by various criteria, and to open, update, move, reload, and remove tabs. You can't directly access the content hosted by tabs using this API, but you can insert JavaScript and CSS into tabs using the {{WebExtAPIRef("tabs.executeScript()")}} or {{WebExtAPIRef("tabs.insertCSS()")}} APIs.

+ +

You can use most of this API without any special permission. However:

+ + + +

Alternatively, you can get these permissions temporarily, only for the currently active tab and only in response to an explicit user action, by asking for the "activeTab" permission.

+ +

Many tab operations use a Tab id. Tab ids are guaranteed to be unique to a single tab only within a browser session. If the browser is restarted, then it can and will reuse tab ids. To associate information with a tab across browser restarts, use {{WebExtAPIRef("sessions.setTabValue()")}}.

+ +

Types

+ +
+
{{WebExtAPIRef("tabs.MutedInfoReason")}}
+
Specifies the reason a tab was muted or unmuted.
+
{{WebExtAPIRef("tabs.MutedInfo")}}
+
This object contains a boolean indicating whether the tab is muted, and the reason for the last state change.
+
{{WebExtAPIRef("tabs.PageSettings")}}
+
+

Used to control how a tab is rendered as a PDF by the tabs.saveAsPDF() method.

+
+
{{WebExtAPIRef("tabs.Tab")}}
+
This type contains information about a tab.
+
{{WebExtAPIRef("tabs.TabStatus")}}
+
Indicates whether the tab has finished loading.
+
{{WebExtAPIRef("tabs.WindowType")}}
+
The type of window that hosts this tab.
+
{{WebExtAPIRef("tabs.ZoomSettingsMode")}}
+
Defines whether zoom changes are handled by the browser, by the extension, or are disabled.
+
{{WebExtAPIRef("tabs.ZoomSettingsScope")}}
+
Defines whether zoom changes will persist for the page's origin, or only take effect in this tab.
+
{{WebExtAPIRef("tabs.ZoomSettings")}}
+
Defines zoom settings {{WebExtAPIRef("tabs.ZoomSettingsMode", "mode")}}, {{WebExtAPIRef("tabs.ZoomSettingsScope", "scope")}}, and default zoom factor.
+
+ +

Properties

+ +
+
{{WebExtAPIRef("tabs.TAB_ID_NONE")}}
+
A special ID value given to tabs that are not browser tabs (for example, tabs in devtools windows).
+
+ +

Functions

+ +
+
{{WebExtAPIRef("tabs.captureTab()")}}
+
Creates a data URI encoding an image of the visible area of the given tab.
+
{{WebExtAPIRef("tabs.captureVisibleTab()")}}
+
Creates a data URI encoding an image of the visible area of the currently active tab in the specified window.
+
{{WebExtAPIRef("tabs.connect()")}}
+
Sets up a messaging connection between the extension's background scripts (or other privileged scripts, such as popup scripts or options page scripts) and any content scripts running in the specified tab.
+
{{WebExtAPIRef("tabs.create()")}}
+
Creates a new tab.
+
{{WebExtAPIRef("tabs.detectLanguage()")}}
+
Detects the primary language of the content in a tab.
+
{{WebExtAPIRef("tabs.discard()")}}
+
Discards one or more tabs.
+
{{WebExtAPIRef("tabs.duplicate()")}}
+
Duplicates a tab.
+
{{WebExtAPIRef("tabs.executeScript()")}}
+
Injects JavaScript code into a page.
+
{{WebExtAPIRef("tabs.get()")}}
+
Retrieves details about the specified tab.
+
{{WebExtAPIRef("tabs.getAllInWindow()")}} {{deprecated_inline}}
+
Gets details about all tabs in the specified window.
+
{{WebExtAPIRef("tabs.getCurrent()")}}
+
Gets information about the tab that this script is running in, as a tabs.Tab object.
+
{{WebExtAPIRef("tabs.getSelected()")}} {{deprecated_inline}}
+
Gets the tab that is selected in the specified window. Deprecated: use tabs.query({active: true}) instead.
+
{{WebExtAPIRef("tabs.getZoom()")}}
+
Gets the current zoom factor of the specified tab.
+
{{WebExtAPIRef("tabs.getZoomSettings()")}}
+
Gets the current zoom settings for the specified tab.
+
{{WebExtAPIRef("tabs.goForward()")}}
+
Go forward to the next page, if one is available.
+
{{WebExtAPIRef("tabs.goBack()")}}
+
Go back to the previous page, if one is available.
+
{{WebExtAPIRef("tabs.hide()")}} {{experimental_inline}}
+
Hides one or more tabs.
+
{{WebExtAPIRef("tabs.highlight()")}}
+
Highlights one or more tabs.
+
{{WebExtAPIRef("tabs.insertCSS()")}}
+
Injects CSS into a page.
+
{{WebExtAPIRef("tabs.move()")}}
+
Moves one or more tabs to a new position in the same window or to a different window.
+
{{WebExtApiRef("tabs.moveInSuccession()")}}
+
Modifies the succession relationship for a group of tabs.
+
{{WebExtAPIRef("tabs.print()")}}
+
Prints the contents of the active tab.
+
{{WebExtAPIRef("tabs.printPreview()")}}
+
+
Opens print preview for the active tab.
+
+
{{WebExtAPIRef("tabs.query()")}}
+
Gets all tabs that have the specified properties, or all tabs if no properties are specified.
+
{{WebExtAPIRef("tabs.reload()")}}
+
Reload a tab, optionally bypassing the local web cache.
+
{{WebExtAPIRef("tabs.remove()")}}
+
Closes one or more tabs.
+
{{WebExtAPIRef("tabs.removeCSS()")}}
+
Removes from a page CSS which was previously injected by calling {{WebExtAPIRef("tabs.insertCSS()")}}.
+
{{WebExtAPIRef("tabs.saveAsPDF()")}}
+
Saves the current page as a PDF.
+
{{WebExtAPIRef("tabs.sendMessage()")}}
+
Sends a single message to the content script(s) in the specified tab.
+
{{WebExtAPIRef("tabs.sendRequest()")}} {{deprecated_inline}}
+
Sends a single request to the content script(s) in the specified tab. Deprecated: use {{WebExtAPIRef("tabs.sendMessage()")}} instead.
+
{{WebExtAPIRef("tabs.setZoom()")}}
+
Zooms the specified tab.
+
{{WebExtAPIRef("tabs.setZoomSettings()")}}
+
Sets the zoom settings for the specified tab.
+
{{WebExtAPIRef("tabs.show()")}} {{experimental_inline}}
+
Shows one or more tabs that have been {{WebExtAPIRef("tabs.hide()", "hidden")}}.
+
{{WebExtAPIRef("tabs.toggleReaderMode()")}}
+
Toggles Reader mode for the specified tab.
+
{{WebExtAPIRef("tabs.update()")}}
+
Navigate the tab to a new URL, or modify other properties of the tab.
+
+ +

Events

+ +
+
{{WebExtAPIRef("tabs.onActivated")}}
+
Fires when the active tab in a window changes. Note that the tab's URL may not be set at the time this event fired.
+
{{WebExtAPIRef("tabs.onActiveChanged")}} {{deprecated_inline}}
+
Fires when the selected tab in a window changes. Deprecated: use {{WebExtAPIRef("tabs.onActivated")}} instead.
+
{{WebExtAPIRef("tabs.onAttached")}}
+
Fired when a tab is attached to a window, for example because it was moved between windows.
+
{{WebExtAPIRef("tabs.onCreated")}}
+
Fired when a tab is created. Note that the tab's URL may not be set at the time this event fired.
+
{{WebExtAPIRef("tabs.onDetached")}}
+
Fired when a tab is detached from a window, for example because it is being moved between windows.
+
{{WebExtAPIRef("tabs.onHighlightChanged")}} {{deprecated_inline}}
+
Fired when the highlighted or selected tabs in a window change. Deprecated: use {{WebExtAPIRef("tabs.onHighlighted")}} instead.
+
{{WebExtAPIRef("tabs.onHighlighted")}}
+
Fired when the highlighted or selected tabs in a window change.
+
{{WebExtAPIRef("tabs.onMoved")}}
+
Fired when a tab is moved within a window.
+
{{WebExtAPIRef("tabs.onRemoved")}}
+
Fired when a tab is closed.
+
{{WebExtAPIRef("tabs.onReplaced")}}
+
Fired when a tab is replaced with another tab due to prerendering.
+
{{WebExtAPIRef("tabs.onSelectionChanged")}} {{deprecated_inline}}
+
Fires when the selected tab in a window changes. Deprecated: use {{WebExtAPIRef("tabs.onActivated")}} instead.
+
{{WebExtAPIRef("tabs.onUpdated")}}
+
Fired when a tab is updated.
+
{{WebExtAPIRef("tabs.onZoomChange")}}
+
Fired when a tab is zoomed.
+
+ +

Browser compatibility

+ + + +

{{Compat("webextensions.api.tabs")}}

+ +

{{WebExtExamples("h2")}}

+ +
Acknowledgements + +

This API is based on Chromium's chrome.tabs API. This documentation is derived from tabs.json in the Chromium code.

+ +

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

+
+ + diff --git a/files/pt-br/mozilla/add-ons/webextensions/api/tema/index.html b/files/pt-br/mozilla/add-ons/webextensions/api/tema/index.html new file mode 100644 index 0000000000..4eb0dc1b8d --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/api/tema/index.html @@ -0,0 +1,55 @@ +--- +title: tema +slug: Mozilla/Add-ons/WebExtensions/API/tema +tags: + - Aplicativo + - Extensões + - Navegador + - Tema + - Temas + - add-on + - extensão +translation_of: Mozilla/Add-ons/WebExtensions/API/theme +--- +
{{AddonSidebar}}
+ +

Permite que extensões do navegador alterem seu tema.

+ +

Para usar esta API, uma extensão deve solicitar a permission (permissão) de "tema" em seu arquivo manifest.json.

+ +
+

Nota: Quando configuramos um arquivo de plano de fundo, devemos declarar a permission (permissão) de "tema" e, assim sendo, nós não poderemos usar a função theme  (de tema), se esta for incompatível.

+
+ +

Tipo

+ +
+
{{WebExtAPIRef("theme.Theme")}}
+
Representa o conteúdo de um tema.
+
+ +

Funções

+ +
+
{{WebExtAPIRef("theme.getCurrent()")}}
+
Obtém o tema atual do navegador.
+
{{WebExtAPIRef("theme.update()")}}
+
Atualiza o tema do navegador.
+
{{WebExtAPIRef("theme.reset()")}}
+
Remove quaisquer atualizações de temas feitas em uma chamada para {{WebExtAPIRef("theme.update()")}}.
+
+ +

Evento

+ +
+
{{WebExtAPIRef("theme.onUpdated")}}
+
Disparada quando o navegador tiver sido alterado.
+
+ +

Compatibilidade

+ + + +

{{Compat("webextensions.api.theme")}}

+ +

{{WebExtExamples("h2")}}

diff --git a/files/pt-br/mozilla/add-ons/webextensions/browser_support_for_javascript_apis/index.html b/files/pt-br/mozilla/add-ons/webextensions/browser_support_for_javascript_apis/index.html new file mode 100644 index 0000000000..4333baf5b1 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/browser_support_for_javascript_apis/index.html @@ -0,0 +1,15 @@ +--- +title: Browser support for JavaScript APIs +slug: Mozilla/Add-ons/WebExtensions/Browser_support_for_JavaScript_APIs +translation_of: Mozilla/Add-ons/WebExtensions/Browser_support_for_JavaScript_APIs +--- +
{{AddonSidebar}}
+ +
{{WebExtAllCompatTables}}
+ + + +
Acknowledgements + +

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

+
diff --git a/files/pt-br/mozilla/add-ons/webextensions/empacotando_e_instalando/index.html b/files/pt-br/mozilla/add-ons/webextensions/empacotando_e_instalando/index.html new file mode 100644 index 0000000000..2b210f5125 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/empacotando_e_instalando/index.html @@ -0,0 +1,94 @@ +--- +title: Empacotando e Instalando +slug: Mozilla/Add-ons/WebExtensions/Empacotando_e_instalando +translation_of: Mozilla/Add-ons/WebExtensions/Temporary_Installation_in_Firefox +--- +

Packaging your extension

+ +
+

Nós estamos trabalhando em uma GUI  para empacotar e carregar extensões. Veja Bug 1185460 para mais informações. Enquanto isso, siga as etapas abaixo.

+
+ +

Firefox extensões são empacotados como arquivos XPI, que nada mais são arquivos ZIP mas com extensão ".xpi".

+ +

Uma dica para empacotar o arquivo você precisa "zipar" todos os arquivos que está na root do seu diretório.

+ +

Windows

+ +
    +
  1. Abra a pasta com seus arquivos da extensão.
    2. +
  2. Selecione todos os arquivos.
    3. +
  3. Clique com o direito e escolha Enviar para → Pasta Compactada.
    4. +
  4. Renomeie o arquivo de "something.zip" para "something.xpi".
    5. +
+ +

+ +

Mac OS X

+ +
    +
  1. Abra a pasta com seus arquivos da extensão.
    2. +
  2. Selecione todos os arquivos.
    3. +
  3. Clique com o direito e escolha Compress n Items.
    4. +
  4. Renomeie o arquivo de Archive.zip para something.xpi.
    5. +
+ +

+ +

Linux / Mac OS X Terminal

+ +
    +
  1. cd path/to/my-extension/
    2. +
  2. zip -r ../my-extension.xpi *
    3. +
+ +

Installing your extension

+ +
    +
  1. Digite no caminho de URL about:addons
    2. +
  2. Clique e araste o arquivo XPI para dentro da página, ou abra o menu de ferramentas e escolha "Install Add-On From File..."
    3. +
  3. Clique instalar no dialog que irá aparecer
    4. +
+ +

Instalando suas extensões no Firefox OS

+ +

You can install your extension from WebIDE running on a Desktop connected via USB or Wifi. Open "path/to/my-extension/" as a Packaged App in WebIDE.

+ +

When the manifest.json validation status is valid you will be able to Install and Run your extension on the attached Firefox OS device running a nightly build of Firefox OS.

+ +

The extension will first have to be enabled in Settings->Add-ons on the Firefox OS device.

+ +

Soluções de problemas

+ +

There are a few common problems that you might run into:

+ +

"Este add-on não poderá ser instalado porque não pode ser verificado."

+ + + +

"Este add-on não pode ser instalado porque pode está corrompido."

+ + + +

Nada aconteceu

+ + + +

Observe o console

+ +

Some additional error information relating to how your extension was extracted and loaded might be available in the Browser Console.

diff --git a/files/pt-br/mozilla/add-ons/webextensions/examples/index.html b/files/pt-br/mozilla/add-ons/webextensions/examples/index.html new file mode 100644 index 0000000000..3b0c265377 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/examples/index.html @@ -0,0 +1,30 @@ +--- +title: Exemplos de Extensões +slug: Mozilla/Add-ons/WebExtensions/Examples +tags: + - WebExntesoes +translation_of: Mozilla/Add-ons/WebExtensions/Examples +--- +
{{AddonSidebar}}
+ +
Para ajudar a ilustrar como desenvolver extensões, nós mantemos um repositório com simples exemplos de extensões em https://github.com/mdn/webextensions-examples. Este artigo descreve a WebExtension APIs utilizadas neste respositório.
+ +
 
+ +
Estes exemplos funcionam no Firefox Nightly: A maioria funciona em versões anteriores do Firefox, porém verifique a chave strict_min_version no manifest.json da extensão por certificação.
+ +
 
+ +
Se você quiser experimentar estes exemplos, você tem três opções principais:
+ +
 
+ +
    +
  1. Clonar o repositório, então carregue a extensão diretamente de seu diretório de origem, usando o recurso "Load Temporary Add-on".  A extensão permanecerá carregada até você reiniciar o Firefox.
    2. +
  2. Clonar o repositório, então use a ferramenta linha de comando web-ext para executar o Firefox com a extensão instalada.
    3. +
  3. Clonar o repositório, então vá até o diretório de build (construção). Isto contém as versões construídas e assinadas de todos os exemplos, então você pode simplesmente abrir eles no Firefox (usando Arquivo/Abrir arquivo) e instalar eles permanentemente, como uma extensão que você pode instalar de addons.mozilla.org.
    4. +
+ +

Se você quer contribuir com o respositório, nos envie um pull request.

+ +

{{WebExtAllExamples}}

diff --git a/files/pt-br/mozilla/add-ons/webextensions/index.html b/files/pt-br/mozilla/add-ons/webextensions/index.html new file mode 100644 index 0000000000..862d00ba21 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/index.html @@ -0,0 +1,138 @@ +--- +title: Extensões do navegador +slug: Mozilla/Add-ons/WebExtensions +tags: + - Extensões + - Passo a passo + - WebExtension +translation_of: Mozilla/Add-ons/WebExtensions +--- +

Extensões são capazes de extender e modificar a capacidade de um navegador. As extensões para Firefox são criadas usando a API WebExtensions, um sistema comum a vários navegadores para desenvolvimento de extensões. Em grande parte, o sistema é compatível com a API de extensões suportada pelo Google Chrome, Opera e W3C Draft Community Group.

+ +

Extensões escritas para esses navegadores na maioria dos casos vão funcionar no Firefox ou Microsoft Edge com apenas algumas alterações. A API é também totalmente compatível com o multiprocessamento do Firefox.

+ +

Se você tem dúvidas ou sugestões, ou precisa de ajuda para migrar um complemento legado para usar APIs WebExtensions, pode entrar em contato conosco pela newsletter de desenvolvimento de complementos ou #webextensions no IRC.

+ +
+
+

Começando

+ + + +

Conceitos

+ + + +

Interface do usuário

+ + + +

Como

+ + + +

Portabilidade

+ + + +

Fluxo de trabalho do Firefox

+ + +
+ +
+

Referências

+ +

APIs JavaScript

+ + + +
{{ ListSubpages ("/en-US/Add-ons/WebExtensions/API") }}
+ +

Chaves do Manifest

+ + + +
{{ ListSubpages ("/Add-ons/WebExtensions/manifest.json") }}
+
+
+ + + +
{{AddonSidebar}}
diff --git a/files/pt-br/mozilla/add-ons/webextensions/intercept_http_requests/index.html b/files/pt-br/mozilla/add-ons/webextensions/intercept_http_requests/index.html new file mode 100644 index 0000000000..f79b4debaa --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/intercept_http_requests/index.html @@ -0,0 +1,155 @@ +--- +title: Interceptando requisições HTTP +slug: Mozilla/Add-ons/WebExtensions/Intercept_HTTP_requests +translation_of: Mozilla/Add-ons/WebExtensions/Intercept_HTTP_requests +--- +
{{AddonSidebar}}
+ +

Para interceptar uma requisição HTTP, utilize a API {{WebExtAPIRef("webRequest")}}. Esta API permite adicionar listeners para vários estágios de uma requisição HTTP. Nos listeners, você pode:

+ + + +

Neste artigo você verá três diferentes usos para o módulo webRequest:

+ + + +

Logando URLs de requisição

+ +

Crie um novo diretório chamado "requests". Neste diretório, crie um arquivo chamado "manifest.json" com seguinte conteúdo:

+ +
{
+  "description": "Demonstrating webRequests",
+  "manifest_version": 2,
+  "name": "webRequest-demo",
+  "version": "1.0",
+
+  "permissions": [
+    "webRequest",
+    "<all_urls>"
+  ],
+
+  "background": {
+    "scripts": ["background.js"]
+  }
+}
+ +

A seguir, crie um arquivo chamado"background.js" com o seguinte conteúdo:

+ +
function logURL(requestDetails) {
+  console.log("Loading: " + requestDetails.url);
+}
+
+browser.webRequest.onBeforeRequest.addListener(
+  logURL,
+  {urls: ["<all_urls>"]}
+);
+
+
+ +

Aqui vamos usar {{WebExtAPIRef("webRequest.onBeforeRequest", "onBeforeRequest")}} para chamar a função logURL() antes do inicio da requisição. A função logURL() guarda a URL da requisição para o objeto event e efetua log no console do navegador. O padrão {urls: ["<all_urls>"]} significa que iremos interceptar as requisições HTTP para todas URLs.

+ +

Para testá-lo, instale a extensão, abra o console do navegador, e abra alguma página da internet. No console do navegador você pode ver as URLs para alguns recursos que o navegador requisita:

+ +

{{EmbedYouTube("X3rMgkRkB1Q")}}

+ +

Redirecionando requisições

+ +

Agora vamos usar o webRequest para redirecionar requisições HTTP. Primeiro, substitua o manifest.json com o seguinte conteúdo:

+ +
{
+
+  "description": "Demonstrating webRequests",
+  "manifest_version": 2,
+  "name": "webRequest-demo",
+  "version": "1.0",
+
+  "permissions": [
+    "webRequest",
+    "webRequestBlocking",
+    "https://developer.mozilla.org/",
+    "https://mdn.mozillademos.org/"
+  ],
+
+  "background": {
+    "scripts": ["background.js"]
+  }
+
+}
+ +

A única alteração aqui é a adição da permissão "webRequestBlocking". Precisamos invocar esta permissão extra toda vez que estamos ativamente modificando a requisição.

+ +

A seguir, substitua o "background.js" com o seguinte conteúdo:

+ +
var pattern = "https://mdn.mozillademos.org/*";
+
+function redirect(requestDetails) {
+  console.log("Redirecting: " + requestDetails.url);
+  return {
+    redirectUrl: "https://38.media.tumblr.com/tumblr_ldbj01lZiP1qe0eclo1_500.gif"
+  };
+}
+
+browser.webRequest.onBeforeRequest.addListener(
+  redirect,
+  {urls:[pattern], types:["image"]},
+  ["blocking"]
+);
+ +

Novamente vamos usar event listener {{WebExtAPIRef("webRequest.onBeforeRequest", "onBeforeRequest")}} apenas para executar a função antes que cada requisição seja feita. Está função irá substituir a URL desejada com o redirectUrl especificado na função.

+ +

Desta vez não estamos interceptando cada requisição: a opção {urls:[pattern], types:["image"]} especifica apenas o que deveria interceptar requisições(1) para URLs residindo sob o "https://mdn.mozillademos.org/" (2) para o recurso de imagens. Veja mais em {{WebExtAPIRef("webRequest.RequestFilter")}}.

+ +

Observe também que estamos passando uma opção chamada "blocking": precisamos informá-la toda vez que desejamos modificar a requisição. Isto faz com que a função bloqueie a requisição de rede, então o navegador espera pelo event listener retornar antes de continuar. Veja a documentação {{WebExtAPIRef("webRequest.onBeforeRequest")}} para mais no "blocking".

+ +

Teste abrindo uma página no MDN que possua muitas imagens (por exemplo https://developer.mozilla.org/en-US/docs/Tools/Network_Monitor), recarregue a extensão e então recarregue a página:

+ +

{{EmbedYouTube("ix5RrXGr0wA")}}

+ +

Modificando os cabeçalhos da requisição

+ +

Finalmente iremos utilizar webRequest para modificar os cabeçalhos da requisição. Neste example iremos modificar o cabeçalho "User-Agent" que identifica o navegador como Opera 12.16, mas apenas quando visitamos páginas sob "http://useragentstring.com/".

+ +

O "manifest.json" pode permanecer do mesmo jeito.

+ +

Modifique o "background.js" com este código:

+ +
var targetPage = "http://useragentstring.com/*";
+
+var ua = "Opera/9.80 (X11; Linux i686; Ubuntu/14.10) Presto/2.12.388 Version/12.16";
+
+function rewriteUserAgentHeader(e) {
+  e.requestHeaders.forEach(function(header){
+    if (header.name.toLowerCase() == "user-agent") {
+      header.value = ua;
+    }
+  });
+  return {requestHeaders: e.requestHeaders};
+}
+
+browser.webRequest.onBeforeSendHeaders.addListener(
+  rewriteUserAgentHeader,
+  {urls: [targetPage]},
+  ["blocking", "requestHeaders"]
+);
+ +

Aqui vamos usar event listener {{WebExtAPIRef("webRequest.onBeforeSendHeaders", "onBeforeSendHeaders")}} para executar a função somente quando os cabeçalhos forem enviados.

+ +

O event listener será chamada somente para requisitar as URLs que batem com o padrão. Observe também que  passamos novamente "blocking" como uma opção. Passamos também "requestHeaders", que significa que o listener será passado como um array contendo os cabeçalhos da requisição que desejamos enviar. Veja {{WebExtAPIRef("webRequest.onBeforeSendHeaders")}} para mais informações dessas opções.

+ +

A função listener procura pelo cabeçalho "User-Agent" no array de cabeçalhos da requisição, substitui seu valor com o valor ua da variável, e retorna o array modificado. Este array modificado será agora enviado para o servidor.

+ +

Teste abrindo useragentstring.com e veja como ele identifica o navegador como sendo o Firefox. Então, recarregue a extensão, recarregue também o useragentstring.com e veja que agora o Firefox é identificado como Opera:

+ +

{{EmbedYouTube("SrSNS1-FIx0")}}

+ +

Aprenda mais

+ +

Para aprender sobre todas as coisas que você pode fazer com a API webRequest, veja sua documentação de referência.

diff --git a/files/pt-br/mozilla/add-ons/webextensions/manifest.json/index.html b/files/pt-br/mozilla/add-ons/webextensions/manifest.json/index.html new file mode 100644 index 0000000000..b8f93649d2 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/manifest.json/index.html @@ -0,0 +1,105 @@ +--- +title: manifest.json +slug: Mozilla/Add-ons/WebExtensions/manifest.json +tags: + - Add-ons + - Extensions + - NeedsTranslation + - TopicStub + - WebExtensions +translation_of: Mozilla/Add-ons/WebExtensions/manifest.json +--- +
{{AddonSidebar}}
+ +

The manifest.json file is a JSON-formatted file, and is the only file that every WebExtension must contain.

+ +

Using manifest.json, you specify basic metadata about your extension such as the name and version, and can also specify aspects of your extension's functionality, such as background scripts, content scripts, and browser actions.

+ +

manifest.json keys are listed below:

+ +
{{ ListSubpages ("/en-US/Add-ons/WebExtensions/manifest.json") }}
+ +
 
+ +

"manifest_version", "version", and "name" are the only mandatory keys. "default_locale" must be present if the "_locales" directory is present and must be absent otherwise. "applications" is not supported in Google Chrome, and is mandatory in Firefox before Firefox 48 and Firefox for Android.

+ +

Browser compatibility

+ +

{{Compat("webextensions.manifest")}}

+ +

Example

+ +

Quick syntax example for manifest.json:

+ +
{
+  "applications": {
+    "gecko": {
+      "id": "addon@example.com",
+      "strict_min_version": "42.0"
+    }
+  },
+
+  "background": {
+    "scripts": ["jquery.js", "my-background.js"],
+    "page": "my-background.html"
+  },
+
+  "browser_action": {
+    "default_icon": {
+      "19": "button/geo-19.png",
+      "38": "button/geo-38.png"
+    },
+    "default_title": "Whereami?",
+    "default_popup": "popup/geo.html"
+  },
+
+  "commands": {
+    "toggle-feature": {
+      "suggested_key": {
+        "default": "Ctrl+Shift+Y",
+        "linux": "Ctrl+Shift+U"
+      },
+      "description": "Send a 'toggle-feature' event"
+    }
+  },
+
+  "content_security_policy": "script-src 'self' https://example.com; object-src 'self'",
+
+  "content_scripts": [
+    {
+      "exclude_matches": ["*://developer.mozilla.org/*"],
+      "matches": ["*://*.mozilla.org/*"],
+      "js": ["borderify.js"]
+    }
+  ],
+
+  "default_locale": "en",
+
+  "description": "...",
+
+  "icons": {
+    "48": "icon.png",
+    "96": "icon@2x.png"
+  },
+
+  "manifest_version": 2,
+
+  "name": "...",
+
+  "page_action": {
+    "default_icon": {
+      "19": "button/geo-19.png",
+      "38": "button/geo-38.png"
+    },
+    "default_title": "Whereami?",
+    "default_popup": "popup/geo.html"
+  },
+
+  "permissions": ["webNavigation"],
+
+  "version": "0.1",
+
+  "web_accessible_resources": ["images/my-image.png"]
+}
+ +

 

diff --git "a/files/pt-br/mozilla/add-ons/webextensions/manifest.json/permiss\303\265es/index.html" "b/files/pt-br/mozilla/add-ons/webextensions/manifest.json/permiss\303\265es/index.html" new file mode 100644 index 0000000000..41312323b4 --- /dev/null +++ "b/files/pt-br/mozilla/add-ons/webextensions/manifest.json/permiss\303\265es/index.html" @@ -0,0 +1,184 @@ +--- +title: permissões +slug: Mozilla/Add-ons/WebExtensions/manifest.json/permissões +translation_of: Mozilla/Add-ons/WebExtensions/manifest.json/permissions +--- +
{{AddonSidebar}}
+ + + + + + + + + + + + + + + + +
TipoArray
ObrigatórioNão
Examplo + 
+"permissions": [
+  "*://developer.mozilla.org/*",
+  "webRequest"
+]
+
+ +

Use a chave permissions para solicitar privilégios especiais para sua extensão. Esta chave é um array de strings, onde cada string é uma solicitação para uma permissão.

+ +

Se você solicitar permissões usando esta chave, o navegador poderá informar ao usuário que a extensão a ser instalada está solicitando certos privilégios, e perguntar se aceita ou não conceder esses privilégios. O navegador também poderá permitir que o usuário inspecione os privilégios de uma extensão depois que essa for instalada.

+ +

A chave pode conter três tipos de permissões:

+ + + +

Permissões de servidor (host)

+ +

Permissões de servidor são espscificadas como match patterns. Cada pattern identifica um grupo de URLs para os quais a extensão solicita privilégios adicionais. Por exemplo, uma permissão de servidor poderia ser "*://developer.mozilla.org/*".

+ +

Os privilégios adicionais incluem:

+ + + +

No Firefox, da versão 56 em diante, extensões recebem automaticamente permissões de servidor para sua própria origem, que é na forma:

+ +
moz-extension://60a20a9b-1ad4-af49-9b6c-c64c98c37920/
+ +

onde 60a20a9b-1ad4-af49-9b6c-c64c98c37920 é o ID interno da extensão. A extensão pode obter essa URL programaticamente chamando extension.getURL():

+ +
browser.extension.getURL("");
+// moz-extension://60a20a9b-1ad4-af49-9b6c-c64c98c37920/
+ +

Permissões de API

+ +

Permissões de API são especificadas como palavras-chave. Cada palavra-chave nomeia uma API WebExtension que a extensão gostaria de usar.

+ +

As seguintes palavras-chave estão atualmente disponíveis:

+ + + +

Na maioria dos casos, a permissão apenas concede acesso à API, com as seguintes exceções:

+ + + +

Permissão activeTab (aba ativa)

+ +

Esta permissão é especificada como "activeTab". Se uma extensão tem a permissão activeTab, quando o usuário interage com a extensão, a extensão recebe privilégios adicionais somente para a aba ativa.

+ +

"Interação do usuário" inclui:

+ + + +

Os privilégios adicionais são:

+ + + +

A intenção desta permissão é permitir que extensões executem um caso de uso comum, sem ter que lhes dar permissões poderosas demais. Muitas extensões querem "fazer alguma coisa com a página atual quando o usuário pede". Por exemplo, considere uma extensão que queira executar um script na página atual quando o usuário clicar em uma ação do navegador. Se a permissão  activeTab não existisse, a extensão precisaria pedir a permissão de servidor <all_urls>. Mas isso daria à extensão mais poder que o necessário: ela poderia executar scripts em qualquer aba e quando quisesse, em vez de apenas na aba atual e somente em resposta a uma ação do usuário.

+ +

Note que você só pode ter acesso à aba ou dado que estava ali, quando a interação do usuário ocorreu (por exemplo, um clique do mouse). Quando a aba ativa muda para outra página, por exemplo devido a concluir o carregamento ou algum outro evento, a permissão não lhe concede mais acesso à aba.

+ +

Normalmente, a aba a qual foi concedido activeTab é somente a aba ativa atual, exceto em um caso. A API menus permite a uma extensão criar um item de menu que é exibido se o usuário abrir o menu de contexto sobre uma aba (ou seja, no elemento na lista de abas que permite ao usuário mudar de uma aba para outra). Se o usuário clicar em um item desses, a permissão activeTab é concedida para a aba em que o usuário clicou, mesmo que essa não seja a aba ativa no momento (de acordo com Firefox 63, {{bug(1446956)}}).

+ +

Acesso à área de transferência

+ +

Existem duas permissões que permitem à extensão interagir com a área de transferência:

+ + + +

Consulte Interação com a área de transferência para saber todos os detalhes sobre isso.

+ +

Armazenamento ilimitado

+ +

A permissão unlimitedStorage:

+ + + +

Examplos

+ +
 "permissions": ["*://developer.mozilla.org/*"]
+ +

Solicita acesso privilegiado a páginas sob developer.mozilla.org.

+ +
  "permissions": ["tabs"]
+ +

Solicita acesso a partes privilegiadas da API tabs.

+ +
  "permissions": ["*://developer.mozilla.org/*", "tabs"]
+ +

Solicita ambas as permissões anteriores.

+ +

Compatibilidade com navegadores

+ + + +

{{Compat("webextensions.manifest.permissions")}}

diff --git a/files/pt-br/mozilla/add-ons/webextensions/manifest.json/short_name/index.html b/files/pt-br/mozilla/add-ons/webextensions/manifest.json/short_name/index.html new file mode 100644 index 0000000000..10566678d3 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/manifest.json/short_name/index.html @@ -0,0 +1,43 @@ +--- +title: short_name +slug: Mozilla/Add-ons/WebExtensions/manifest.json/short_name +tags: + - Manifesto + - Sort name +translation_of: Mozilla/Add-ons/WebExtensions/manifest.json/short_name +--- +
{{AddonSidebar}}
+ + + + + + + + + + + + + + + + +
TipoString
ObrigatórioNo
Exemplo + 
+"short_name": "Minha Extensão"
+
+ +

Nome abreviado (short name) da extensão. Se informado, ele será usado em contextos onde o campo de nome for muito longo. É recomendado que o nome abreviado não deva exceder 12 caracteres. Se o campo do nome abreviado não for incluído no manifest.json, então o nome será usado em vez disso e pode ser truncado. 

+ +

Isto é um propriedade localizável.

+ +

Exemplo

+ +
"short_name": "Minha Extensão"
+ +

Compatibilidade de navegadores

+ + + +

{{Compat("webextensions.manifest.short_name")}}

diff --git a/files/pt-br/mozilla/add-ons/webextensions/manifest.json/web_accessible_resources/index.html b/files/pt-br/mozilla/add-ons/webextensions/manifest.json/web_accessible_resources/index.html new file mode 100644 index 0000000000..9d13e7e72c --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/manifest.json/web_accessible_resources/index.html @@ -0,0 +1,97 @@ +--- +title: web_accessible_resources +slug: Mozilla/Add-ons/WebExtensions/manifest.json/web_accessible_resources +tags: + - Add-ons + - Extensões +translation_of: Mozilla/Add-ons/WebExtensions/manifest.json/web_accessible_resources +--- +

{{AddonSidebar}}

+ + + + + + + + + + + + + + + + +
TipoArray
ObrigatórioNo
Exemplo + 
+"web_accessible_resources": [
+  "images/my-image.png"
+]
+
+ +

Descrição

+ +

As vezes, você precisa empacotar recursos — por exemplo, imagens, HTML, CSS ou Javascript — com a sua extensão e fazê-la acessível para as páginas web.

+ +

Por exemplo, a extensão de exemplo Beastify substitui uma página por uma imagem de um animal selecionado pelo usuário. As imagens foram empacotadas com a extensão. Para fazer visível a imagem selecionada, a extensão adiciona elementos <img> cujo atributo src aponta para a imagem do animal. Para que a página da web possa carregar as imagens, elas devem estar disponíveis na extensão.

+ +

With the web_accessible_resources key, you list all the packaged resources that you want to make available to web pages. You specify them as paths relative to the manifest.json file.

+ +

Note that content scripts don't need to be listed as web accessible resources.

+ +

If an extension wants to use {{WebExtAPIRef("webRequest")}} to redirect a public URL (e.g., HTTPS) to a page that's packaged in the extension, then the extension must list the page in the web_accessible_resources key.

+ +

Using web_accessible_resources

+ +

For example, suppose your extension includes an image file at images/my-image.png, like this:

+ +
my-extension-files/
+    manifest.json
+    my-background-script.js
+    images/
+        my-image.png
+ +

To enable a web page to use an <img> element whose src attribute points to this image, you would specify web_accessible_resources like this:

+ +
"web_accessible_resources": ["images/my-image.png"]
+ +

The file is then available using a URL like:

+ +
moz-extension://<extension-UUID>/images/my-image.png"
+ +

<extension-UUID> is not your extension's ID. This ID is randomly generated for every browser instance. This prevents websites from fingerprinting a browser by examining the extensions it has installed.

+ +
+

In Chrome, an extension's ID is fixed. When a resource is listed in web_accessible_resources, it is accessible as chrome-extension://<your-extension-id>/<path/to/resource>.  

+
+ +

The recommended approach to obtaining the URL of the resource is to use runtime.getURL passing the path relative to manifest.json, for example:

+ +
browser.runtime.getURL("images/my-image.png");
+// something like:
+// moz-extension://944cfddf-7a95-3c47-bd9a-663b3ce8d699/images/my-image.png
+ +

This approach gives you have the correct URL regardless of the browser your extension is running on.

+ +

Wildcards

+ +

web_accessible_resources entries can contain wildcards. For example, the following entry would also work to include the resource at "images/my-image.png":

+ +
  "web_accessible_resources": ["images/*.png"]
+ +

Security

+ +

Note that if you make a page web-accessible, any website may link or redirect to that page. The page should then treat any input (POST data, for examples) as if it came from an untrusted source, just as a normal web page should.

+ +

Example

+ +
"web_accessible_resources": ["images/my-image.png"]
+ +

Make the file at "images/my-image.png" web accessible.

+ +

Browser compatibility

+ + + +

{{Compat("webextensions.manifest.web_accessible_resources")}}

diff --git a/files/pt-br/mozilla/add-ons/webextensions/o_que_vem_a_seguir_/index.html b/files/pt-br/mozilla/add-ons/webextensions/o_que_vem_a_seguir_/index.html new file mode 100644 index 0000000000..7050516e82 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/o_que_vem_a_seguir_/index.html @@ -0,0 +1,56 @@ +--- +title: O que vem a seguir ? +slug: Mozilla/Add-ons/WebExtensions/O_que_vem_a_seguir_ +translation_of: Mozilla/Add-ons/WebExtensions/What_next_ +--- +
{{AddonSidebar}}
+ +

Você está pronto para começar a tornar a tua ideia de extensão de navegador uma realidade. Antes de iniciar essa jornada, vale a pena estar ciente de algumas coisas que te ajudarão a torná-la tranquila.

+ +

Teu ambiente de desenvolvimento

+ +

Você não precisa de ferramentas de desenvolvimento especiais para criar extensões de navegador: é inteiramente possível criar ótimas extensões de navegador sem mais que um editor de textos. Porém, talvez você tenha desenvolvido para a web e tenha um conjunto de ferramentas e um ambiente que quer usar. Se for assim, você precisa estar ciente de algumas coisas.

+ +

Se você usa ferramentas de minificação ou obfuscação para entregar seu código final, você precisará entregar seu código fonte para o processo de revisão AMO. Além disso, as ferramentas que você utiliza, — para minificação,  obfuscação e contrução — devem ser open source ( ou oferecer uso gratuito sem limites ) e disponíveis para execução no computador do revisor (Windows, Mac ou Linux). Infelizmente, nossos revisores não podem trabalhar com ferramentas comerciais ou baseadas em web.

+ +

Aprenda mais acerca de ferramentas de construção

+ +

Third-party libraries

+ +

Third-party libraries are a great way to add complex features or functionality to your browser extensions quickly. When you submit an extension to the AMO review process, the process will also consider any third-party libraries used. To streamline the review, make sure you always download third-party libraries from their official website or repository, and if the library is minified provide a link to the source code. Please note that third-party libraries cannot be modified in any way.

+ +

Learn more about submitting source code

+ +

The Firefox Add-on Distribution Agreement

+ +

Browser extensions need to be signed to install into the release or beta versions of Firefox. Signing takes place in addons.mozilla.org (AMO) and is subject to the terms and conditions of the Firefox Add-on Distribution Agreement. The goal of the agreement is to ensure Firefox users get access to well supported, quality add-ons that enhance the Firefox experience.

+ +

Read the agreement

+ +

Learn more about signing

+ +

The review process

+ +

When a browser extension is submitted for signing, it's subject to automated review. It may also be subject to a manual review, when the automated review determines that a manual review is needed. Your browser extension won't be signed until it’s passed the automated review and may have its signing revoked if it fails to pass the manual review. The review process follows a strict set of guidelines, so it’s easy to check and avoid any likely review problems.

+ +

Check out the review policy and guidelines

+ + + +

If you choose to list your browser extension on AMO, your extension could be featured on the AMO website, in the Firefox browser’s add-on manager, or elsewhere on a Mozilla website. We've compiled a list of guidelines about how extensions are selected for featuring, by following these guidelines you give your extension the best chance of being featured.

+ +

Learn more about getting your add-ons featured

+ +

Continue your learning experience

+ +

Now you know what lies ahead, it's time to dive into more details about browser extension development. In the sections that follow, you’ll discover:

+ + diff --git a/files/pt-br/mozilla/add-ons/webextensions/passo-a-passo/index.html b/files/pt-br/mozilla/add-ons/webextensions/passo-a-passo/index.html new file mode 100644 index 0000000000..1e49d92e3c --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/passo-a-passo/index.html @@ -0,0 +1,306 @@ +--- +title: Passo-a-Passo +slug: Mozilla/Add-ons/WebExtensions/Passo-a-Passo +tags: + - Extensões Web + - extensões firefox + - passo-a-passo +translation_of: Mozilla/Add-ons/WebExtensions/Your_second_WebExtension +--- +

Neste artigo iremos criar uma Extensão para Firefox do início ao fim.

+ +

A extensão adicionará um novo botão na barra de ferramentas do Firefox. Quando clicar no botão se exibirá um popup habilitando a escolha de um animal. Uma vez que o usuário escolher um animal, a página atual do navegador será substituida por uma imagem do animal escolhido.

+ +

Para implementar esse extensão, será necessário:

+ + + +

Você pode visualizar toda a estrutura da extensão da seguinte forma:

+ +

+ +

É uma extensão extremamente simples, mas mostra muitos conceitos básicos da API de Extensões:

+ + + +

Você pode encontrar o código completo da extensão no GitHub.

+ +

Para criar essa extensão você precisará do Firefox 45 ou mais recente.

+ +

Escrevendo a WebExtension

+ +

Crie um novo diretório e navegue até ele:

+ +
mkdir beastify
+cd beastify
+ +

manifest.json

+ +

Agora crie um novo arquivo chamado "manifest.json", e insira o seguinte conteúdo:

+ +
{
+
+  "manifest_version": 2,
+  "name": "Beastify",
+  "version": "1.0",
+
+  "applications": {
+    "gecko": {
+      "id": "beastify@mozilla.org"
+    }
+  },
+
+  "permissions": [
+    "http://*/*",
+    "https://*/*"
+  ],
+
+  "browser_action": {
+    "default_icon": "button/beasts.png",
+    "default_title": "Beastify",
+    "default_popup": "popup/choose_beast.html"
+  },
+
+  "web_accessible_resources": [
+    "beasts/frog.jpg",
+    "beasts/turtle.jpg",
+    "beasts/snake.jpg"
+  ]
+
+}
+
+ + + +

Perceba que todos os caminhos são relativos ao manifest.json.

+ +

O Botão na barra de ferramentas

+ +

O botão na barra de ferramentas precisa de um icone,  e nosso manifest.json informa que nós teriamos um icone em "button/beasts.png".

+ +

Crie o diretório "button" e copie o icone com o nome "beasts.png". Você poderá usar um dos nossos exemplo, que é retirado do  Aha-Soft’s Free Retina iconset e usado sob os termos de sua licença.

+ +

Se você não fornecer um popup, então um evento de click é lançado para sua extensão quando o usuário clicar no botão. Se você fornecer um popup, o evento de click não envia, mas ao invés disso, o popup é aberto. Nós queremos abrir um popup, então vamos criá-lo na próxima etapa.

+ +

O popup

+ +

A função do popup é ativar a escolha do usuário para um dos três animais.

+ +

Crie um novo diretório chamado "popup" na raiz do projeto. Aqui é onde nós criar os códigos para o popup. O popup irá ser constituido em três arquivos :

+ + + +

choose_beast.html

+ +

O arquivo HTML criado é este:

+ +
<!DOCTYPE html>
+
+<html>
+  <head>
+    <meta charset="utf-8">
+    <link rel="stylesheet" href="choose_beast.css"/>
+  </head>
+
+  <body>
+    <div class="beast">Frog</div>
+    <div class="beast">Turtle</div>
+    <div class="beast">Snake</div>
+
+    <script src="choose_beast.js"></script>
+  </body>
+
+</html>
+ +

Nós temos um elemento para cada escolha de animal. Perceba que nós incluimos os arquivo CSS e JS nesse arquivo, igual a uma página web.

+ +

choose_beast.css

+ +

O CSS ajusta o tamanho do popup, garantindo que as três escolhas irão preencher o espaço, e daremos a eles algum estilo básico:

+ +
html, body {
+  height: 100px;
+  width: 100px;
+  margin: 0;
+}
+
+.beast {
+  height: 30%;
+  width: 90%;
+  margin: 3% auto;
+  padding-top: 6%;
+  text-align: center;
+  font-size: 1.5em;
+  background-color: #E5F2F2;
+  cursor: pointer;
+}
+
+.beast:hover {
+  background-color: #CFF2F2;
+}
+ +

choose_beast.js

+ +

No JavaScript para o popup, nós iremos "escutar" o evento de click . Se o clique foi em uma das três escolhas de animais, nós iremos injetar um content script na aba ativa. Um vez que o content script é carregado , nós enviaremos uma mensagem com o animal escolhido:

+ +
document.addEventListener("click", function(e) {
+  if (!e.target.classList.contains("beast")) {
+    return;
+  }
+
+  var chosenBeast = e.target.textContent;
+
+  chrome.tabs.executeScript(null, {
+    file: "/content_scripts/beastify.js"
+  });
+
+  chrome.tabs.query({active: true, currentWindow: true}, function(tabs) {
+    chrome.tabs.sendMessage(tabs[0].id, {beast: chosenBeast});
+  });
+
+});
+
+ +

É usado três funções da API WebExtension:

+ + + +

O content script

+ +

Crie a novo diretório na pasta root do projeto chamado "content_scripts" e crie um novo arquivo com o nome "beastify.js", com o seguinte conteúdo:

+ +
// Assign beastify() as a listener for messages from the extension.
+chrome.runtime.onMessage.addListener(beastify);
+
+function beastify(request, sender, sendResponse) {
+  removeEverything();
+  insertBeast(beastNameToURL(request.beast));
+  chrome.runtime.onMessage.removeListener(beastify);
+}
+
+function removeEverything() {
+  while (document.body.firstChild) {
+    document.body.firstChild.remove();
+  }
+}
+
+function insertBeast(beastURL) {
+  var beastImage = document.createElement("img");
+  beastImage.setAttribute("src", beastURL);
+  beastImage.setAttribute("style", "width: 100vw");
+  beastImage.setAttribute("style", "height: 100vh");
+  document.body.appendChild(beastImage);
+}
+
+function beastNameToURL(beastName) {
+  switch (beastName) {
+    case "Frog":
+      return chrome.extension.getURL("beasts/frog.jpg");
+    case "Snake":
+      return chrome.extension.getURL("beasts/snake.jpg");
+    case "Turtle":
+      return chrome.extension.getURL("beasts/turtle.jpg");
+  }
+}
+
+
+ +

O content script  adiciona um listener da mensagem para a extensão (especificamente , para "choose_beast.js"). No listener:

+ + + +

Os animais

+ +

Finalmente, nós precisamos incluir as imagens dos animais.

+ +

Crie um novo diretório chamado "beasts", e adicione as três imagens nos diretório, com os nomes apropriados. Você pode obter as imagens aqui no GitHub, ou aqui:

+ +

+ +

Empacotando e instalando

+ +

Verifique se os seus arquivos estão estruturados de acordo com as informações abaixo:

+ +
beastify/
+
+    beasts/
+        frog.jpg
+        snake.jpg
+        turtle.jpg
+
+    button/
+        beasts.png
+
+    content_scripts/
+        beastify.js
+
+    popup/
+        choose_beast.css
+        choose_beast.html
+        choose_beast.js
+
+    manifest.json
+ +

Extensões Firefox são empacotados como arquivos XPI, que são apenas arquivos ZIP com a extensão "XPI".

+ +

Um truque é que o arquivo ZIP  deve ser um dos arquivos de extensão . Portanto, para criar um XPI a partir dos arquivos beastify , navegue até o diretório " beastify " em um shell de comando e digite:

+ +
   # in beastify/
+   zip -r ../beastify.xpi *
+ + + +

Ou você pode compactar com alguma ferramenta do tipo WinRar escolhe a forma de empacotação ZIP e subistituir .zip para XPI

+ +

Para instalar o XPI, você apenas irá abrir o Firefox:

+ + + +

Você deverá receber um aviso de que você está instalando uma extensão não assinada. Aceite o aviso de advertência.

+ +

Você poderá ver o icone aparecer na barra de ferramentas. Abra uma nova página web, então click no icone, selecione um animal e veja a imagem que você escolheu na página.

diff --git a/files/pt-br/mozilla/add-ons/webextensions/pre-requisitos/index.html b/files/pt-br/mozilla/add-ons/webextensions/pre-requisitos/index.html new file mode 100644 index 0000000000..4e7e854644 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/pre-requisitos/index.html @@ -0,0 +1,23 @@ +--- +title: Pré-requisitos +slug: Mozilla/Add-ons/WebExtensions/pre-requisitos +translation_of: Mozilla/Add-ons/WebExtensions/Prerequisites +--- +

Para desenvolver utilizando as APIs de uma WebExtension, você precisa de uma configuração mínima.

+ + + +
 
+ +
 
+ +
 
diff --git a/files/pt-br/mozilla/add-ons/webextensions/sua_primeira_webextension/index.html b/files/pt-br/mozilla/add-ons/webextensions/sua_primeira_webextension/index.html new file mode 100644 index 0000000000..9d3045e28a --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/sua_primeira_webextension/index.html @@ -0,0 +1,150 @@ +--- +title: Sua primeira extensão +slug: Mozilla/Add-ons/WebExtensions/sua_primeira_WebExtension +translation_of: Mozilla/Add-ons/WebExtensions/Your_first_WebExtension +--- +
{{AddonSidebar}}
+ +

Neste artigo vamos percorrer, do início ao fim, os passos necessários para a criação de uma extensão para o Firefox. A extensão apenas adicionará uma borda vermelha em todas as páginas carregadas em "mozilla.org" ou qualquer um de seus subdomínios.

+ +

O código fonte para este exemplo está no GitHub: https://github.com/mdn/webextensions-examples/tree/master/borderify.

+ +

Para começar, você precisará do Firefox versão 45 ou posterior.

+ +

Construindo a Extensão

+ +

Crie uma nova pasta dando o nome de "borderify" e navegue para dentro dela.

+ +
mkdir borderify
+cd borderify
+ +

manifest.json

+ +

Dentro dessa pasta crie um novo arquivo chamado "manifest.json" e coloque o seguinte conteúdo no arquivo:

+ +
{
+
+  "manifest_version": 2,
+  "name": "Borderify",
+  "version": "1.0",
+
+  "description": "Adiciona uma borda vermelha a todas as páginas da Web correspondentes a mozilla.org.",
+
+  "icons": {
+    "48": "icons/border-48.png"
+  },
+
+  "content_scripts": [
+    {
+      "matches": ["*://*.mozilla.org/*"],
+      "js": ["borderify.js"]
+    }
+  ]
+
+}
+ + + +

A chave mais interessante aqui é content_scripts, que diz ao Firefox para carregar um script em páginas da Web cujo URL corresponde a um padrão específico. Nesse caso, pedimos ao Firefox para carregar um script chamado "borderify.js" em todas as páginas HTTP ou HTTPS oriundas de "mozilla.org" ou em qualquer um de seus subdomínios.

+ + + +
+

Em algumas situações, você precisa especificar uma ID para sua extensão. Se você precisar especificar um ID de extensão, inclua a chave applications no manifest.json e configure sua propriedade id:

+ +
"applications": {
+  "gecko": {
+    "id": "borderify@example.com"
+  }
+}
+
+ +

icons/border-48.png

+ +

A extensão deve ter um ícone. Ele será mostrado ao lado da listagem de extensões no Gerenciador de Extensões. Nosso manifest.json indica que teríamos um ícone localizado na pasta "icons/border-48.png".

+ +

Crie o diretório "icons" diretamente sob o diretório "borderify". Salve um ícone chamado "border-48.png". Você pode usar o icone do nosso exemplo, que foi retirado a coleção de ícone do Google Material Design, e é utilizado sob os termos da licença Creative Commons Attribution-ShareAlike.

+ +

Se você escolher criar seu próprio ícone, deve ser 48x48 pixels formato .PNG e também deve criar um ícone de 96x96 pixels também .PNG, para telas de alta resolução, e se você fizer isso será especificado como a propriedade 96 do objeto icons em manifest.json:

+ +
"icons": {
+  "48": "icons/border-48.png",
+  "96": "icons/border-96.png"
+}
+ +

Como alternativa, você pode criar um ícone em formato SVG  e ele será dimensionado corretamente.

+ + + +

borderify.js

+ +

Finalmente, crie um arquivo chamado "borderify.js" diretamente dentro do diretório "borderify" com o seguinte conteúdo:

+ +
document.body.style.border = "5px solid red";
+ +

Este script será carregado nas páginas que correspondem ao padrão especificado na chave content_scripts do manifest.json. O script tem acesso direto ao documento, igual aos scripts carregados pela própria página.

+ + + +

Testando

+ +

Primeiro, verifique se você está com os arquivos corretos nos lugares certos:

+ +
borderify/
+    icons/
+        border-48.png
+    borderify.js
+    manifest.json
+ +

Instalando

+ +

Acesse a área de Debugging do Firefox digitando diretamente na barra de endereço: "about: debugging", em seguida clique em "Load Temporary Add-on" e selecione o "borderify.js".

+ +

{{EmbedYouTube("cer9EUKegG4")}}

+ +

A Extensão agora será instalado e ficará assim até que você reinicie o Firefox.
+
+ Como alternativa, você pode executar a Extansão a partir da linha de comando usando a ferramenta web-ext.

+ +

Testando

+ +

Agora visitar uma página em "mozilla.org" e você deve ver uma borda vermelha em volta da página:

+ +

{{EmbedYouTube("rxBQl2Z9IBQ")}}

+ +
+

Não tente acessar addons.mozilla.org! Os scripts de conteúdo são bloqueados nesse domínio.

+
+ +

Experimente um pouco. Edite o script de conteúdo para alterar a cor da borda ou faça outra coisa com o conteúdo da página. Salve o script de conteúdo e, em seguida, recarregue os arquivos da extensão clicando no botão "Reload" em about: debugging. Você poderá ver as mudanças imediatamente:

+ +

{{EmbedYouTube("NuajE60jfGY")}}

+ + + +

Empacotando e publicando

+ +

Para que outras pessoas usem seu complemento, você precisa compactá-lo e enviá-lo para a Mozilla para assinatura. Para saber mais sobre isso, consulte "Publicando sua Extensão".

+ +

Próximos passos

+ +

Agora você tem uma idéia do processo de desenvolvimento de um WebExtension para o Firefox, que tal:

+ + diff --git a/files/pt-br/mozilla/add-ons/webextensions/user_interface/index.html b/files/pt-br/mozilla/add-ons/webextensions/user_interface/index.html new file mode 100644 index 0000000000..78b988a523 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/user_interface/index.html @@ -0,0 +1,97 @@ +--- +title: User interface +slug: Mozilla/Add-ons/WebExtensions/user_interface +tags: + - Landing + - NeedsTranslation + - TopicStub + - User Interface + - WebExtensions +translation_of: Mozilla/Add-ons/WebExtensions/user_interface +--- +
{{AddonSidebar}}
+ +

Extensions that use WebExtension APIs are provided with several user interface options so that their functionality can be made available to the user. A summary of those options is provided below, with a more detailed introduction to each user interface option in this section.

+ +
+

For advice on using these UI components to create a great user experience in your extension, please see the User experience best practices article.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UI optionDescriptionExample
Toolbar button (browser action)A button on the browser toolbar that dispatches an event to the extension when clicked. By default, the button is visible in all tabs.Example showing a toolbar button (browser action).
Toolbar button with a popupA popup on a button in the browser toolbar that opens when the button is clicked. The popup is defined in an HTML document that handles the user interaction.Example of the pop-up on a toolbar button
Address bar button (page action)A button on the browser address bar that dispatches an event to the extension when clicked. By default, the button is hidden in all tabs.Example showing an address bar button (page action)
Address bar button with a popupA popup on a button in the browser address bar that opens when the button is clicked. The popup is defined in an HTML document that handles the user interaction.Example of a popup on the address bar button
Context menu itemMenu items, checkboxes, and radio buttons on one or more of the browser's context menus. Also, menus can be structured by adding separators. When menu items are clicked, an event is dispatched to the extension.Example of content menu items added by a WebExtension, from the context-menu-demo example
Sidebar +

An HTML document displayed next to a web page, with the option for unique content per page. The sidebar is opened when the extension is installed, then obeys the user's sidebar visibility selection. User interaction within the sidebar is handled by its HTML document.

+ 		Example of a sidebar
Options pageA page that enables you to define preferences for your extension that your users can change. The user can access this page from the browser's add-ons manager.Example showing the options page content added in the favorite colors example.
Extension pageUse web pages included in your extension to provide forms, help, or any other content required, within windows or tabs.Example of a simple bundled page displayed as a detached panel.
NotificationTransient notifications displayed to the user through the underlying operating system's notifications mechanism. Dispatches an event to the extension when the user clicks a notification, or when a notification closes (either automatically or at the user's request).Example of an extension triggered system notification
Address bar suggestionOffer custom address bar suggestions when the user enters a keyword.Example showing the result of the firefox_code_search WebExtension's customization of the address bar suggestions.
Developer tools panelA tab with an associated HTML document that displays in the browser's developer tools.Example showing the result of the firefox_code_search WebExtension's customization of the address bar suggestions.
+ +

The following how-to guides provide step-by-step guidance to creating some of these user interface options:

+ + diff --git a/files/pt-br/mozilla/add-ons/webextensions/user_interface/itens_do_menu_de_contexto/index.html b/files/pt-br/mozilla/add-ons/webextensions/user_interface/itens_do_menu_de_contexto/index.html new file mode 100644 index 0000000000..cf8e2d7198 --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/user_interface/itens_do_menu_de_contexto/index.html @@ -0,0 +1,58 @@ +--- +title: Itens do menu de contexto +slug: Mozilla/Add-ons/WebExtensions/user_interface/Itens_do_menu_de_contexto +tags: + - WebExtensions +translation_of: Mozilla/Add-ons/WebExtensions/user_interface/Context_menu_items +--- +
{{AddonSidebar}}
+ +
+

Esta opção da interface de usuário adiciona um ou mais itens para o menu de contexto do navegador.Este é o menu de contexto disponível quando um usuário clica com o botão direito numa página web. As guias também podem ter menus de contexto, disponível através da API browser.menus.

+ +

Example of content menu items added by a WebExtension, from the context-menu-demo example

+ +

Você usaria essa opção para expor recursos relevantes para contextos específicos de navegadores ou páginas da web. Por exemplo, você poderia mostrar recursos para abrir um editor gráfico quando o usuário clica em uma imagem ou pode oferecer um recurso para salvar o conteúdo da página quando uma parte da página é selecionada. Você pode adicionar itens planos de menu, caixas de seleção, grupos de botões de rádio, e separadores para os menus. Quando um item de menu de contexto for adicionado usando {{WebExtAPIRef("contextMenus.create")}}, é mostrado em todas as guias do navegador, mas você pode escondê-lo usando {{WebExtAPIRef("contextMenus.remove")}}.

+ +

A lista inteira dos contextos suportados está disponível em {{WebExtAPIRef("menus.ContextType")}} e inclui contextos de fora de uma página web, como itens de favoritos na interface do navegador. Por exemplo, a extensão "Open bookmark in Container Tab" adiciona um item de menu que permite que o usuário abra a URL dos favoritos em uma nova guia de container:

+ +

+ +

Especificando itens do menu de contexto

+ +

Você controla os itens do menu de contexto programaticamente, usando a API {{WebExtAPIRef("contextMenus")}}. No entanto, você precisa requisitar a permissão contextMenus em seu manifest.json para poder tomar vantagem desta API.

+ +
"permissions": ["contextMenus"]
+ +

Você pode então adicionar (e atualizar ou apagar) os itens do menu de contexto em seu script de "background" (segundo plano) da sua extensão. Para criar um item de menu, você especifica um id, seu título, e os menus de contexto em que ele deve aparecer:

+ +
browser.contextMenus.create({
+  id: "log-selection",
+  title: browser.i18n.getMessage("contextMenuItemSelectionLogger"),
+  contexts: ["selection"]
+}, onCreated);
+ +

Sua extensão então escuta os cliques nos itens do menu. As informações passadas sobre o item clicado, o contexto em que o clique ocorreu e os detalhes da guia em que o clique ocorreu podem ser usadas para chamar a funcionalidade de extensão apropriada.

+ +
browser.contextMenus.onClicked.addListener(function(info, tab) {
+  switch (info.menuItemId) {
+    case "log-selection":
+      console.log(info.selectionText);
+      break;
+    ...
+  }
+})
+ +

Ícones

+ +

Para mais detalhes sobre como criar ícones para usar no seu menu de contexto, veja Iconography na documentação Photon Design System.

+ +

Exemplos

+ +

O repositório webextensions-examples no GitHub contém dois exemplos de extensões que implementam itens do menu de contexto:

+ + +
diff --git a/files/pt-br/mozilla/add-ons/webextensions/what_are_webextensions/index.html b/files/pt-br/mozilla/add-ons/webextensions/what_are_webextensions/index.html new file mode 100644 index 0000000000..629cc94a9d --- /dev/null +++ b/files/pt-br/mozilla/add-ons/webextensions/what_are_webextensions/index.html @@ -0,0 +1,22 @@ +--- +title: O que são extensões? +slug: Mozilla/Add-ons/WebExtensions/What_are_WebExtensions +translation_of: Mozilla/Add-ons/WebExtensions/What_are_WebExtensions +--- +
{{AddonSidebar}}
+ +

Extensões são bits de código que modificam a funcionalidade do navegador. Eles são escritos usando as tecnologias padrões da Web - JavaScript, HTML e CSS - além de APIs JavaScript dedicadas. Entre outras coisas, extensões podem adicionar novas funcionalidades para o navegador, ou mudar sua aparência, ou o conteúdo de páginas particulares.

+ +

Extensões para Firefox são construídas usando WebExtensions APIs, um sistema multi-navegador (cross-browser) para o desenvolvimento de extensões. Para uma maior portabilidade, a API é compatível com a extension API, suportada pelo Google Chrome e pelo Opera. Extensões escritas para esses navegadores, na maioria dos casos, vão rodar no Firefox ou Microsoft Edge com poucas mudanças. A API é também totalmente compatível com o multiprocess Firefox.

+ +

No passado, você poderia desenvolver extensões para Firefox usando um dos três métodos diferentes: XUL/XPCOM overlays, bootstrapped extensions ou o Add-on SDK. A partir do fim de Novembro de 2017, WebExtensions APIs será o único meio de desenvolver extensões para Firefox, e os outros métodos serão descontinuados.

+ +

Se você tem dúvidas ou sugestões, ou precisa de ajuda para migrar um add-on antigo para o WebExtensions APIs, você pode entrar em contato conosco pela dev-addon mailing list ou pelo canal #extdev no IRC.

+ +

Próximos passos

+ + -- cgit v1.2.3-54-g00ecf