Skip to content
This repository has been archived by the owner on Feb 26, 2022. It is now read-only.

Latest commit

 

History

History
32 lines (24 loc) · 1.35 KB

addon-page.md

File metadata and controls

32 lines (24 loc) · 1.35 KB

With the Add-on SDK you can present information to the user, such as a guide to using your add-on, in a browser tab. You can supply the content in an HTML file in your add-on's "data" directory.

Note: This module has no effect on Fennec.

For pages like this, navigational elements such as the Awesome Bar, Search Bar, or Bookmarks Toolbar are not usually relevant and distract from the content you are presenting. The addon-page module provides a simple way to have a page which excludes these elements.

To use the module import it using require(). After this, the page loaded from "data/index.html" will not contain navigational elements:

var addontab = require("sdk/addon-page");
var data = require("sdk/self").data;

require("sdk/tabs").open(data.url("index.html"));

Example add-on page

This only affects the page at "data/index.html": all other pages are displayed normally.