Skip to content

Commit 9db34bc

Browse files
authored
docs: update firefox storage api docs (PlasmoHQ#128)
* docs: update firefox storage api docs * docs: better wording for firefox storage api docs
1 parent 56bc8e9 commit 9db34bc

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

src/pages/framework/storage.mdx

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
description: A library that makes it easy to store data in your browser extension's storage.
33
---
44

5-
import { ShieldBanners } from "~components/shield-banners"
65
import { Callout } from "nextra-theme-docs"
76

7+
import { ShieldBanners } from "~components/shield-banners"
8+
89
# Storage API
910

1011
<ShieldBanners packageName="@plasmohq/storage" />
@@ -232,11 +233,11 @@ return <>
232233

233234
### Usage with Firefox
234235

235-
To use the storage API on Firefox during development you need to add an addon ID to your manifest, otherwise, you will get this error:
236+
To use the storage API on Firefox during development you need to add an Add-on ID to your manifest, otherwise, you will get this error:
236237

237238
> Error: The storage API will not work with a temporary addon ID. Please add an explicit addon ID to your manifest. For more information see https://mzl.la/3lPk1aE.
238239
239-
To add an addon ID to your manifest, add this to your package.json:
240+
To add an Add-on ID to your manifest, add this to your `package.json`:
240241

241242
```JSON
242243
"manifest": {
@@ -248,4 +249,14 @@ To add an addon ID to your manifest, add this to your package.json:
248249
}
249250
```
250251

251-
During development, you may use any ID. If you have published your extension, you can use the ID assigned by Mozilla Addons.
252+
The format of Add-on IDs differ between manifest versions.
253+
254+
- Manifest V2: `your-id@example.com`
255+
- Manifest V3: `{ed7ba470-8e54-465e-825c-99712043e01c}` (any UUID)
256+
257+
Once your extension is published, the Add-on ID defined in the `package.json` file _should_ be displayed in your extension's Developer Page under _"Technical Details > UUID"_.
258+
259+
**Note:** The Add-on ID used during development (i.e. the one defined in the manifest) will likely be the one Mozilla assigns to your when publishing. If it's not and one is
260+
generated for you, you will have to update the `package.json` file with the new ID.
261+
262+
Add-on IDs are unique and the same one cannot be used for multiple extensions (both manifest versions).

0 commit comments

Comments
 (0)