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.

Using the Add-on SDK, you can create Firefox add-ons. You can use various standard Web technologies: JavaScript, HTML, and CSS, to create the add-ons. The SDK includes JavaScript APIs, which you can use to create add-ons and tools for creating, running, testing, and packaging add-ons.


Tutorials

Create user interface components
Create user interface components such as toolbar buttons, context menus, menu items, and dialogs.
Modify web pages
Modify pages matching a URL pattern or dynamically modify a particular tab.
Putting it together
Walkthrough of the Annotator example add-on.

Guides

Contributor's guide
Learn how to start contributing to the SDK and about the most important idioms used in the SDK code such as modules, classes and inheritance, private properties, and content processes.
SDK infrastructure
Aspects of the SDK's underlying technology: modules, the Program ID and the rules defining Firefox compatibility.
Content scripts
A detailed guide to working with content scripts.
SDK idioms
The SDK's event framework and the distinction between add-on scripts and content scripts.
XUL migration
A guide to porting XUL add-ons to the SDK. This guide includes a comparison of the two toolsets and a working example of porting a XUL add-on.
Multiprocess Firefox and the SDK
How to check whether your add-on is compatible with multiprocess Firefox or not and fix it accordingly.

Reference

High-Level APIs
Reference documentation for the high-level SDK APIs.
Tools reference
Reference documentation for the jpm tool used to develop, test and package add-ons, the console global used for logging, and the package.json file.
Low-Level APIs
Reference documentation for the low-level SDK APIs.

 


Join the Add-on SDK community

Choose your preferred method for joining the discussion:

Document Tags and Contributors

 Last updated by: wbamberg,