Labs/Jetpack/API

	THIS PAGE IS A WORKING DRAFT
	The page may be difficult to navigate, and some information on its subject might be incomplete and/or evolving rapidly. If you have any questions or ideas, please add them as a new topic on the discussion page.

JetPack is a project to explore new and innovative approaches to extensibility of the browser.

WARNING: This reference is extremely volatile and will change.

JetPack API Reference

Logger Used to output debugging information, it appears in the Javascript Error Console. You can access it from the Tools menu.

• log( message ). Shows a log message in the Error Console.
• debug( message ). Shows a debug message in the Error Console.
• info( message ). Shows an info message in the Error Console.
• warn( message ). Shows a warning in the Error Console.
• error( message ). Shows an error message in the Error Console.

Example:

 JetPack.Logger.warn( "1+1 != 3, except for values of 1 sufficiently large.");

Storage Persistent storage for your feature. The storage is sandboxed per feature, so data stored by one JetPack feature cannot be accessed by another JetPack feature.

• has(name). Checks whether a JetPack feature has stored a value.
• get(name). Returns the value of a stored object by name.
• set({name:string, value:string}). Sets the value of an object by name. Use .toSource() to store Javascript objects. In the future, serialization will be performed automatically.

Example:

 if( !JetPack.Storage.has("cheese") )
   JetPack.Storage.set({name: "cheese", value: "Delicious!"});

UI Interacting with the user interface of the browser is done through this component.

UI.Sidebars Allows JetPack features to manipulate Firefox sidebars.

• create({id: string, name: string, content: element}). Creates a sidebar with a given name.
  • id: the identifier by which you can refer to the sidebar later in your code.
  • name: will be the text that appears in the View>Sidebar menu.
  • content: is a DOM element. You can supply one using the $ function, which works just like the jQuery selector. For example, $("#sidebar-content").

UI.Statusbars Allows addition of icons to the status bar.

• create({id: string, callback: func})
  • id: the identifier by which you can refer to the status bar later.
  • callback: A function that details what to do upon creation of the status bar.

Example:

 Jetpack.UI.Statusbars.create({
   id: "sb-panel",
   callback: function(aPanel){
     aPanel.create({
       id: "amo-link",
       name: "AMO Link",
       icon: "icon.png",
       isLink: true,
       url: "http://addons.mozilla.org"
     });
     }
 });

UI.Content

• addLoadHandler({patterns: arrayOfRegexps, filter: function}). Adds a global page load handler. The patterns are matched against the page URL, and in case of a match, the filter method is called in the context of the page.