Files
webextensions-examples/favourite-colour/README.md
Andy McKay 17a58bc196 add in managed example (#287)
* add in managed example

* Updated favourite-colour README to point to the storage.managed documentation
2017-10-24 16:34:28 -07:00

24 lines
995 B
Markdown

# Favourite Colour
Shows and stores your favourite colour, in storage.sync in the about:addons page for the add-on.
Demonstrates:
* storing data with storage.sync
* reading data from storage.managed,
* creating an options page and opening it with `runtime.openOptionsPage()`.
To have Firefox read data from storage.managed, create a file with the following contents:
{
"name": "favourite-colour-examples@mozilla.org",
"description": "ignored",
"type": "storage",
"data": {
"colour": "management thinks it should be blue!"
}
}
Name the file `"favourite-colour-examples@mozilla.org.json"` and follow the instructions in the [`storage.managed` documentation](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API/storage/managed) to make the file discoverable by the extension (on OS X and Linux this means copying it to a specific location, while on Windows it means creating a specific registry key pointing to the file's location).