Confirmed users
34
edits
Jetpack/FAQ: Difference between revisions
no edit summary
mNo edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
Add-on Builder | Add-on Builder Beta and Add-on SDK are tools that let developers make great add-ons using HTML, JavaScript and CSS. Developers have the choice of working in an online hosted environment with the Add-on Builder Beta or locally through a command line interface with the Add-on SDK. | ||
Add-on Builder and Add-on SDK are two products in the Jetpack project; with a goal to make building add-ons even easier for developers. | |||
== General == | == General == | ||
'''What is the Add-on Builder | '''What is the Add-on Builder Beta? ''' | ||
The Add-on Builder | The Add-on Builder Beta is an online development environment which you can use to make add-ons with your web browser. It provides a code editor, a file browser, and tools to help test and package your add-on right in the browser. | ||
'''What is the Add-on SDK? ''' | '''What is the Add-on SDK? ''' | ||
| Line 17: | Line 17: | ||
Jetpack SDK is the old name for the Add-on SDK. | Jetpack SDK is the old name for the Add-on SDK. | ||
'''What are the benefits of using the Add-on SDK and Add-on Builder | '''What are the benefits of using the Add-on SDK and Add-on Builder Beta? ''' | ||
These tools lets you build Firefox add-ons using common web technologies like HTML, JavaScript and CSS, and it includes tools to make it easy to create, test, and package add-ons. | These tools lets you build Firefox add-ons using common web technologies like HTML, JavaScript and CSS, and it includes tools to make it easy to create, test, and package add-ons. | ||
| Line 33: | Line 33: | ||
Finally, add-ons built with these tools will soon load in separate processes, so slow-running add-ons won't slow down Firefox itself. | Finally, add-ons built with these tools will soon load in separate processes, so slow-running add-ons won't slow down Firefox itself. | ||
'''Can I do everything with the Add-on SDK and Add-on Builder | '''Can I do everything with the Add-on SDK and Add-on Builder Beta that I could with a XUL-based add-on? Should I rewrite my XUL-based add-on now? ''' | ||
You can do nearly everything with an Add-on SDK and Add-on Builder based add-on that you can do with a XUL-based add-on, including: | You can do nearly everything with an Add-on SDK and Add-on Builder based add-on that you can do with a XUL-based add-on, including: | ||
| Line 45: | Line 45: | ||
Add-on Builder and the Add-on SDK are aimed primarily at Web developers who wish to write add-ons but are unfamiliar with the traditional XUL-based approach. So it supports a set of easy-to-use high level JavaScript APIs which address the most common use cases encountered by add-on developers. Using only the high level APIs, you can't do everything a XUL-based add-on can do. | Add-on Builder and the Add-on SDK are aimed primarily at Web developers who wish to write add-ons but are unfamiliar with the traditional XUL-based approach. So it supports a set of easy-to-use high level JavaScript APIs which address the most common use cases encountered by add-on developers. Using only the high level APIs, you can't do everything a XUL-based add-on can do. | ||
After shipping version 1.0 of the Add-on SDK and the Add-on Builder | After shipping version 1.0 of the Add-on SDK and the Add-on Builder Beta, one of our top priorities is to help developers migrate from XUL-based add-ons to Builder/SDK based add-ons, so implementing advanced add-ons will become much easier. | ||
So if you're a XUL add-on developer, an early adopter, and are willing to participate in the development process, then now is a great time to try out the Add-on SDK and Add-on Builder and help us figure out the right set of features to enable you to make the transition. | So if you're a XUL add-on developer, an early adopter, and are willing to participate in the development process, then now is a great time to try out the Add-on SDK and Add-on Builder and help us figure out the right set of features to enable you to make the transition. | ||
'''What do I need to know to write an add-on using the Add-on Builder | '''What do I need to know to write an add-on using the Add-on Builder Beta and Add-on SDK? ''' | ||
You'll develop add-ons using JavaScript, and you'll interact with web content via the DOM. You'll use HTML and CSS to structure and style your own user interface components. | You'll develop add-ons using JavaScript, and you'll interact with web content via the DOM. You'll use HTML and CSS to structure and style your own user interface components. | ||
'''What are the system requirements for the Add-on Builder | '''What are the system requirements for the Add-on Builder Beta? ''' | ||
You need Firefox version 4 or later, and an Internet connection. | You need Firefox version 4 or later, and an Internet connection. | ||
| Line 109: | Line 109: | ||
'''How can I have a Preferences UI/Options UI for my add-on? ''' | '''How can I have a Preferences UI/Options UI for my add-on? ''' | ||
At the moment the Add-on SDK and Add-on Builder | At the moment the Add-on SDK and Add-on Builder Beta don't offer a module to give you a Preferences/Options UI for your add-on. You have to build the UI yourself using the basic UI components provided. | ||
We will provide a module for this in future releases of the Add-on SDK and Add-on Builder. | We will provide a module for this in future releases of the Add-on SDK and Add-on Builder. | ||
'''Why can't I create Firefox toolbars using the Add-on SDK / Add-on Builder | '''Why can't I create Firefox toolbars using the Add-on SDK / Add-on Builder Beta? ''' | ||
In the past, we haven't provided much guidance to add-on developers about how best to integrate their user interfaces into Firefox, and the add-ons manager did not make it easy for users to access an add-on's preferences. The result of this has been a proliferation of toolbars and menu items, which can lead to a cluttered and confusing user experience. | In the past, we haven't provided much guidance to add-on developers about how best to integrate their user interfaces into Firefox, and the add-ons manager did not make it easy for users to access an add-on's preferences. The result of this has been a proliferation of toolbars and menu items, which can lead to a cluttered and confusing user experience. | ||
Therefore in the Add-on SDK and Add-on Builder | Therefore in the Add-on SDK and Add-on Builder Beta, the preferred way for add-ons to expose a permanent user interface is through the Widget API, which will ensure that the user interfaces for all add-ons default to a standard location (the add-on bar) where users will expect to see them. | ||
'''Can I add items to Firefox's menus in my add-on? ''' | '''Can I add items to Firefox's menus in my add-on? ''' | ||