Labs/Jetpack/API: Difference between revisions
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
JetPack is a project to explore new and innovative approaches to extensibility of the browser. | 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 = | = JetPack API Reference = | ||
'''Logger''' | '''Logger''' | ||
| Line 12: | Line 12: | ||
* <code>warn( message )</code>. Shows a warning in the Error Console. | * <code>warn( message )</code>. Shows a warning in the Error Console. | ||
* <code>error( message )</code>. Shows an error message in the Error Console. | * <code>error( message )</code>. Shows an error message in the Error Console. | ||
Example: | |||
JetPack.Logger.warn( "1+1 != 3, except for values of 1 sufficiently large."); | |||
'''Storage''' | '''Storage''' | ||
| Line 17: | Line 20: | ||
* <code>has(name)</code>. Checks whether a JetPack feature has stored a value. | * <code>has(name)</code>. Checks whether a JetPack feature has stored a value. | ||
* <code>get(name)</code>. Returns the value of a stored object by name. | * <code>get(name)</code>. Returns the value of a stored object by name. | ||
* <code>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. | * <code>set({name:string, value:string})</code>. 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''' | '''UI''' | ||
Interacting with the user interface of the browser is done through this component. | Interacting with the user interface of the browser is done through this component. | ||
'''UI.Sidebars''' | |||
Allows JetPack features to manipulate Firefox sidebars. | |||
* <code>create({id: string, name: string, content: element})</code>. Creates a sidebar with a given name. The <code>id</code> is the identifier by which you can refer to the sidebar later in your code. The <code>name</code> will appear in the View>Sidebar menu. Finally, <code>content</code> | |||
Revision as of 08:49, 27 April 2009
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. Theidis the identifier by which you can refer to the sidebar later in your code. Thenamewill appear in the View>Sidebar menu. Finally,content