Add-ons

Extension pages

You can include html pages in your extension to provide forms, help, or any other content your extension needs.

Example of a simple bundled page displayed as a detached panel.

These pages also get access to the same privileged JavaScript APIs that are available to your extension's background scripts.

Specifying extension pages

You can include HTML files, and their associated CSS or JavaScript files, in your extension. The files can be included in the root or organized within meaningful sub-folders.

/my-extension
    /manifest.json
    /my-page.html
    /my-page.js

Displaying extension pages

There are two options for displaying extension pages: windows.create() and tabs.create().

Using windows.create(), for example, you can open an HTML page into a detached panel (a window without the normal browser UI of address bar, bookmark bar, and alike) to create a dialog-like user experience:

var createData = {
  type: "detached_panel",
  url: "panel.html",
  width: 250,
  height: 100
};
var creating = browser.windows.create(createData);

When the window is no longer needed, it can be closed programmatically, for example, after the user clicks a button, by passing the id of the current window to windows.remove():

document.getElementById("closeme").addEventListener("click", function(){
  var winId = browser.windows.WINDOW_ID_CURRENT;
  var removing = browser.windows.remove(winId);
}); 

Extension pages and history

By default, pages you open in this way will be stored in the user's history, just like normal web pages. If you don't want to have this behavior, use history.deleteUrl() to remove the browser's record:

const url = browser.extension.getURL("my-page.html");

browser.tabs.create({url: url}).then(() => {
  // We don't want to sync this URL ever nor clutter the users history
  browser.history.deleteUrl({url: url});
}).catch((e) => { throw e });

To use the history API, you must request the "history" permission in your manifest.json file.

Examples

The window-manipulator example WebExtension, from the webextensions-examples repo on GitHub, illustrates several of the options for creating windows.

Document Tags and Contributors

 Contributors to this page: zombie, wbamberg, Dietrich, andrewtruongmoz, hellosct1, rebloor
 Last updated by: zombie,