The WebExtensions API reference provides detailed documentation on JavaScript APIs for developing web browser extensions. It covers browser API differences, usage examples, and a complete listing of JavaScript APIs available for extensions.
| API Name | Description |
|---|---|
action |
Modify and listen to clicks on the browser toolbar button defined with the action manifest key. |
alarms |
Schedule code to run at a future time, similar to setTimeout() and setInterval(). |
bookmarks |
Interact with and manipulate the browser's bookmarking system. |
browserAction |
Modify attributes and listen to clicks on the toolbar button defined with the browser_action key. |
browserSettings |
Modify certain global browser settings using BrowserSetting objects. |
browsingData |
Clear data accumulated during browsing. |
captivePortal |
Determine the captive portal state of the user's connection. |
clipboard |
Copy items to the system clipboard (currently supports images). |
commands |
Listen for user-executed commands registered using the commands manifest.json key. |
contentScripts |
Register content scripts to be injected into web pages matching specified URL patterns. |
contextualIdentities |
Manage contextual identities: list, create, remove, update. |
cookies |
Get, set, and remove cookies, and be notified when they change. |
declarativeNetRequest |
Specify conditions and actions to handle network requests declaratively. |
devtools |
Interact with the browser's Developer Tools. |
dns |
Resolve domain names. |
dom |
Access special extension-only DOM features. |
downloads |
Interact with the browser's download manager. |
events |
Common types used by APIs that dispatch events. |
extension |
Utilities related to your extension, such as getting URLs to resources and extension settings. |
extensionTypes |
Common types used in other WebExtension APIs. |
find |
Find and highlight text in a web page. |
history |
Interact with the browser history. |
i18n |
Internationalize your extension, providing localized strings. |
identity |
Obtain OAuth2 authorization codes or access tokens. |
idle |
Determine when the user's system is idle, locked, or active. |
management |
Get information about installed add-ons. |
menus |
Add items to the browser's menu system. |
notifications |
Display notifications using the operating system's notification mechanism. |
omnibox |
Implement customized behavior for the browser's address bar. |
pageAction |
Modify attributes and listen to clicks on the address bar button defined with the page_action key. |
permissions |
Request extra permissions at runtime. |
pkcs11 |
Enumerate PKCS #11 security modules and make them accessible as sources of keys and certificates. |
privacy |
Access and modify privacy-related browser settings. |
proxy |
Proxy web requests by intercepting and modifying them. |
runtime |
Access information about your extension and its environment. |
scripting |
Insert JavaScript and CSS into websites using two approaches. |
search |
Retrieve installed search engines and execute searches. |
sessions |
List and restore tabs and windows that were closed. |
sidebarAction |
Get and set properties of an extension's sidebar. |
storage |
Store and retrieve data, and listen for changes to stored items. |
tabs |
Interact with the browser's tab system. |
theme |
Get details of the browser's theme and update it. |
topSites |
Retrieve an array of frequently visited pages. |
types |
Define the BrowserSetting type for representing a browser setting. |
userScripts |
Register user scripts to manipulate webpages or provide new features. |
webNavigation |
Add event listeners for various stages of a navigation. |
webRequest |
Add event listeners for stages of making HTTP requests, including modification and cancellation. |
windows |
Interact with browser windows: get information, open, modify, and close them. |
