blob: 7fe91371cd54d30a1743b81fed220f43b15b4f81 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
---
title: Firefox OS add-ons
slug: Archive/B2G_OS/Add-ons
translation_of: Archive/B2G_OS/Add-ons
---
<p class="summary">Firefox OS 2.5 introduces support for add-ons, a feature that desktop users have known and loved since the beginning of Firefox. Add-ons on Firefox OS are even more powerful and can customize not only the browser, but the whole phone experience, including tweaks to the homescreen and system apps like E-Mail and Messages. This page tells you everything you need to know to get started with creating Firefox OS add-ons and get involved with the add-ons community.</p>
<div class="note">
<p dir="ltr"><strong>Note</strong>: Firefox OS add-ons are based on the <a href="/en-US/docs/Mozilla/Add-ons/WebExtensions">WebExtensions API</a>, which is also supported in Firefox desktop starting with version 42 and is based on the extension APIs used in Chrome and Opera.</p>
</div>
<h2 id="Prerequisites">Prerequisites</h2>
<p>You should follow the below steps to get set up to start developing extensions.</p>
<h3 dir="ltr" id="1._Flash_your_phone_to_Firefox_OS_2.5">1. Flash your phone to Firefox OS 2.5</h3>
<p dir="ltr">Firefox OS add-ons are only supported on Firefox OS 2.5 and later. Here’s a list of supported devices and how to update them (this list is incomplete, and will be added to as time goes on.)</p>
<ul>
<li dir="ltr">Flame (recommended): See <a href="/en-US/Firefox_OS/Phone_guide/Flame/Updating_your_Flame#Quick_guide_to_updating_your_device">Quick guide to updating your Flame</a>.</li>
</ul>
<h3 id="2._Enable_USB_Debugging">2. Enable USB Debugging</h3>
<p>In the <em>Settings</em> app on the device, select <em>Developer > Debugging via USB > ADB and Devtools</em>. You should now be able to debug installed apps using WebIDE, either via a USB cable, <a href="/en-US/docs/Tools/Remote_Debugging/Debugging_Firefox_OS_over_Wifi">and over Wifi</a> (no USB cable required.)</p>
<h3 id="3._Set_up_WebIDE">3. Set up WebIDE</h3>
<p>The <a href="/en-US/docs/Tools/WebIDE">WebIDE</a> tool is part of Firefox and can be used to install add-ons on your phone during development — see <a href="/en-US/docs/Mozilla/Firefox_OS/Add-ons/Developing_Firefox_OS_add-ons#Testing_your_add-on_using_WebIDE">Testing your add-on using WebIDE</a> for more information.</p>
<h2 id="See_also">See also</h2>
<h3 id="Developing">Developing</h3>
<ul>
<li dir="ltr"><strong>Tutorial</strong>: <a href="https://developer.mozilla.org/en-US/docs/Mozilla/Firefox_OS/Add-ons/Developing_Firefox_OS_add-ons">https://developer.mozilla.org/en-US/docs/Mozilla/Firefox_OS/Add-ons/Developing_Firefox_OS_add-ons</a></li>
<li dir="ltr"><strong>In-depth example</strong>: <a href="https://hacks.mozilla.org/2015/11/building-an-ios-style-unread-notifications-add-on-for-firefox-os/">https://hacks.mozilla.org/2015/11/building-an-ios-style-unread-notifications-add-on-for-firefox-os/</a></li>
<li dir="ltr"><strong>API reference</strong>: <a href="https://developer.mozilla.org/en-US/Add-ons/WebExtensions">https://developer.mozilla.org/en-US/Add-ons/WebExtensions</a></li>
</ul>
<h3 dir="ltr" id="Distributing">Distributing</h3>
<ul>
<li dir="ltr"><strong>Submitting to Marketplace</strong>: <a href="/en-US/docs/Mozilla/Marketplace/Add-on_submission">Add-on submission</a></li>
<li dir="ltr"><strong>Review criteria</strong> (working draft): <a href="/en-US/docs/Mozilla/Marketplace/Add-on_submission/Review_criteria">Add-on review criteria</a></li>
</ul>
<h3 dir="ltr" id="Get_involved">Get involved</h3>
<ul>
<li dir="ltr"><strong>Mailing list</strong>: <a href="https://mail.mozilla.org/listinfo/dev-addons">https://mail.mozilla.org/listinfo/dev-fxos</a></li>
<li dir="ltr"><strong>Discourse forum</strong>: <a href="https://discourse.mozilla-community.org/c/add-ons/development">https://discourse.mozilla-community.org/c/add-ons/development</a></li>
<li dir="ltr"><strong>IRC</strong>: irc.mozilla.org, #webextensions and #fxos</li>
<li dir="ltr"><strong>Join the unofficial Telegram group</strong>: <a href="https://telegram.me/joinchat/BTLPMAC90O9n8cpgsZ03_A">https://telegram.me/joinchat/BTLPMAC90O9n8cpgsZ03_A</a></li>
<li dir="ltr"><strong>Let us know what new APIs we should prioritize</strong>: <a href="https://webextensions.uservoice.com/forums/315663-webextension-api-ideas">https://webextensions.uservoice.com/forums/315663-webextension-api-ideas</a></li>
<li dir="ltr"><strong>Follow us on Twitter</strong>: <a href="https://twitter.com/MozWebExt">@MozWebExt</a></li>
</ul>
|