Features/Jetpack/Jetpack-Mobile-Simple-Prefs

Status

Team

Open issues/risks

`

Stage 1: Definition

1. Feature overview

As we continue to make sure that the APIs we have work with Firefox Mobile we are following a path that looks at our more popular add-ons to see which features are used most often in their creation. Preferences are essential to our most popular add-ons and should work seamlessly when the developer wishes to port their add-on to Mobile Firefox.

As we already have a simple-prefs API, this feature is to ensure that it works with Mobile Firefox. Our prefs are defined by the developer in JSON and can then be displayed in either XUL or the Native preferences dialog. As the preferences for Firefox itself are being displayed in the Native Android settings tool, it should likely follow that add-ons prefs also appear there. If there are issues with doing so, perhaps XUL or HTML can be considered instead.

2. Users & use cases

The Developer defines the preferences needed for their add-on in their package.json file. Those preferences are then converted upon run-time to a native preferences screen which allows those preferences to appear in the Native settings dialog below the other Firefox Preferences in an Add-on Settings option(with the add-on's name displayed).

3. Dependencies

`

4. Requirements

`

Non-goals

`

Stage 2: Design

5. Functional specification

`

6. User experience design

`

Stage 3: Planning

7. Implementation plan

`

8. Reviews

Security review

`

Privacy review

`

Localization review

`

Accessibility

`

Quality Assurance review

`

Operations review

`

Stage 4: Development

9. Implementation

`

Stage 5: Release

10. Landing criteria

`

Feature details

Team status notes