Add-on SDK is a software development kit that provides a set of tools and APIs for building, testing, and packaging Firefox add-ons.
The 1.3 release is mostly a stabilization release, and does not include many major new features.
Obtain the SDK in your favorite compression format:
Then unpack the archive, open the addon-sdk-1.3/README.txt file, and follow its instructions.
Major Changes Since 1.2.1
Major Bug fixes
Panel content scripts don't work after reloading or changing location
Activate fails to find 64-bit python on 64-bit windows environments
selection.text returns null instead of the selected text when the selection is in a text box or text area
Python 2.7 support
We've started explicitly supporting Python 2.7.
- replaced the "getting started" tutorial, because the Google Translate API is about to be retired.
- added a guide to help developers decide whether to migrate XUL-based add-ons to the SDK, and describe some techniques to help them achieve this.
- landed API documentation for a couple of useful low-level APIs:
See the complete list of known issues and requests for enhancement. We've listed some of the issues you're most likely to encounter separately below.
If you change location in a content script using:
Nothing happens, instead, `location` attribute is just replaced by a string.
If a page-mod matches a page, its content scripts get attached to every iframe in the page, and this can have a bad effect on performance if the script is large and the page contains many iframes.
Although this behaviour is intentional, there should be an option to make content scripts only run on the topmost frame of a page.
When an html select element (e.g. a drop-down menu) in web content inside a panel has focus, clicking *outside* the panel does not close the panel.
If you create a context menu item for the selection type, and right-click a form button, the context menu does not appear and an error is logged. It's not yet clear whether this is specific to form buttons or not.
The tab array is not reordered to match the on-screen order of the tabs after a tab move event takes place.
Cannot scroll panel on OS X.
If your add-on has a long name, and the path to your Firefox profile is long enough, then the XPI installation process will try to create an intermediate file with a name longer than the maximum supported length on some Windows systems. If that happens you may get an error like:
"<your add-on> could not be installed because Firefox cannot modify the needed file"
The main fix for this will be bug 638742, which is to stop unpacking the XPI completely. When that is done, none of the pathnames will matter: they'll all stay safely trapped inside the zipfile. At that point, the name of the XPI file and the length of the profile directory will be the only issues.
Until then, the best advice is to use shorter package names or install Firefox higher up the directory tree so the profile directory's absolute path is shorter.
The SDK automatically includes a dependency on the packages supplied with the SDK such as
api-utils. This means that you can
require() modules in the SDK such as
widget without having to specify
addon-kit as a dependency.
However, if you do add any dependencies to
package.json, then the SDK will no longer add
api-utils automatically, and you must add them manually if you want to include their modules.
The SDK will give an error if your package name contains spaces or Unicode characters.
If your add-on stores data using the simple-storage API, the data is not cleaned up when your add-on is uninstalled.
btoa(), are not available to add-on code.
If an add-on is uninstalled while it's disabled, it's not notified of uninstall. If the add-on needs to do some special cleanup on uninstall, like removing persistent storage such as a file, this won't be possible if it has been disabled.
bin\activate sometimes gives the following error:
"Error: The system was unable to find the specified registry key or value"
This does not seem to affect the functioning of the SDK.
By default, widgets are placed on the add-on bar, and given a height to match the height of that bar. If the user moves the widget to a different toolbar, and that toolbar has a different height, the widget's height is not updated accordingly.
A widget containing HTML content gets no icon in the Customize Toolbar Window.
When a user removes a widget from the toolbar its
detach event does not get sent.
Selection events for a page are not sent if the page did not fully load (for example, because the user stopped the page loading).
If you have copy of mozrunner installed on your system, the
cfx test command may not work correctly.
There is a workaround for this.