1415798 - Tutorials of "Implement a settings page" should use synced storage

Status: RESOLVED FIXED

(Developer Documentation Graveyard :: Add-ons, enhancement, P1)

Description

[Xidorn Quan [:xidorn] UTC+11]

The example in "Implement a settings page" is currently using code:
> function saveOptions(e) {
>   e.preventDefault();
>   browser.storage.local.set({
>     color: document.querySelector("#color").value
>   });
> }

However, I believe developers and users generally want to sync the options of addons across different devices, so I think this example code should really use storage.sync by default, and explain that developers can also use storage.local if they think some options are better kept locally in a note after.

(I'm not sure whether this matches the teams' thought, so I file a bug instead of editing the page directly.)

Comment 1

[Irene Smith (ismith)]

https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Implement_a_settings_page$edit

Updated the page so that the example uses storage.sync instead of storage.local
I also added the necessary id key to the manifest

Finally, modified the code description to talk about storage.syn and added a note that is possible to store settings in local storage instead.

Comment 2

[Irene Smith (ismith)]

(In reply to Irene Smith (ismith) from comment #1)
> https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/
> Implement_a_settings_page$edit
> 
> Updated the page so that the example uses storage.sync instead of
> storage.local
> I also added the necessary id key to the manifest
> 
> Finally, modified the code description to talk about storage.syn and added a
> note that is possible to store settings in local storage instead.

Wrong page link. Use:

https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Implement_a_settings_page

instead.

Comment 3

[Xidorn Quan [:xidorn] UTC+11]

Looks good to me.

Comment 4

[Irene Smith]

I'm marking this as resolved.