We are planning to deprecate the use by Firefox add-ons of the techniques described in this document.

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 instead.

Add-ons developed using these techniques might not work with multiprocess Firefox (e10s), which is already the default in Firefox Nightly and Firefox Developer Edition, and will soon be the default in Beta and Release versions of Firefox. We have documentation on making your add-ons multiprocess-compatible, but it will be more future-proof for you to migrate to WebExtensions.

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

To follow this tutorial you'll need to have learned the basics of jpm.

To list the open tabs, you can iterate over the tabs object itself.

The following add-on adds an action button that logs the URLs of open tabs when the user clicks it:

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: to get this working, you will need to save an icon for the button to your add-on's "data" directory as "icon-16.png". You can download the icon here: .

Run the add-on, load a couple of tabs and click the button. You'll see output in the command line console that looks something like this:

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

You don't get direct access to any content hosted in the tab. To access tab content, you need to attach a script to the tab using tab.attach(). This add-on attaches a script to all open tabs. The script adds a red border to the tab's document:

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';"
  });
}

Learning More

To learn more about working with tabs in the SDK, see the tabs API reference.

To learn more about running scripts in tabs, see the tutorial on using tab.attach().

Document Tags and Contributors

Tags: 
 Contributors to this page: wbamberg, Taucesauce, addOn, aakilfernandes, XrXrXr, tomica
 Last updated by: wbamberg,