storage.local

Represents the local storage area. Items in local storage are local to the machine the add-on was installed on.

When the add-on is uninstalled, its associated local storage is cleared (note that in Firefox, this is only true from version 51 onwards).

Also in Firefox, you can prevent the browser from clearing local storage on uninstall by visiting "about:config" and setting the following two browser preferences to true: "keepUuidOnUninstall" and "keepStorageOnUninstall". This feature is provided to help developers test their add-on. WebExtensions themselves are not able to change these preferences.

Methods

The local object implements the methods defined on the storage.StorageArea type:

storage.StorageArea.get()
Retrieves one or more items from the storage area.
storage.StorageArea.getBytesInUse()
Gets the amount of storage space (in bytes) used one or more items being stored in the storage area.
storage.StorageArea.set()
Stores one or more items in the storage area. If the item already exists, its value will be updated. When you set a value, the storage.onChanged event will fire.
storage.StorageArea.remove()
Removes one or more items from the storage area.
storage.StorageArea.clear()
Removes all items from the storage area.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes Yes 45.0 48.0 33

Compatibility notes

Firefox

  • The storage API is supported in content scripts from version 48.

Acknowledgements

This API is based on Chromium's chrome.storage API. This documentation is derived from storage.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

 Contributors to this page: wbamberg, chrisdavidmills
 Last updated by: wbamberg,