Open a Web Page

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 open a new web page, you can use the tabs module:

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

This function is asynchronous, so you don't immediately get back a tab object which you can examine. To do this, pass a callback function into open(). The callback is assigned to the onReady property, and will be passed the tab as an argument:

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

Even then, 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 loads a page, then attaches a script to the page which adds a red border to it:

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

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, tomica
 Last updated by: wbamberg,