Add-ons/developer/communication: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
m (→‎Managing the Impact: experiments)
(→‎Get in Touch: updated IRC links to matrix)
 
(100 intermediate revisions by 9 users not shown)
Line 1: Line 1:
=Upcoming Changes in Add-on Development=
=A Web-based API for Developing Extensions in Firefox=
There are a lot of [https://blog.mozilla.org/addons/2015/08/21/the-future-of-developing-firefox-add-ons/ changes] coming up for add-on development. By the end of 2017, we will transition to [https://wiki.mozilla.org/WebExtensions WebExtensions] as the standard for creating add-ons. Over the same period of time, existing methods for add-on development such as XUL/XPCOM will be deprecated. [https://developer.mozilla.org/Add-ons/Working_with_multiprocess_Firefox Multi-process Firefox] (aka Electrolysis, or e10s) is also rolling out, which means some add-on developers will have to update their add-ons more than once.<br />


This page contains timelines and resources to help ease the transition for add-on developers. If you're a new developer and would like create an add-on, please head over to [https://developer.mozilla.org/Add-ons/WebExtensions MDN].
The [https://developer.mozilla.org/en-US/Add-ons/WebExtensions WebExtensions API] was introduced in 2016 as a stable, cross-browser platform that allows extension and theme authors to enhance the default Firefox browser. In November of 2017 it became the only officially supported extension API with the release of Firefox Quantum. The secure, sandboxed nature of the WebExtensions API means that not every legacy API can or will be available. Nevertheless, since its introduction, the WebExtensions API has grown with new features such as tab hiding and additional theme elements, all while maintaining near-complete compatibility with the Chrome extension API. Going forward, you can expect to see improvements in performance as well as additional features for user scripting, context menus, keyboard shortcuts and private browsing.


=====What's New=====
Keep an eye on the [https://blog.mozilla.org/addons/ Add-ons Blog] for more information on enhancements to the WebExtensions API in upcoming releases of Firefox or, if you want real-time detailed information on upcoming changes, follow the [https://mzl.la/2MttuGN WebExtensions product in Bugzilla].
* Check out the new [https://compatibility-lookup.services.mozilla.com/ lookup tool], which you can use to see if you will be affected by the upcoming changes.
* [https://github.com/mdn/webextensions-examples Example add-ons] created with WebExtensions APIs
* The [http://bit.ly/webextensions-apis WebExtensions survey] is live! Please use this survey to tell us which APIs you need so we can better prioritize them.


=Timeline of Changes=
This page contains resources to help you port your legacy extension to use WebExtensions APIs. If you're looking for resources on creating a new extension, please head over to [https://developer.mozilla.org/en-US/Add-ons/WebExtensions MDN].
[https://docs.google.com/spreadsheets/d/1OFYrrvAFg8y1mZOEbuIR1axxtV8eul_be6ad9fe8JB0/edit#gid=1952061950 https://blog.mozilla.org/addons/files/2016/03/Screenshot-2016-03-21-15.50.00-e1458601067133.png] 
See a [https://docs.google.com/spreadsheets/d/1OFYrrvAFg8y1mZOEbuIR1axxtV8eul_be6ad9fe8JB0/edit#gid=1952061950 graph of upcoming changes], organized by Firefox release dates.


=Developers who are affected by the changes=
=About the WebExtensions API=  
'''~~NEW~~''' there is now a [https://compatibility-lookup.services.mozilla.com/ lookup tool] you can use to see if your add-on will be affected by the changes.


==1) Has SDK add-on using low level APIs==
* [[WebExtensions/Vision|WebExtensions Vision]]: see the high-level vision for the WebExtensions API.  
Developers who created an SDK add-on using [https://developer.mozilla.org/Add-ons/SDK/Low-Level_APIs low-level APIs], which break with Multi-process Firefox (aka Electrolysis or e10s).  
* [[WebExtensions/policy|WebExtensions Policy]]: guidelines for what should be included in the WebExtensions API
=====Migration Path=====
* [[WebExtensions/FAQ|WebExtensions APIs FAQs]]: Have questions about the WebExtensions API? Check out these frequently asked questions.
If your add-on code accesses web content using a [https://developer.mozilla.org/Add-ons/SDK/Low-Level_APIs low-level SDK APIs] like window/utils or tabs/utils, then you will likely be affected.<br />
'''''Multi-process Firefox is scheduled for release in the [[Electrolysis#Schedule next|few months]], so we urge you to [https://developer.mozilla.org/Add-ons/SDK/Guides/Multiprocess_Firefox_and_the_SDK test your add-ons] for compatibility.'''''<br />


*'''If it breaks''' in Multi-process Firefox, your users will be impacted, and you will need to update your add-on. You can find documentation on how to make them compatible [https://developer.mozilla.org/en-US/Add-ons/Working_with_multiprocess_Firefox here].<br />
=Migration paths for developers of legacy add-ons=
*'''If it does not break''' in Multi-process Firefox, you will should add the [https://developer.mozilla.org/Add-ons/SDK/Tools/package_json#Key_reference <code>multiprocess</code> permission] in package.json.
=====1) SDK add-on=====
Here is the comparison chart showing [https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Comparison_with_the_Add-on_SDK SDK APIs and their WebExtensions counterparts]. If you don't see the APIs you need to port to WebExtensions, please take a look at [https://wiki.mozilla.org/Add-ons/developer/communication#Don.27t_See_the_WebExtensions_APIs_You_Need.3F some more] options below.


There are people on hand to assist you [http://atsay.github.io/e10s_office_hours/ '''every Tuesday'''] in the #addons channel at [https://wiki.mozilla.org/IRC irc.mozilla.org]. We're here to help!
=====2) XUL or XPCOM add-on=====
Here is the comparison chart showing [https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Comparison_with_XUL_XPCOM_extensions XUL/XPCOM APIs and their WebExtensions counterparts]. If you don't see the APIs you need to port to WebExtensions, please take a look at some [https://wiki.mozilla.org/Add-ons/developer/communication#Don.27t_See_the_WebExtensions_APIs_You_Need.3F more options] below.


'''~~Attention SDK developers~~'''<br />
=Don't See the WebExtensions APIs You Need?=
As of March 2016, SDK add-ons that were built using the cfx tool (Jetpack version 1.17 and lower) need to be repackaged using the [https://developer.mozilla.org/en-US/Add-ons/SDK/Tools/cfx_to_jpm newer jpm tool] in order to continue being compatible with Firefox. jpm will be supported for as long as the SDK is.


==2) Has SDK add-on using legacy APIs==
*If you're experienced with Mozilla infrastructure and would like to develop WebExtensions APIs directly for Firefox, here is a list of [https://mzl.la/2dVs5Ys approved APIs] that you can start contributing to.
Developers who created an SDK add-on, but uses either XPCOM or other legacy APIs.


=====Migration Path=====
*If you want to prototype and tinker with WebExtensions APIs without having to build Firefox, [http://webextensions-experiments.readthedocs.io/en/latest/index.html WebExtensions Experiments] is for you!
Developers in this group potentially have to update their add-on twice--once for e10s compatibility (if using [https://developer.mozilla.org/Add-ons/SDK/Low-Level_APIs low-level APIs]), and again for WebExtensions compatibility (because it uses legacy APIs).


#'''Use only [https://developer.mozilla.org/Add-ons/SDK/High-Level_APIs high-level APIs]''' - High-level APIs are [https://wiki.mozilla.org/Add-ons/developer/communication#1.29_Has_SDK_add-on_using_low_level_APIs e10s compatible] and are more likely to have an equivalent WebExtensions API. You will have to migrate again once WebExtensions are fully ready, but it should be pretty easy to do in this case.
*If you want to request a new WebExtensions API, please read [https://wiki.mozilla.org/WebExtensions/NewAPIs this page].
#'''Move to [[WebExtensions|WebExtensions]]''' - WebExtensions may not have all the APIs you need yet, so you might have to limit the functionality of your add-on until they become available. Please use [http://bit.ly/webextensions-apis this survey] to tell us which APIs you need, and see what else we're doing to [[Add-ons/developer/communication#Managing_the_Impact|mitigate the impact]] of this transition.


==3) Has SDK add-on using only high level APIs==
Not all add-ons will be able to migrate to WebExtensions without having to drop any features. But we want to work with you to get as many add-ons migrated as possible with the functionality you created intact. We invite you to contribute to its evolution, and we look forward to [[Add-ons/developer/communication#Get_in_Touch|working with you]].
Developers who used the SDK for their add-ons using only [https://developer.mozilla.org/Add-ons/SDK/High-Level_APIs high-level APIs]. Might have played around with the Chrome extension API in the past.
=====Migration Path=====
*As of March 2016, SDK add-ons that were built using the cfx tool (Jetpack version 1.17 and lower) need to be repackaged using the [https://developer.mozilla.org/Add-ons/SDK/Tools/cfx_to_jpm newer jpm tool] in order to continue being compatible with Firefox.
*If you already do that, your add-on will probably continue to work without problems, but we recommend you start looking into [https://developer.mozilla.org/Add-ons/WebExtensions WebExtensions].
*Please use [http://bit.ly/webextensions-apis this survey] to tell us which APIs you need in WebExtensions. This will help us prioritize and plan for what we need to support.


==4) Has XUL or XPCOM add-on==
=Tools=
Developers who created add-ons that don't rely on the SDK or WebExtensions.
*[https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Getting_started_with_web-ext web-ext] is a command line tool designed to speed up various parts of the WebExtension development process, making development faster and easier.
=====Migration Path=====
* [https://www.extensiontest.com/ The Extension Compatibility Test] is a utility that can test your Chrome extension's compatibility with Firefox. All you need to do is upload your .crx file.
The transition to WebExtensions impacts add-ons built on APIs like XUL and XPCOM most of all. We expect to remove support for these technologies in Firefox add-ons by the end of 2017. We hope this will give us enough time to help you migrate and provide WebExtension APIs that are suitable for replacing the features you might lose once we stop supporting these APIs.  
*[https://github.com/mi-g/weh WebExtensions Helper] speeds up browser add-ons development by providing  facilities for WebExtensions-based (Firefox, Chrome, Opera and Edge) extensions
* [https://webextensions.tech/ webextensions.tech] is a scaffolding UI tool for browser extensions. It lets you to input and select few parameters and outputs a complete boilerplate browser extension project.
*[https://github.com/yeoman/generator-chrome-extension Chrome Extension generator] creates everything you need to get started with extension development. You can choose Browser UI(Browser,Page Action, Omnibox) type and select permissions you need.
*[http://extensionizr.com/ Extensionizr] is a wizard that helps you create a basic extension
*[https://github.com/mahemoff/chrome-boilerplate Chrome Boilerplate]
*[https://github.com/sitepoint/ChromeSkel_a Skeleton Chrome Extension] is an extension bootstrap and template


If you’ve already updated your add-on for Multiprocess Firefox (e10s) compatibility, thank you for clearing this hurdle. To prepare for XUL/XPCOM deprecation, there are two available options, each with pros and cons:
=Documentation & Tutorials=
*[https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Porting_a_legacy_Firefox_add-on Porting guides that map SDK and XUL APIs to available WebExtensions APIs]
* [https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Porting_a_Google_Chrome_extension How to port a Chrome extension to Firefox]
*[https://developer.mozilla.org/en-US/Add-ons/WebExtensions How-to guides] covering common add-on developer cases, like [https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Intercept_HTTP_requests intercepting web requests] and [https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Add_a_button_to_the_toolbar adding a button to the toolbar]
*[https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Comparison_with_the_Add-on_SDK Comparison with the Add-on SDK]
*[https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Comparison_with_XUL_XPCOM_extensions Comparison with XUL/XPCOM extensions]
*[https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Browser_support_for_JavaScript_APIs Browser compatibility table] for all WebExtensions APIs
*[https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Examples Examples of WebExtensions on MDN Web Docs]


<ol><li>'''Migrate to the Add-ons SDK''' - since WebExtensions is in development and the first release is scheduled for March 2016, one option you have is to [https://developer.mozilla.org/en-US/Add-ons/SDK migrate to the SDK].
=Blog Posts=
*'''Pros:''' the APIs provided by the SDK are well-documented and are fully functional. Migrating to WebExtensions later on will be easier.
All WebExtensions blog posts are [https://blog.mozilla.org/addons/category/web-extensions/ here].
*'''Cons:''' you will need to to stick to [https://developer.mozilla.org/Add-ons/SDK/High-Level_APIs high-level APIs], which are e10s compatible and are more likely to have an equivalent WebExtensions API. You will have to migrate again once WebExtensions are fully ready, though it may be easier if you’ve already migrated to the SDK.</li>
* December 20, 2018: [https://blog.mozilla.org/addons/2018/12/20/extensions-in-firefox-65/ Extensions in Firefox 65]
 
* November 8, 2018: [https://blog.mozilla.org/addons/2018/11/08/extensions-in-firefox-64/ Extensions in Firefox 64]
<li>'''Migrate to WebExtensions''' - to avoid having to migrate to SDK and then again to WebExtensions, you can [https://developer.mozilla.org/Add-ons/WebExtensions migrate directly to WebExtensions].
* August 31, 2018: [https://blog.mozilla.org/addons/2018/08/31/extensions-in-firefox-63/ Extensions in Firefox 63]
*'''Pros:''' you only have to migrate once.
* July 5, 2018: [https://blog.mozilla.org/addons/2018/07/05/extensions-in-firefox-62/ Extensions in Firefox 62]
*'''Cons:''' WebExtensions may not have all the APIs you need yet, so you might have to limit the functionality of your add-on until they become available. Please [http://bit.ly/webextensions-apis tell us] which APIs you need.
* May 17, 2018: [https://blog.mozilla.org/addons/2018/05/17/extensions-in-firefox-61/ Extensions in Firefox 61]
</li>
* April 2, 2018: [https://blog.mozilla.org/addons/2018/04/02/extensions-firefox-60/ Extensions in Firefox 60]
</ol>
* January 26, 2018: [https://blog.mozilla.org/addons/2018/01/26/extensions-firefox-59/ Extensions in Firefox 59]
 
* November 20, 2017: [https://blog.mozilla.org/addons/2017/11/20/extensions-in-firefox-58/ Extensions in Firefox 58]
=Managing the Impact=
* November 3, 2017: [https://blog.mozilla.org/addons/2017/11/03/keeping-tabs-tab-api/ Keeping Tabs on the Tab API]
*'''Tell us which APIs you need''' - We are making the process of providing needed APIs as open as possible. Please use [http://bit.ly/webextensions-apis this survey] to tell us which APIs you need in WebExtensions. This will help us prioritize and plan for what we need to support.  
* October 3, 2017: [https://blog.mozilla.org/addons/ Legacy Support on Firefox ESR]
 
* September 28, 2017: [https://blog.mozilla.org/addons/2017/09/28/webextensions-in-firefox-57/ WebExtensions in Firefox 57]
*'''WebExtensions Experiments (formerly Native.js)''' - We want to give developers a way to develop and experiment with APIs that go beyond what Chrome provides. To get involved, read about the project [https://wiki.mozilla.org/WebExtensions/Experiments here] and the corresponding [https://wiki.mozilla.org/WebExtensions/NewAPIs criteria] for evaluating new APIs.
* September 8, 2017: [https://blog.mozilla.org/addons/2017/09/08/last-chance-migrate-user-data/ Last Chance to Migrate Your Legacy Data]
 
* September 7, 2017: [https://blog.mozilla.org/addons/2017/09/07/tell-users-expect-webextensions-version/ Tell Your Users What To Expect in Your WebExtensions Version]
*'''Transition API proposal''' - There is also a proposal to allow SDK add-ons to access WebExtension APIs in order to ease the transition. You can take a look and add comments [https://docs.google.com/document/d/18KCEIohJdQBLsHW2A9HkaZKsXhVEIhk8qvSSzU2GkzA/edit here].
* August 11, 2017: [https://blog.mozilla.org/addons/2017/08/10/webextensions-firefox-56/ WebExtensions in Firefox 56]
 
* August 3, 2017: [https://blog.mozilla.org/addons/2017/08/03/extension-examples-see-apis-action/ Extension Examples: See the APIs in Action]
It is possible that not all add-ons will be able to migrate to WebExtensions without having to drop any features. But we want to work with you to get as many add-ons migrated as possible with the functionality you created intact. We invite you to contribute to its evolution, and we look forward to [https://wiki.mozilla.org/Add-ons/developer/communication#Get_in_Touch working with you].
*June 14, 2017: [https://blog.mozilla.org/addons/2017/06/14/webextensions-firefox-55/ WebExtensions in Firefox 55]
*May 16, 2017: [https://blog.mozilla.org/addons/2017/05/16/compatibility-firefox-55/ Add-on Compatibility for Firefox 55]
*May 10, 2017: [https://blog.mozilla.org/addons/2017/05/10/incompatible-change-sessions-restore-api-firefox-54/ Incompatible change to sessions.restore API in Firefox 54]
*Apr 3, 2017: [https://blog.mozilla.org/addons/2017/04/03/migrating-colorzilla-webextensions/ Migrating ColorZilla to WebExtensions]
*Mar 27, 2017: [https://blog.mozilla.org/addons/2017/03/27/update-compatibility-milestones/ Update on Compatibility Milestones]
*Mar 24, 2017: [https://blog.mozilla.org/addons/2017/03/24/migrating-adblock-firefox-webextensions/ Migrating AdBlock for Firefox to WebExtensons]
*Mar 17, 2017: [https://blog.mozilla.org/addons/2017/03/17/migrating-webextensions-dont-forget-users/ Migrating to WebExtensions? Don't Forget Your Users]
*Mar 13, 2017: [https://blog.mozilla.org/addons/2017/03/13/webextensions-firefox-54/ WebExtensions in Firefox 54]
*Mar 9, 2017: [https://blog.mozilla.org/addons/2017/03/09/office-hours-support-transitioning-porting-webextensions/ Office Hours Support for Transitioning and Porting to WebExtensions]
*Feb 16, 2017: [https://blog.mozilla.org/addons/2017/02/16/the-road-to-firefox-57-compatibility-milestones/ The Road to Firefox 57 – Compatibility Milestones]
*Jan 25, 2017: [https://blog.mozilla.org/addons/2017/01/25/webextensions-in-firefox-53/ WebExtensions in Firefox 53]
*Jan 20, 2017: [https://blog.mozilla.org/addons/2017/01/20/migrating-to-webextensions-port-your-stored-data/ Migrating to WebExtensions: port your stored data]
*Dec 16, 2016: [https://blog.mozilla.org/addons/2016/12/16/meet-some-nifty-new-webextensions/ Meet Some Nifty New WebExtensions]
*Nov 23, 2016: [https://blog.mozilla.org/addons/2016/11/23/add-ons-in-2017/ Add-ons in 2017]
*Nov 22, 2016: [https://blog.mozilla.org/addons/2016/11/22/webextensions-examples-and-hacktoberfest/ webextensions-examples and Hacktoberfest]
*Nov 18, 2016: [https://blog.mozilla.org/addons/2016/11/18/webextensions-in-firefox-52/ WebExtensions in Firefox 52]
*Nov 3, 2016: [https://blog.mozilla.org/addons/2016/11/03/more-ways-to-contribute-to-webextensions/ More ways to contribute to WebExtensions]
*Sep 29, 2016: [https://blog.mozilla.org/addons/2016/09/29/webextensions-in-firefox-51/ WebExtensions in Firefox 51]
*Sep 28, 2016: [https://blog.mozilla.org/addons/2016/09/28/migrating-an-sdk-add-on-to-multiprocess-firefox/ How Video DownloadHelper Became Compatible with Multiprocess Firefox]
*Sep 13, 2016: [https://blog.mozilla.org/addons/2016/09/13/webextensions-and-parity-with-chrome/ WebExtensions and parity with Chrome]
*Aug 25, 2016: [https://blog.mozilla.org/addons/2016/08/25/webextensions-in-firefox-50/ WebExtensions in Firefox 50]
*Aug 12, 2016: [https://blog.mozilla.org/addons/2016/08/12/webextensions-taking-root/ WebExtensions Taking Root]
*July 27, 2016: [https://blog.mozilla.org/addons/2016/07/27/linting-and-automatically-reloading-webextensions/ Linting and Automatically Reloading WebExtensions]
*July 21, 2016: [https://blog.mozilla.org/addons/2016/07/21/new-webextensions-guides-and-how-tos-on-mdn/ New WebExtensions Guides and How-tos on MDN]
*July 14, 2016: [https://blog.mozilla.org/addons/2016/07/14/webextensions-support-on-amo/ WebExtensions support on AMO]
*June 9, 2016: [https://blog.mozilla.org/addons/2016/06/09/webextensions-for-firefox-49/ WebExtensions in Firefox 49]
*May 9, 2016: [https://blog.mozilla.org/addons/2016/05/09/results-of-the-webextensions-api-survey/ Results of the WebExtensions API Survey]
*Apr 29, 2016: [https://blog.mozilla.org/addons/2016/04/29/webextensions-in-firefox-48/ WebExtensions in Firefox 48]
*Apr 26, 2016: [https://blog.mozilla.org/addons/2016/04/26/migrating-popup-alt-attribute-from-xulxpcom-to-webextensions/ Migrating Popup ALT Attribute from XUL/XPCOM to WebExtensions]
*Apr 14, 2016: [https://blog.mozilla.org/addons/2016/04/14/developing-extensions-with-web-ext-1-0/ Developing Extensions With Web-ext 1.0]
*Mar 30, 2016: [https://blog.mozilla.org/addons/2016/03/30/tinkering-with-webextensions/ Tinkering with WebExtensions]
*Mar 14, 2016: [https://blog.mozilla.org/addons/2016/03/14/webextensons-whats-in-it-for-developers/ Advantages of WebExtensions for Developers]
*Mar 11, 2016: [https://blog.mozilla.org/addons/2016/03/11/webextensions-in-firefox-47/ WebExtensions in Firefox 47]
*Feb 2, 2016: [https://blog.mozilla.org/addons/2016/02/02/webextensions-in-firefox-46/ WebExtensions in Firefox 46]
*Jan 9, 2016: [https://discourse.mozilla-community.org/t/webextensions-first-impressions/6459 WebExtensions First Impressions]
*Dec 21, 2015: [https://blog.mozilla.org/addons/2015/12/21/webextensions-in-firefox-45-2/ WebExtensions in Firefox 45]
*Aug 21, 2015: [https://blog.mozilla.org/addons/2015/08/21/the-future-of-developing-firefox-add-ons/ The Future of Developing Firefox Add-ons]


=Add-on Developer Communication Calendar=
=Add-on Developer Communication Calendar=
Line 79: Line 111:
}}
}}


=Blog Posts and Other Resources=
=Get in Touch=
*[https://blog.mozilla.org/addons/2015/08/21/the-future-of-developing-firefox-add-ons/ The Future of Developing Firefox Add-ons]
* [[Matrix]]:  
*[https://compatibility-lookup.services.mozilla.com/ Compatibility Lookup Tool]
** Add-ons:  support for extensions, themes, and API development
*[https://github.com/mdn/webextensions-examples Example add-ons created with WebExtensions APIs]
** Add-on Reviewers: add-on reviews and policy
 
** AMO: addons.mozilla.org bugs and development
==WebExtensions==
*Mar 30, 2016: [https://blog.mozilla.org/addons/2016/03/30/tinkering-with-webextensions/ Tinkering with WebExtensions]
*Mar 14, 2016: [https://blog.mozilla.org/addons/2016/03/14/webextensons-whats-in-it-for-developers/ Advantages of WebExtensions for Developers]
*Mar 11, 2016: [https://blog.mozilla.org/addons/2016/03/11/webextensions-in-firefox-47/ WebExtensions in Firefox 47]
*Feb 2, 2016: [https://blog.mozilla.org/addons/2016/02/02/webextensions-in-firefox-46/ WebExtensions in Firefox 46]
*Jan 9, 2016: [https://discourse.mozilla-community.org/t/webextensions-first-impressions/6459 WebExtensions First Impressions]
*Dec 21, 2015: [https://blog.mozilla.org/addons/2015/12/21/webextensions-in-firefox-45-2/ WebExtensions in Firefox 45]


==Multiprocess (e10s) Firefox Compatibility==
* Mailing List:  
*Nov 23, 2015: [https://blog.mozilla.org/addons/2015/11/23/test-your-add-ons-for-multi-process-firefox-compatibility/ Test your add-ons for Multi-process Firefox compatibility]
**[https://mail.mozilla.org/listinfo/dev-addons dev-addons] for general discussion
*MDN Article: [https://developer.mozilla.org/en-US/Add-ons/Working_with_multiprocess_Firefox Working with multiprocess Firefox]


==Migrating from XUL/XPCOM==
* More ways to get in touch:
*[https://bugzilla.mozilla.org/show_bug.cgi?id=1199718 native.js prototype]
** Blog: https://blog.mozilla.org/addons/
*[https://docs.google.com/document/d/18KCEIohJdQBLsHW2A9HkaZKsXhVEIhk8qvSSzU2GkzA/edit Transition API proposal]
** Forum: https://discourse.mozilla-community.org/c/add-ons


=Get in Touch=
== Meetings ==
* [[IRC|IRC]]:
** #teamaddons: team chat
** #addons:  support for extensions, themes, plugins and addons.mozilla.org
** #amo: addons.mozilla.org bugs and development
** #amo-editors: add-on reviews and policy
** #extdev: extension development
** #themedev: theme development
** #webextensions: web extensions


* Mailing List: [https://mail.mozilla.org/listinfo/dev-addons dev-addons]
Please see the add-ons main page [https://wiki.mozilla.org/Add-ons#Meetings Meetings section]
* Blog: https://blog.mozilla.org/addons/
* Forum: https://discourse.mozilla-community.org/c/add-ons

Latest revision as of 20:42, 20 February 2020

A Web-based API for Developing Extensions in Firefox

The WebExtensions API was introduced in 2016 as a stable, cross-browser platform that allows extension and theme authors to enhance the default Firefox browser. In November of 2017 it became the only officially supported extension API with the release of Firefox Quantum. The secure, sandboxed nature of the WebExtensions API means that not every legacy API can or will be available. Nevertheless, since its introduction, the WebExtensions API has grown with new features such as tab hiding and additional theme elements, all while maintaining near-complete compatibility with the Chrome extension API. Going forward, you can expect to see improvements in performance as well as additional features for user scripting, context menus, keyboard shortcuts and private browsing.

Keep an eye on the Add-ons Blog for more information on enhancements to the WebExtensions API in upcoming releases of Firefox or, if you want real-time detailed information on upcoming changes, follow the WebExtensions product in Bugzilla.

This page contains resources to help you port your legacy extension to use WebExtensions APIs. If you're looking for resources on creating a new extension, please head over to MDN.

About the WebExtensions API

Migration paths for developers of legacy add-ons

1) SDK add-on

Here is the comparison chart showing SDK APIs and their WebExtensions counterparts. If you don't see the APIs you need to port to WebExtensions, please take a look at some more options below.

2) XUL or XPCOM add-on

Here is the comparison chart showing XUL/XPCOM APIs and their WebExtensions counterparts. If you don't see the APIs you need to port to WebExtensions, please take a look at some more options below.

Don't See the WebExtensions APIs You Need?

  • If you're experienced with Mozilla infrastructure and would like to develop WebExtensions APIs directly for Firefox, here is a list of approved APIs that you can start contributing to.
  • If you want to prototype and tinker with WebExtensions APIs without having to build Firefox, WebExtensions Experiments is for you!
  • If you want to request a new WebExtensions API, please read this page.

Not all add-ons will be able to migrate to WebExtensions without having to drop any features. But we want to work with you to get as many add-ons migrated as possible with the functionality you created intact. We invite you to contribute to its evolution, and we look forward to working with you.

Tools

  • web-ext is a command line tool designed to speed up various parts of the WebExtension development process, making development faster and easier.
  • The Extension Compatibility Test is a utility that can test your Chrome extension's compatibility with Firefox. All you need to do is upload your .crx file.
  • WebExtensions Helper speeds up browser add-ons development by providing facilities for WebExtensions-based (Firefox, Chrome, Opera and Edge) extensions
  • webextensions.tech is a scaffolding UI tool for browser extensions. It lets you to input and select few parameters and outputs a complete boilerplate browser extension project.
  • Chrome Extension generator creates everything you need to get started with extension development. You can choose Browser UI(Browser,Page Action, Omnibox) type and select permissions you need.
  • Extensionizr is a wizard that helps you create a basic extension
  • Chrome Boilerplate
  • Skeleton Chrome Extension is an extension bootstrap and template

Documentation & Tutorials

Blog Posts

All WebExtensions blog posts are here.

Add-on Developer Communication Calendar

This calendar includes public meetings, scheduled blog posts, office hours, release milestones that affect add-on developers, and more. Links to add it to your own calendar: iCal | HTML

Error in widget Widget:Google Calendar: Unable to load template 'wiki:Widget:Google Calendar'

Get in Touch

  • Matrix:
    • Add-ons: support for extensions, themes, and API development
    • Add-on Reviewers: add-on reviews and policy
    • AMO: addons.mozilla.org bugs and development

Meetings

Please see the add-ons main page Meetings section

Retrieved from "https://wiki.allizom.org/index.php?title=Add-ons/developer/communication&oldid=1224052"