Add-ons

Index

Found 582 pages:

# Page Tags and summary
1 Add-ons Add-ons, Extension, Extensions, Landing, Mozilla
Add-ons allow developers to extend and modify the functionality of Firefox.
2 Browser Extensions Extensions, Landing, WebExtensions, add-on
Extensions can extend and modify the capability of a browser. Extensions for Firefox are built using the WebExtensions API, a cross-browser system for developing extensions. To a large extent the system is compatible with the extension API supported by Google Chrome and Opera and the W3C Draft Community Group. Extensions written for these browsers will in most cases run in Firefox or Microsoft Edge with just a few changes. The API is also fully compatible with multiprocess Firefox.
3 Add a button to the toolbar WebExtensions
Toolbar buttons are one of the main UI components available to extensions. Toolbar buttons live in the main browser toolbar and contain an icon. When the user clicks the icon, one of two things can happen:
4 Alternative distribution options Installation, Landing, WebExtensions, add-on
The standard add-on distribution and installation process is through Firefox using a signed XPI file obtained from addons.mozilla.org (AMO) (for listed add-ons) or a download set up by a developer (for unlisted add-ons).
5 Add-ons for desktop apps Add-ons, Desktop apps, Guide, Installation, WebExtensions
If you have developed an add-on to complement a desktop application, there are several ways you can install the add-on:
6 Add-ons in the enterprise Add-ons, Guide, Installation
As an enterprise IT administrator you may wish to install add-ons for your users automatically, this page discusses the options.
7 Sideloading add-ons Guide, Installation, Sideloading, WebExtensions
You may want to send a user your add-on’s XPI file by some means other than a web download, such as an email distribution of a beta version for user testing. In this case, there are two practical options for installing the add-on:
8 Anatomy of an extension WebExtensions
An extension consists of a collection of files, packaged for distribution and installation. In this article, we will quickly go through the files that might be present in an extension.
9 Browser actions WebExtensions
A browser action is a button you can add to the browser toolbar. Users can click the button to interact with your extension.
10 Browser compatibility for manifest.json Add-ons, WebExtensions, manifest.json
No summary!
11 Browser support for JavaScript APIs WebExtensions
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
12 Chrome incompatibilities WebExtensions
Extensions built with WebExtension APIs are designed to be compatible with Chrome and Opera extensions: as far as possible, extensions written for those browsers should run on Firefox with minimal changes.
13 Comparison with XUL/XPCOM extensions WebExtensions
This article is a technical comparison between the WebExtensions technology and "classic" extensions developed using direct XUL manipulation and direct access to XPCOM. It's intended to help orient people who maintain an add-on like this, and who are planning to port it to use WebExtension APIs.
14 Comparison with the Add-on SDK Addon SDK, AddonSDK, WebExtensions, porting
The basic structure and concepts of the Add-on SDK are shared by WebExtensions. Both technologies include:
15 Content Security Policy WebExtensions
Content Security Policy (CSP) is a mechanism to help prevent websites from inadvertantly executing malicious content. A website specifies a CSP using an HTTP header sent from the server. The CSP is mostly concerned with specifying legitimate sources of various types of content, such as scripts or embedded plugins. For example, a website can use it to specify that the browser should only execute JavaScript served from the website itself, and not from any other sources. A CSP can also instruct the browser to disallow potentially unsafe practices, such as the use of eval().
16 Content scripts WebExtensions
A content script is a part of your extension that runs in the context of a particular web page (as opposed to background scripts which are part of the extension, or scripts which are part of the web site itself, such as those loaded using the <script> element).
17 Debugging WebExtensions
This article explains how you can use the Firefox developer tools to debug extensions built with WebExtension APIs.
18 Debugging (before Firefox 50)
This article explains how you can use the built-in Firefox developer tools to debug extensions developed with WebExtension APIs. If you're trying to debug an add-on developed with the Add-on SDK, please see the guide to the Add-on Debugger.
19 Developing extensions for Firefox for Android Beginner, Guide, Mobile, WebExtensions
You will approach the coding of an extension for Firefox for Android in the same way as you would for a desktop extension using WebExtension APIs; using a text editor or tool of your choice to write the code. However, when you get to testing and debugging your extension you need to follow a different process, this article walks you through that process.
20 Differences between desktop and Android extensions Guide, Mobile, WebExtensions
Firefox for Android offers a subset of the WebExtensions APIs available to the desktop version of Firefox. Some of these differences are due to the nature of the Android environment and therefore the features Firefox can implement, others are where Firefox for Android does not yet offer all the desktop features. This article describes and explains these differences and looks at the impact they might have on your add-on development.
21 Embedded WebExtensions WebExtensions
Starting in Firefox 51, you can embed a WebExtension in a classic bootstrapped extension or an Add-on SDK add-on.
22 Example extensions WebExtensions
To help illustrate how to develop extensions, we maintain a repository of simple example extensions at https://github.com/mdn/webextensions-examples. This article describes the WebExtension APIs used in that repository.
23 Extending the developer tools
You can use WebExtensions APIs to extend the browser's built-in developer tools. To create a devtools extension, include the "devtools_page" key in manifest.json:
24 Extensions and the add-on ID WebExtensions
Firefox add-ons contain a unique identifier which is used both inside Firefox itself and on the addons.mozilla.org (AMO) website. For example, it's used by Firefox to check for updates to installed add-ons and to identify which objects (such as data stores) are controlled by this add-on.
25 Getting started with web-ext Guide, Installing, Testing, Tools, WebExtension, packaging, web-ext
web-ext is a command line tool designed to speed up various parts of the extension development process, making development faster and easier. This article explains how to install and use web-ext.
26 Implement a settings page WebExtensions
A settings page gives users a way to see and change settings (sometimes also called "preferences" or "options") for the extension.
27 Interact with the clipboard WebExtensions
Extensions built using WebExtension APIs can interact with the system clipboard using document.execCommand():
28 Intercept HTTP requests Add-ons, Extensions, How-to, WebExtensions
To intercept HTTP requests, use the webRequest API. This API enables you to add listeners for various stages of making an HTTP request. In the listeners, you can:
29 Internationalization Article, Guide, Internationalization, Localization, WebExtensions, i18n, messages.json, placeholders, predefined messages
The WebExtensions API has a rather handy module available for internationalizing extensions — i18n. In this article we'll explore its features and provide a practical example of how it works. The i18n system for extensions built using WebExtension APIs is similar to common JavaScript libraries for i18n such as i18n.js.
30 JavaScript APIs WebExtensions
No summary!
31 alarms
Schedule code to run at a specific time in the future. This is like setTimeout() and setInterval(), except that those functions don't work with background pages that are loaded on demand.
32 alarms.Alarm API, Add-ons, Extensions, Non-standard, Reference, Type, WebExtensions, alarm, alarms
Information about a single alarm. This object is returned from alarms.get() and alarms.getAll(), and is passed into the alarms.onAlarm listener.
33 alarms.clear() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, alarms, clear
Cancels an alarm, given its name.
34 alarms.clearAll() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, alarms, clearAll
Cancels all active alarms.
35 alarms.create() API, Add-ons, Create, Extensions, Method, Non-standard, Reference, WebExtensions, alarms
Creates a new alarm.
36 alarms.get() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, alarms, get
Gets an alarm, given its name.
37 alarms.getAll() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, alarms, getAll
Gets all active alarms for the extension.
38 alarms.onAlarm API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, alarms, onAlarm
Fired when any alarm set by the extension goes off.
39 bookmarks API, Add-ons, Bookmarks, Extensions, Interface, Non-standard, Reference, WebExtensions
The WebExtensions bookmarks API lets an extension interact with and manipulate the browser's bookmarking system. You can use it to bookmark pages, retrieve existing bookmarks, and edit, remove, and organize bookmarks.
40 bookmarks.BookmarkTreeNode API, Add-ons, BookmarkTreeNode, Bookmarks, Extensions, Non-standard, Reference, Type, WebExtensions
An object of type bookmarks.BookmarkTreeNode represents a node in the bookmark tree, where each node is a bookmark, a bookmark folder, or a separator. Child nodes are ordered by an index within their respective parent folders.
41 bookmarks.BookmarkTreeNodeType API, Add-ons, BookmarkTreeNodeType, Bookmarks, Extensions, Property, Reference, WebExtensions
The bookmarks.BookmarkTreeNodeType type is used to describe whether a node in the bookmark tree is a bookmark, a folder, or a separator.
42 bookmarks.BookmarkTreeNodeUnmodifiable API, Add-ons, BookmarkTreeNodeUnmodifiable, Bookmarks, Extensions, Non-standard, Reference, Type, WebExtensions
The bookmarks.BookmarkTreeNodeUnmodifiable type is used to indicate the reason that a node in the bookmark tree (where each node is either a bookmark or a bookmark folder) cannot be changed. This is used as the value of the bookmarks.BookmarkTreeNode.unmodifiable.unmodifiable field on bookmark nodes.
43 bookmarks.CreateDetails API, Add-ons, Bookmarks, CreateDetails, Extensions, Non-standard, Reference, Type, WebExtensions
The CreateDetails type is used to describe the properties of a new, bookmark, bookmark folder, or separator when calling the bookmarks.create() method.
44 bookmarks.create() API, Add-ons, Bookmarks, Create, Extensions, Method, Non-standard, Reference, WebExtensions
Creates a bookmark or folder as a child of the BookmarkTreeNode with the specified parentId. To create a folder, omit or leave empty the CreateDetails.url parameter.
45 bookmarks.get() API, Add-ons, Bookmarks, Extensions, Method, Non-standard, Reference, WebExtensions, get
Given the ID of a bookmarks.BookmarkTreeNode or an array of such IDs, the bookmarks.get() method retrieves the matching nodes.
46 bookmarks.getChildren() API, Add-ons, Bookmarks, Extensions, Method, Non-standard, Reference, WebExtensions, getChildren
bookmarks.getChildren() retrieves all the immediate children of a given bookmark folder, identified as a BookmarkTreeNode ID.
47 bookmarks.getRecent() API, Add-ons, Bookmarks, Extensions, Method, Non-standard, Reference, WebExtensions, getRecent
The bookmarks.getRecent() method retrieves a specified number of the most recently added bookmarks as an array of BookmarkTreeNode objects.
48 bookmarks.getSubTree() API, Add-ons, Bookmarks, Extensions, Method, Non-standard, Reference, WebExtensions, getSubTree
The bookmarks.getSubTree() method asynchronously retrieves a bookmarks.BookmarkTreeNode, given its ID.
49 bookmarks.getTree() API, Add-ons, Bookmarks, Extensions, Method, Non-standard, Reference, WebExtensions, getTree
bookmarks.getTree() returns an array containing the root of the bookmarks tree as a bookmarks.BookmarkTreeNode object.
50 bookmarks.move() API, Add-ons, Bookmarks, Extensions, Method, Non-standard, Reference, WebExtensions, move
The bookmarks.move() method moves the specified BookmarkTreeNode to the specified destination within the tree of bookmarks. This lets you move a bookmark to a new folder and/or position within the folder.
51 bookmarks.onChanged API, Add-ons, Bookmarks, Event, Extensions, Non-standard, Reference, WebExtensions, onChanged
Fired when there is a change to:
52 bookmarks.onChildrenReordered API, Add-ons, Bookmarks, Event, Extensions, Non-standard, Reference, WebExtensions, onChildrenReordered
Fired when the children of a folder have changed their order due to the order being sorted in the UI. This is not called as a result of a call to bookmarks.move() or a drag operation in the UI.
53 bookmarks.onCreated API, Add-ons, Bookmarks, Event, Extensions, Non-standard, Reference, WebExtensions, onCreated
Fired when a bookmark item (a bookmark or a folder) is created.
54 bookmarks.onImportBegan API, Add-ons, Bookmarks, Event, Extensions, Non-standard, Reference, WebExtensions, onImportBegan
Fired when the browser has started importing a set of bookmarks.
55 bookmarks.onImportEnded API, Add-ons, Bookmarks, Event, Extensions, Non-standard, Reference, WebExtensions, onImportEnded
Fired when the browser has finished importing a set of bookmarks.
56 bookmarks.onMoved API, Add-ons, Bookmarks, Event, Extensions, Non-standard, Reference, WebExtensions, onMoved
Fired when a bookmark or folder is moved to a different parent folder and/or position within a folder.
57 bookmarks.onRemoved API, Add-ons, Bookmarks, Event, Extensions, Non-standard, Reference, WebExtensions, onRemoved
Fired when a bookmark or folder is removed. When a folder is removed recursively, a single notification is fired for the folder, and none for its contents.
58 bookmarks.remove() API, Add-ons, Bookmarks, Extensions, Method, Non-standard, Reference, WebExtensions, remove
The bookmarks.remove() method removes a single bookmark or an empty bookmark folder.
59 bookmarks.removeTree() API, Add-ons, Bookmarks, Extensions, Method, Non-standard, Reference, WebExtensions, removeTree
The bookmarks.removeTree() method recursively removes a bookmark folder and all of its contents.
60 bookmarks.search() API, Add-ons, Bookmarks, Extensions, Method, Non-standard, Reference, Search, WebExtensions
The bookmarks.search() function searches for bookmark tree nodes matching the given query.
61 bookmarks.update() API, Add-ons, Bookmarks, Extensions, Method, Non-standard, Reference, Update, WebExtensions
bookmarks.update() updates the title and/or URL of a bookmark, or the name of a bookmark folder.
62 browserAction API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, browserAction
Adds a button to the browser's toolbar.
63 browserAction.ColorArray API, Add-ons, ColorArray, Extensions, Non-standard, Reference, Type, WebExtensions, browserAction
An array of four integers in the range 0-255, defining an RGBA color. The four values specify the following channels:
64 browserAction.ImageDataType API, Add-ons, Extensions, ImageDataType, Non-standard, Reference, Type, WebExtensions, browserAction
Pixel data for an image. Must be an ImageData object (for example, from a <canvas> element).
65 browserAction.disable() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, browserAction, disable
Disables the browser action for a tab, meaning that it cannot be clicked when that tab is active.
66 browserAction.enable() API, Add-ons, Enable, Extensions, Method, Non-standard, Reference, WebExtensions, browserAction
Enables the browser action for a tab. By default, browser actions are enabled for all tabs.
67 browserAction.getBadgeBackgroundColor() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, browserAction, getBadgeBackgroundColor
Gets the background color of the browser action's badge.
68 browserAction.getBadgeText() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, browserAction, getBadgeText
Gets the browser action's badge text.
69 browserAction.getPopup() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, browserAction, getPopup
Gets the HTML document set as the popup for this browser action.
70 browserAction.getTitle() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, browserAction, getTitle
Gets the browser action's title.
71 browserAction.onClicked API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, browserAction, onClicked
Fired when a browser action icon is clicked. This event will not fire if the browser action has a popup.
72 browserAction.openPopup() API, Add-ons, Extensions, Non-standard, Reference, WebExtensions, browserAction, openPopup
None.
73 browserAction.setBadgeBackgroundColor() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, browserAction, setBadgeBackgroundColor
Sets the background color for the badge. Tabs without a specific badge background color will inherit the global badge background color, which defaults to [217, 0, 0, 255] in Firefox.
74 browserAction.setBadgeText() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, browserAction, setBadgeText
Sets the badge text for the browser action. The badge is displayed on top of the icon.
75 browserAction.setIcon() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, browserAction, setIcon
Sets the icon for the browser action.
76 browserAction.setPopup() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, browserAction, setPopup
Sets the HTML document that will be opened as a popup when the user clicks on the browser action's icon. Tabs without a specific popup will inherit the global popup, which defaults to the default_popup specified in the manifest.
77 browserAction.setTitle() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, browserAction, setTitle
Sets the browser action's title. The title is displayed in a tooltip over the browser action's icon. You can pass a tabId in as an optional parameter — if you do this then the title is changed only for the given tab. Tabs without a specific title will inherit the global title text, which defaults to the default_title or name specified in the manifest.
78 browserSettings API, Add-ons, Extensions, Non-standard, Reference, WebExtensions, browserSettings
No summary!
79 browserSettings.allowPopupsForUserEvents API, Add-ons, Extensions, Property, WebExtensions, allowPopupsForUserEvents, browserSettings
A BrowserSetting object that can be used to enable or disable the ability of web pages to open popups in response to user actions.
80 browserSettings.cacheEnabled API, Add-ons, Extensions, Property, Reference, WebExtensions, browserSettings, cacheEnabled
A BrowserSetting object that can be used to globally enable or disable the browser cache.
81 browserSettings.homepageOverride API, Add-ons, Extensions, Property, Reference, WebExtensions, browserSettings, homepageOverride
A BrowserSetting object that can be used to get a string representing the URL currently set as the browser's homepage.
82 browserSettings.imageAnimationBehavior API, Add-ons, Extensions, Property, Reference, browserSettings, imageAnimationBehavior
A BrowserSetting object that can be used to change the way the browser handles animated images, such as GIFs.
83 browserSettings.newTabPageOverride API, Add-ons, Extensions, Property, Reference, WebExtensions, browserSettings, newTabPageOverride
A BrowserSetting object that can be used to get a string representing the URL for the "new tab" page: that is, the page that's loaded when the user opens a new empty tab.
84 browserSettings.webNotificationsDisabled API, Add-ons, Extensions, Property, Reference, WebExtensions, browserSettings, webNotificationsDisabled
A BrowserSetting object that can be used to prevent websites from showing notifications using the Notifications Web API.
85 browsingData API, Add-ons, Extensions, Non-standard, Reference, WebExtensions, browsingData
Enables extensions to clear the data that is accumulated while the user is browsing.
86 browsingData.DataTypeSet API, Add-ons, DataTypeSet, Extensions, Reference, Type, WebExtensions, browsingData
The browsingData.DataTypeSet type describes a set of data types.
87 browsingData.RemovalOptions API, Add-ons, Extensions, Reference, RemovalOptions, Type, WebExtensions, browsingData
The browsingData.RemovalOptions type contains options to control certain aspects of browsing data removal.
88 browsingData.remove() API, Add-ons, Extensions, Method, Reference, WebExtensions, browsingData, remove
Removes the specified browsing data.
89 browsingData.removeCache() API, Add-ons, Extensions, Method, Reference, WebExtensions, browsingData, removeCache
Clears the browser's cache.
90 browsingData.removeCookies() API, Add-ons, Extensions, Method, Reference, WebExtensions, browsingData, removeCookies
Clears the browser's cookies.
91 browsingData.removeDownloads() API, Add-ons, Extensions, Method, Reference, WebExtensions, browsingData, removeDownloads
Clears the browser's download history. Note that this does not delete the downloaded objects themselves, only records of downloads in the browser's history.
92 browsingData.removeFormData() API, Add-ons, Extensions, Method, Reference, WebExtensions, browsingData, removeDownloads
Clears data that the browser has saved for autofilling forms.
93 browsingData.removeHistory() API, Add-ons, Extensions, Method, Reference, WebExtensions, browsingData, removeHistory
Clears the record of web pages that the user has visited (browsing history).
94 browsingData.removeLocalStorage() API, Add-ons, Extensions, Method, Reference, WebExtensions, browsingData, removeLocalStorage
Clears any local storage created by websites.
95 browsingData.removePasswords() API, Add-ons, Extensions, Method, Reference, WebExtensions, browsingData, removePasswords
Clears saved passwords.
96 browsingData.removePluginData() API, Add-ons, Extensions, Method, Reference, WebExtensions, browsingData, removePluginData
Clears data stored by browser plugins.
97 browsingData.settings() API, Add-ons, Extensions, Method, Reference, Settings, WebExtensions, browsingData
Browsers have a built-in "Clear History" feature, which enables the user to clear various types of browsing data. This has a UI that enables the user to select what type of data to remove (e.g. history, downloads, ...) and how far back in time to remove data.
98 clipboard API, Add-ons, Clipboard, Extensions, Reference, WebExtensions
The clipboard API enables an extension to copy items to the system clipboard. Currently the API only supports copying images, but it's intended to support copying text and HTML in the future.
99 clipboard.setImageData() API, Add-ons, Clipboard, Extensions, Method, Reference, WebExtensions, setImageData
Copies an image to the clipboard. The image is re-encoded before it is written to the clipboard. If the image is invalid, the clipboard is not modified.
100 commands API, Add-ons, Extensions, Non-standard, Reference, WebExtensions, commands
Listen for the user executing commands that you have registered using the commands manifest.json key.
101 Command API, Add-ons, Command, Extensions, Non-standard, Reference, Type, WebExtensions, commands
Information about a command. This contains the information specified for the command in the commands manifest.json key.
102 getAll() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, commands, getAll
Gets all commands for the extention that you have registered using the commands manifest.json key.
103 onCommand API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, commands, onCommand
Events have three functions:
104 contentScripts
Use this API to register content scripts. Registering a content script instructs the browser to insert the given content scripts into pages that match the given URL patterns.
105 contentScripts.RegisteredContentScript API, Extensions, Reference, RegisteredContentScript, Type, contentScripts
RegisteredContentScript is returned by a call to contentScripts.register() and represents the content scripts registered in that call.
106 contentScripts.RegisteredContentScript.unregister() API, Extensions, Reference, RegisteredContentScript.unregister, contentScripts
None.
107 contentScripts.register() API, Extensions, Method, Reference, contentScripts, register
Use this function to register one or more content scripts.
108 contextualIdentities WebExtensions
Work with contextual identities: list, create, remove, and update contextual identities.
109 contextualIdentities.create() API, Add-ons, Create, Extensions, Method, Reference, WebExtensions, contextualIdentities
Creates a new contextual identity. Once created, the user will be able to create new tabs belonging to this contextual identity, just as they can with the built-in identities.
110 contextualIdentities.get() API, Add-ons, Extensions, Method, Reference, WebExtensions, contextualIdentities, get
Gets information about a contextual identity, given its cookie store ID.
111 contextualIdentities.onCreated API, APIReference, Add-ons, Event, Extensions, WebExtensions, contextualIdentities, onCreated
Fired when a new contextual identity is created. Contextual identities may be created by extensions using the contextualIdentities API, or directly by the user, using the browser's user interface.
112 contextualIdentities.onRemoved API, Add-ons, Event, Extensions, Reference, WebExtensions, contextualIdentities, onRemoved
Fired when a new contextual identity is removed. Contextual identities may be removed by extensions using the contextualIdentities API, or directly by the user, using the browser's user interface.
113 contextualIdentities.onUpdated API, Add-ons, Event, Extensions, Reference, WebExtensions, contextualIdentities, onUpdated
Fired when the properties of a contextual identity, such as its name, icon, or color, are changed. Contextual identities may be updated by extensions using the contextualIdentities API, or directly by the user, using the browser's user interface.
114 contextualIdentities.query() API, Add-ons, Extensions, Method, Reference, WebExtensions, contextualIdentities, query
Gets information about all contextual identities, or about those contextual identities that match a given filter argument.
115 contextualIdentities.remove() API, Add-ons, Extensions, Method, Reference, WebExtensions, contextualIdentities, remove
Removes a contextual identity, given its cookie store ID.
116 contextualIdentities.update() API, Add-ons, Extensions, Method, Reference, Update, WebExtensions, contextualIdentities
Updates properties of a contextual identity, given its cookie store ID.
117 contextualIdentitities.ContextualIdentity API, Add-ons, ContextualIdentity, Extensions, Reference, Type, WebExtensions, contextualIdentities
The contextualIdentities.ContextualIdentity type describes a single contextual identity.
118 cookies API, Add-ons, Cookies, Extensions, Interface, Non-standard, Reference, WebExtensions
Enables extensions to get and set cookies, and be notified when they change.
119 cookies.Cookie API, Add-ons, Cookies, Extensions, Non-standard, Reference, Type, WebExtensions, cookie
The Cookie type of the cookies API represents information about an HTTP cookie.
120 cookies.CookieStore API, Add-ons, CookieStore, Cookies, Extensions, Non-standard, Reference, Type, WebExtensions
The CookieStore type of the cookies API represents a cookie store in the browser.
121 cookies.OnChangedCause API, Add-ons, Cookies, Extensions, Non-standard, OnChangedCause, Reference, Type, WebExtensions
The OnChangedCause type of the cookies API represents the reason a cookie changed.
122 cookies.get() API, Add-ons, Cookies, Extensions, Method, Non-standard, Reference, WebExtensions, get
The get() method of the cookies API retrieves information about a single cookie, given its name and URL.
123 cookies.getAll() API, Add-ons, Cookies, Extensions, Method, Non-standard, Reference, WebExtensions, getAll
The getAll() method of the cookies API retrieves all cookies from a single cookie store that match the given information.
124 cookies.getAllCookieStores() API, Add-ons, Cookies, Extensions, Method, Non-standard, Reference, WebExtensions, getAllCookieStores
The getAllCookieStores() method of the cookies API returns a list of all cookie stores.
125 cookies.onChanged API, Add-ons, Cookies, Event, Extensions, Non-standard, Reference, WebExtensions, onChanged
The onChanged event of the cookies API is fired when a cookie is set or removed.
126 cookies.remove() API, Add-ons, Cookies, Extensions, Method, Non-standard, Reference, WebExtensions, remove
The remove() method of the cookies API deletes a cookie, given its name and URL.
127 cookies.set() API, Add-ons, Cookies, Extensions, Method, Non-standard, Reference, WebExtensions, set
The set() method of the cookies API sets a cookie containing the specified cookie data. This method is equivalent to issuing an HTTP Set-Cookie header during a request to a given URL.
128 devtools.inspectedWindow API, Add-ons, Extensions, Reference, WebExtensions, devtools.inspectedWindow
The devtools.inspectedWindow API lets a devtools extension interact with the window that the developer tools are attached to.
129 devtools.inspectedWindow.eval() API, Add-ons, Extensions, Reference, WebExtensions, devtools.inspectedWindow, eval
Executes JavaScript in the window that the devtools are attached to.
130 devtools.inspectedWindow.reload() API, Add-ons, Extensions, Reference, WebExtensions, devtools.inspectedWindow, reload
Reloads the window that the devtools are attached to.
131 devtools.inspectedWindow.tabId API, Add-ons, Extensions, Reference, WebExtensions, devtools.inspectedWindow, tabId
The ID of the tab that this instance of the devtools is attached to, represented as a number.
132 devtools.network API, Add-ons, Extensions, Reference, WebExtensions, devtools.network
The devtools.network API lets a devtools extension get information about network requests associated with the window that the devtools are attached to (the inspected window).
133 devtools.network.onNavigated API, Add-ons, Extensions, Reference, WebExtensions, devtools.network
Fired when the user navigates the inspected window to a new page.
134 devtools.panels API, Add-ons, Extensions, Reference, WebExtensions, devtools.panels
The devtools.panels API lets a devtools extension define its user interface inside the devtools window.
135 devtools.panels.ElementsPanel API, Add-ons, DevTools, Extensions, Reference, WebExtensions, devtools.panels, devtools.panels.ElementsPanel
An ElementsPanel represents the HTML/CSS inspector in the browser's devtools. This is called the Page Inspector in Firefox and the Elements panel in Chrome.
136 devtools.panels.ElementsPanel.createSidebarPane() API, Add-ons, DevTools, Extensions, Reference, WebExtensions, createSidebarPane, devtools.panels
Adds a new pane to the sidebar in the HTML/CSS inspector.
137 onSelectionChanged API, Add-ons, DevTools, Extensions, Reference, WebExtensions, devtools.panels, devtools.panelsElementsPanel
Fires when the user selects a different page element for inspection with the browser's developer tools, for example by selecting the "Inspect Element" context menu item in Firefox.
138 devtools.panels.ExtensionPanel API, Add-ons, Extensions, Reference, WebExtensions, devtools.panels
An ExtensionPanel represents a panel added to the devtools. It's the resolution of the Promise returned by browser.devtools.panels.create().
139 devtools.panels.ExtensionSidebarPane API, Add-ons, DevTools, Extensions, Reference, WebExtensions, devtools.panels, devtools.panels.ExtensionSidebarPane
The ExtensionSidebarPane object represents a pane that an extension has added to the sidebar in the browser's HTML/CSS inspector.
140 devtools.panels.ElementsPanel.setExpression() API, Add-ons, Extensions, Reference, WebExtensions, devtools.panels, setExpression
Evaluates an expression in the context of the inspected page, and displays the result in the extension sidebar pane.
141 devtools.panels.ExtensionSidebarPane.onHidden
Called when the sidebar pane becomes hidden, as a result of the user switching away from it.
142 devtools.panels.ExtensionSidebarPane.onShown API, Add-ons, ExtensionSidebarPane, Extensions, Reference, WebExtensions, devtools.panels, onShown
Fired when the sidebar pane becomes visible as a result of the user switching to it.
143 devtools.panels.ExtensionSidebarPane.setObject() API, Add-ons, Extensions, Reference, WebExtensions, devtools.panels, setObject
Displays a JSON object in the extension's sidebar pane.
144 devtools.panels.create() API, Add-ons, Create, Extensions, Reference, WebExtensions, devtools.panels
Adds a new panel to the devtools.
145 devtools.panels.elements API, Add-ons, Elements, Extensions, Reference, WebExtensions, devtools.panels
An ElementsPanel object, which represents the browser's HTML/CSS inspector.
146 devtools.panels.onThemeChanged API, Add-ons, DevTools, Reference, WebExtensions, devtools.panels, onThemeChanged
Fired when the devtools theme changes.
147 devtools.panels.themeName API, Add-ons, DevTools, Reference, WebExtensions, devtools.panels, themeName
The name of the currently selected devtools theme.
148 downloads API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, downloads
Enables extensions to interact with the browser's download manager. You can use this API module to download files, cancel, pause, resume downloads, and show downloaded files in the file manager.
149 downloads.BooleanDelta API, Add-ons, BooleanDelta, Extensions, Non-standard, Reference, Type, WebExtensions, downloads
The BooleanDelta type of the downloads API represents the difference between two booleans.
150 downloads.DangerType API, Add-ons, DangerType, Extensions, Non-standard, Reference, Type, WebExtensions, downloads
The DangerType type of the downloads API defines a set of possible reasons that a downloadable file might be considered dangerous.
151 downloads.DoubleDelta API, Add-ons, DoubleDelta, Extensions, Non-standard, Reference, Type, WebExtensions, downloads
The DoubleDelta type of the downloads API represents the difference between two doubles.
152 downloads.DownloadItem API, Add-ons, DownloadItem, Extensions, Non-standard, Reference, Type, WebExtensions, downloads
The DownloadItem type of the downloads API represents a downloaded file.
153 downloads.DownloadQuery API, Add-ons, DownloadQuery, Extensions, Non-standard, Reference, Type, WebExtensions, downloads
The DownloadQuery type of the downloads API defines a set of parameters that can be used to search the downloads manager for a specific set of downloads.
154 downloads.DownloadTime API, Add-ons, DownloadTime, Extensions, Non-standard, Reference, Type, WebExtensions, downloads
The DownloadTime type of the downloads API represents the time a download took to complete.
155 downloads.FilenameConflictAction API, Add-ons, Extensions, FilenameConflictAction, Non-standard, Reference, Type, WebExtensions, downloads
The FilenameConflictAction type of the downloads API specifies what to do if the name of a downloaded file conflicts with an existing file.
156 downloads.InterruptReason API, Add-ons, Extensions, InterruptReason, Non-standard, Reference, Type, WebExtensions, downloads
The InteruptReason type of the downloads API defines a set of possible reasons why a download was interrupted.
157 downloads.State API, Add-ons, Extensions, Non-standard, Reference, Type, WebExtensions, downloads, state
The State type of the downloads API defines different states that a current download can be in.
158 downloads.StringDelta API, Add-ons, Extensions, Non-standard, Reference, StringDelta, Type, WebExtensions, downloads
The StringDelta type of the downloads API represents the difference between two strings.
159 downloads.acceptDanger() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, acceptDanger, downloads
The acceptDanger() function of the downloads API prompts the user to either accept or cancel a potentially dangerous download.
160 downloads.cancel() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, cancel, downloads
The cancel() function of the downloads API cancels a download. The call will fail if the download is not active: for example, because it has completed downloading.
161 downloads.download() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, download, downloads
The download() function of the downloads API downloads a file, given its URL and other optional preferences.
162 downloads.drag() API, Add-ons, Drag, Extensions, Method, Non-standard, Reference, WebExtensions, downloads
The drag() function of the downloads API initiates dragging the downloaded file to another application.
163 downloads.erase() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, downloads, erase
The erase() function of the downloads API erases matching DownloadItems from the browser's download history, without deleting the downloaded files from disk.
164 downloads.getFileIcon() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, downloads, getFileIcon
The getFileIcon() function of the downloads API retrieves an icon for the specified download.
165 downloads.onChanged API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, downloads, onChanged
The onChanged() event of the downloads API is fired when any of a downloads.DownloadItem's properties changes (except for bytesReceived).
166 downloads.onCreated API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, downloads, onCreated
The onCreated() event of the downloads API fires when a download begins, i.e. when downloads.download() is sucessfully invoked.
167 downloads.onErased API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, downloads, onErased
The onErased() event of the downloads API fires when a download is erased from the browser history.
168 downloads.open() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, downloads, open
The open() function of the downloads API opens the downloaded file with its associated application. A downloads.onChanged event will fire when the item is opened for the first time.
169 downloads.pause() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, downloads, pause
The pause() function of the downloads API pauses a download.
170 downloads.removeFile() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, downloads, removeFile
The removeFile() function of the downloads API removes a downloaded file from disk.
171 downloads.resume() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, downloads, resume
The resume() function of the downloads API resumes a paused download. If the request was successful, the download will be unpaused and progress will resume. The resume() call will fail if the download is not active: for example, because it has finished downloading.
172 downloads.search() API, Add-ons, Extensions, Method, Non-standard, Reference, Search, WebExtensions, downloads
The search() function of the downloads API queries the DownloadItems available in the browser's downloads manager, and returns those that match the specified search criteria.
173 downloads.setShelfEnabled() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, downloads, setShelfEnabled
The setShelfEnabled() function of the downloads API enables or disables the gray shelf at the bottom of every window associated with the current browser profile. The shelf will be disabled as long as at least one extension has disabled it.
174 downloads.show() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, downloads, show
The show() function of the downloads API shows the downloaded file in its containing folder in the underlying platform's file manager.
175 downloads.showDefaultFolder() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, downloads, showDefaultFolder
The showDefaultFolder() function of the downloads API opens the default downloads folder in the platform's file manager.
176 events API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, events
Common types used by APIs that dispatch events.
177 events.Event API, Add-ons, Event, Extensions, Non-standard, Reference, Type, WebExtensions, events
An object which allows the addition and removal of listeners for a browser event.
178 events.Rule API, Add-ons, Extensions, Non-standard, Reference, Rule, Type, WebExtensions, events
Description of a declarative rule for handling events.
179 events.UrlFilter API, Add-ons, Extensions, Non-standard, Reference, Type, UrlFilter, WebExtensions, events
Describes various criteria for filtering URLs. If all of the criteria specified in the filter's properties match the URL, then the filter matches. Filters are often provided to API methods in an Array of UrlFilters. For example, webNavigation listeners can be added with a filter which is an object with a single url property that is an Array of UrlFilters, e.g. {url:[UrlFilter,UrlFilter,...]}. If any filter within the Array of UrlFilters matches, then it is considered a match for the Array. Effectively, the criteria specified within a single filter are AND'ed together, while all of the individual filters within an Array are OR'ed.
180 extension API, Add-ons, Extension, Extensions, Interface, Non-standard, Reference, WebExtensions
Utilities related to your extension. Get URLs to resources packages with your extension, get the Window object for your extension's pages, get the values for various settings. Note that the messaging APIs in this module are deprecated in favor of the equivalent APIs in the runtime module.
181 extension.ViewType API, Add-ons, Extension, Extensions, Non-standard, Reference, Type, ViewType, WebExtensions
The type of extension view.
182 extension.getBackgroundPage() API, Add-ons, Extension, Extensions, Method, Non-standard, Reference, WebExtensions, getBackgroundPage
Alias for runtime.getBackgroundPage().
183 extension.getExtensionTabs() API, Add-ons, Extension, Extensions, Method, Non-standard, Reference, WebExtensions, getExtensionTabs
Returns an array of the JavaScript Window objects for each of the tabs running inside the current extension. If windowId is specified, returns only the Window objects of tabs attached to the specified window.
184 extension.getURL() API, Add-ons, Extension, Extensions, Method, Non-standard, Reference, WebExtensions, getURL
Converts a relative path within an extension's install directory to a fully-qualified URL.
185 extension.getViews() API, Add-ons, Extension, Extensions, Method, Non-standard, Reference, WebExtensions, getViews
Returns an array of the Window objects for each of the pages running inside the current extension. This includes, for example:
186 extension.inIncognitoContext API, Add-ons, Extension, Extensions, Non-standard, Property, Reference, WebExtensions, inIncognitoContext
Boolean value, true for content scripts running inside private browsing tabs and for extension pages running inside a private browsing process.
187 extension.isAllowedFileSchemeAccess() API, Add-ons, Extension, Extensions, Method, Non-standard, Reference, WebExtensions, isAllowedFileSchemeAccess
None.
188 extension.isAllowedIncognitoAccess() API, Add-ons, Extension, Extensions, Method, Non-standard, Reference, WebExtensions, isAllowedIncognitoAccess
Check whether the extension is allowed access to tabs opened in "private browsing" mode.
189 extension.lastError API, Add-ons, Extension, Extensions, Non-standard, Property, Reference, WebExtensions, lastError
An alias for runtime.lastError.
190 extension.onRequest API, Add-ons, Event, Extension, Extensions, Non-standard, Reference, WebExtensions, onRequest
Fired when a request is sent from either an extension process or a content script.
191 extension.onRequestExternal API, Add-ons, Event, Extension, Extensions, Non-standard, Reference, WebExtensions, onRequestExternal
Fired when a request is sent from another extension.
192 extension.sendRequest() API, Add-ons, Extension, Extensions, Method, Non-standard, Reference, WebExtensions, sendRequest
Sends a single request to other listeners within the extension. Similar to runtime.connect, but only sends a single request with an optional response. The extension.onRequest event is fired in each page of the extension.
193 extension.setUpdateUrlData() API, Add-ons, Extension, Extensions, Method, Non-standard, Reference, WebExtensions, setUpdateUrlData
Sets parameters for the extension's update URL. This value is ignored for extensions that are hosted in the browser vendor's store.
194 extensionTypes API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, extensionTypes
Some common types used in other WebExtension APIs.
195 extensionTypes.ImageDetails API, Add-ons, Extensions, ImageDetails, Non-standard, Reference, Type, WebExtensions, extensionTypes
Details about the format and quality of an image.
196 extensionTypes.ImageFormat API, Add-ons, Extensions, ImageFormat, Non-standard, Reference, Type, WebExtensions, extensionTypes
The format of an image.
197 extensionTypes.InjectDetails API, Add-ons, Extensions, InjectDetails, Non-standard, Reference, Type, WebExtensions, extensionTypes
This type is given as a parameter to the tabs.executeScript(), tabs.insertCSS(), and tabs.removeCSS() methods. For the details of its properties and what they are used for, see the documentation pages for those methods:
198 extensionTypes.RunAt API, Add-ons, Extensions, Non-standard, Reference, RunAt, Type, WebExtensions, extensionTypes
The soonest that the JavaScript or CSS will be injected into the tab.
199 find API, Add-ons, Extensions, Reference, WebExtensions, find
Finds text in a web page, and highlights matches.
200 find.find() API, Add-ons, Extensions, Method, Reference, WebExtensions, find
Searches for text in a tab.
201 find.highlightResults() API, Add-ons, Extensions, Method, Reference, WebExtensions, find, highlightResults
Highlights the results of a previous call to find.find().
202 find.removeHighlighting() API, Add-ons, Extensions, Method, Reference, WebExtensions, find, removeHighlighting
Remove any highlighting of a previous search that was applied by a previous call to highlightResults(), or by the browser's native UI.
203 history API, Add-ons, Extensions, History, Interface, Non-standard, Reference, WebExtensions
Use the history API to interact with the browser history.
204 history.HistoryItem API, Add-ons, Extensions, History, HistoryItem, Non-standard, Reference, Type, WebExtensions
A HistoryItem object provides information about a page in the browser history.
205 history.TransitionType API, Add-ons, Extensions, History, Non-standard, Reference, TransitionType, Type, WebExtensions
This describes how the browser navigated to a particular page. For example, "link" means that the browser navigated to the page because the user clicked a link.
206 history.VisitItem API, Add-ons, Extensions, History, Non-standard, Reference, Type, VisitItem, WebExtensions
An object describing a single visit to a page.
207 history.addUrl() API, Add-ons, Extensions, History, Method, Non-standard, Reference, WebExtensions, addUrl
Adds a record to the browser's history of a visit to the given URL. The visit's time is recorded as the time of the call, and the TransitionType is recorded as "link".
208 history.deleteAll() API, Add-ons, Extensions, History, Method, Non-standard, Reference, WebExtensions, deleteAll
Deletes all visits from the browser's history.
209 history.deleteRange() API, Add-ons, Extensions, History, Method, Non-standard, Reference, WebExtensions, deleteRange
Removes all visits to pages that the user made during the given time range. If this removes all visits made to a given page, then the page will be no longer appear in the browser history and history.onVisitRemoved will fire for it.
210 history.deleteUrl() API, Add-ons, Extensions, History, Method, Non-standard, Reference, WebExtensions, deleteUrl
Removes all visits to the given URL from the browser history.
211 history.getVisits() API, Add-ons, Extensions, History, Method, Non-standard, Reference, WebExtensions, getVisits
Retrieves information about all visits to the given URL.
212 history.onTitleChanged API, Add-ons, Event, History, Reference, WebExtensions, onTitleChanged
Events have three functions:
213 history.onVisitRemoved API, Add-ons, Event, Extensions, History, Non-standard, Reference, WebExtensions, onVisitRemoved
Fired when a page is removed completely from the browser history.
214 history.onVisited API, Add-ons, Event, Extensions, History, Non-standard, Reference, WebExtensions, onVisited
Fired each time the user visits a page. A history.HistoryItem object is passed to the listener. This event fires before the page has loaded.
215 history.search() API, Add-ons, Extensions, History, Method, Non-standard, Reference, Search, WebExtensions
Searches the browser's history for history.HistoryItem objects matching the given criteria.
216 i18n API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, i18n
Functions to internationalize your extension. You can use these APIs to get localized strings from locale files packaged with your extension, find out the browser's current language, and find out the value of its Accept-Language header.
217 Locale-specific message reference Internationalization, Localization, Reference, String, WebExtensions, i18n, message, messages.json, placeholders
Each internationalized extension has at least one file named messages.json that provides locale-specific strings. This page describes the format of messages.json files.
218 i18n.LanguageCode API, Add-ons, Extensions, LanguageCode, Non-standard, Reference, Type, WebExtensions, i18n
A language tag such as "en-US" or "fr".
219 i18n.detectLanguage() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, detectLanguage, i18n
Detects the language of the provided text using the Compact Language Detector (CLD).
220 i18n.getAcceptLanguages() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, getAcceptLanguages, i18n
Gets the accept-languages of the browser. This is different from the locale used by the browser. To get the locale, use i18n.getUILanguage.
221 i18n.getMessage() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, getMessage, i18n
Gets the localized string for the specified message.
222 i18n.getUILanguage() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, getUILanguage, i18n
Gets the UI language of the browser. This is different from i18n.getAcceptLanguages which returns the preferred user languages.
223 identity API, Add-ons, Extensions, Identity, Reference, WebExtensions
Use the identity API to get an OAuth2 authorization code or access token, which an extension can then use to access user data from a service which supports OAuth2 access (such as a Google or a Facebook account).
224 identity.getRedirectURL() API, Add-ons, Extensions, Identity, Method, Reference, WebExtensions, getRedirectURL
Generates a URL that you can use as a redirect URL.
225 identity.launchWebAuthFlow API, Add-ons, Extensions, Identity, Method, Reference, WebExtensions, launchWebAuthFlow
Performs the first part of an OAuth2 flow, including user authentication and client authorization.
226 idle API, Add-ons, Extensions, Idle, Interface, Non-standard, Reference, WebExtensions
Find out when the user's system is idle, locked, or active.
227 idle.IdleState API, Add-ons, Extensions, Idle, IdleState, Non-standard, Reference, Type, WebExtensions
String describing the device's idle state.
228 idle.onStateChanged API, Add-ons, Event, Extensions, Idle, Non-standard, Reference, WebExtensions, onStateChanged
Fired when the system changes to an active, idle or locked state. The event listener is passed a string that has one of three values:
229 idle.queryState() API, Add-ons, Extensions, Idle, Method, Non-standard, Reference, WebExtensions, queryState
Returns "locked" if the system is locked, "idle" if the user has not generated any input for a specified number of seconds, or "active" otherwise.
230 idle.setDetectionInterval() API, Add-ons, Extensions, Idle, Method, Non-standard, Reference, WebExtensions, setDetectionInterval
Sets the interval, in seconds, used to determine when the system is in an idle state for idle.onStateChanged events. The default interval is 60 seconds.
231 management API, Add-ons, Extensions, Reference, WebExtensions, management
Get information about installed add-ons.
232 ExtensionInfo API, Add-ons, ExtensionInfo, Extensions, Reference, Type, WebExtensions, management
An ExtensionInfo object contains information about an add-on.
233 management.get() API, Add-ons, Method, Reference, WebExtensions, get, management
Retrieves an ExtensionInfo object containing information about the specified add-on.
234 management.getAll() API, Add-ons, Method, Reference, WebExtensions, getAll, management
Retrieves an array of ExtensionInfo objects, one for each installed add-on.
235 management.getPermissionWarningsById() API, Add-ons, Method, Reference, WebExtensions, getPermissionWarningsById, management
Given the ID of an add-on, this function returns the permission warnings for it as an array of strings.
236 management.getPermissionWarningsByManifest() API, Add-ons, Method, Reference, WebExtensions, getPermissionWarningsByManifest, management
Given the text of a manifest.json file, this function returns the permission warnings that would be given for the resulting add-on, as an array of strings.
237 management.getSelf() API, Add-ons, Method, Reference, WebExtensions, getSelf, management
Retrieves an ExtensionInfo object containing information about the calling add-on.
238 management.onDisabled() API, Add-ons, Event, Reference, WebExtensions, management, onDisabled
Fired when an add-on is disabled.
239 management.onEnabled() API, Add-ons, Event, Reference, WebExtensions, management, onEnabled
Fired when an add-on is enabled.
240 management.onInstalled() API, Add-ons, Event, Reference, WebExtensions, management, onInstalled
Fired when an add-on is installed.
241 management.onUninstalled() API, Add-ons, Event, Reference, WebExtensions, management, onUninstalled
Fired when an add-on is uninstalled.
242 management.setEnabled() API, Add-ons, Method, Reference, WebExtensions, management, setEnabled
Enables or disables the given add-on.
243 management.uninstall() API, Add-ons, Method, Reference, WebExtensions, management, uninstall
Uninstalls an add-on, given its ID.
244 management.uninstallSelf() API, Add-ons, Method, Reference, WebExtensions, management, uninstallSelf
Uninstalls the calling add-on.
245 menus API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, contextMenus, menus
Add items to the browser's menu system.
246 menus.ACTION_MENU_TOP_LEVEL_LIMIT ACTION_MENU_TOP_LEVEL_LIMIT, API, Add-ons, Extensions, Non-standard, Property, Reference, WebExtensions, contextMenus
The maximum number of top level extension items that can be added to a menu item whose ContextType is "browser_action" or "page_action". Any items beyond this limit will be ignored.
247 menus.ContextType API, Add-ons, ContextType, Extensions, Non-standard, Reference, Type, WebExtensions, contextMenus, menus
The different contexts a menu item can appear in.
248 menus.ItemType API, Add-ons, Extensions, Non-standard, Reference, Type, WebExtensions, contextMenus, itemtype
The type of menu item.
249 menus.OnClickData API, Add-ons, Extensions, Non-standard, OnClickData, Reference, Type, WebExtensions, contextMenus
Information passed to the menus.onClicked event listener when a menu item is clicked.
250 menus.create() API, Add-ons, Create, Extensions, Method, Non-standard, Reference, WebExtensions, contextMenus
Creates a new menu item, given an options object defining properties for the item.
251 menus.onClicked API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, contextMenus, onClicked
Fired when a menu item is clicked.
252 menus.remove() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, contextMenus, remove
Removes a menu item.
253 menus.removeAll() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, contextMenus, menus, removeAll
Removes all menu items added by the extension.
254 menus.update() API, Add-ons, Extensions, Method, Non-standard, Reference, Update, WebExtensions, contextMenus
Updates a previously created menu item.
255 notifications
Display notifications to the user, using the underlying operating system's notification mechanism. Because this API uses the operating system's notification mechanism, the details of how notifications appear and behave may differ according to the operating system and the user's settings.
256 notifications.NotificationOptions API, Add-ons, Extensions, Non-standard, NotificationOptions, Notifications, Reference, Type, WebExtensions
This type contains all the data needed to:
257 notifications.TemplateType API, Add-ons, Extensions, Non-standard, Notifications, Reference, TemplateType, Type, WebExtensions
This is a string, and represents the type of notification to create. There are four types of notification: "basic", "image", "list", "progress".
258 notifications.clear() API, Add-ons, Extensions, Method, Non-standard, Notifications, Reference, WebExtensions, clear
Clears a notification, given its ID.
259 notifications.create() API, Add-ons, Create, Extensions, Method, Non-standard, Notifications, Reference, WebExtensions
Creates and displays a notification.
260 notifications.getAll() API, Add-ons, Extensions, Method, Non-standard, Notifications, Reference, WebExtensions, getAll
Gets all currently active notifications created by the extension.
261 notifications.onButtonClicked API, Add-ons, Event, Extensions, Non-standard, Notifications, Reference, WebExtensions, onButtonClicked
Fired when the user clicks one of the notification's buttons.
262 notifications.onClicked API, Add-ons, Event, Extensions, Non-standard, Notifications, Reference, WebExtensions, onClicked
Fired when the user clicks a notification, but not on any of the notification's buttons (for that, see notifications.onButtonClicked).
263 notifications.onClosed API, Add-ons, Event, Extensions, Non-standard, Notifications, Reference, WebExtensions, onClosed
Fired when a notification is closed, either by the system or by the user.
264 notifications.onShown API, Add-ons, Event, Extensions, Notifications, Reference, WebExtensions, events, onShown
Fired immediately after a notification has been shown.
265 notifications.update() API, Add-ons, Extensions, Method, Non-standard, Notifications, Reference, Update, WebExtensions
Updates a notification, given its ID.
266 omnibox API, Add-ons, Extensions, Reference, WebExtensions, omnibox
Enables extensions to implement customised behavior when the user types into the browser's address bar.
267 omnibox.OnInputEnteredDisposition API, Add-ons, Extensions, OnInputEnteredDisposition, Reference, Type, WebExtensions, omnibox
The omnibox.OnInputEnteredDisposition type describes how the extension should handle a user selection from the suggestions in the address bar's drop-down list.
268 omnibox.SuggestResult API, Add-ons, Extensions, Reference, SuggestResult, Type, WebExtensions, omnibox
The omnibox.SuggestResult type defines a single suggestion that the extension can add to the address bar's drop-down list.
269 omnibox.onInputCancelled API, Add-ons, Event, Extensions, Reference, WebExtensions, omnibox, onInputCancelled
Fired when the user has cancelled their interaction with your extension (for example, by clicking outside the address bar).
270 omnibox.onInputChanged API, Add-ons, Event, Extensions, Reference, WebExtensions, omnibox, onInputChanged
Fired whenever the user changes their input, after they have started interacting with your extension by entering its keyword in the address bar and then pressing the space key.
271 omnibox.onInputEntered API, Add-ons, Event, Extensions, Reference, WebExtensions, omnibox, onInputEntered
Fired when the user has selected one of the suggestions your extension has added to the address bar's drop-down list.
272 omnibox.onInputStarted API, Add-ons, Event, Extensions, Reference, WebExtensions, omnibox, onInputStarted
Fired when the user starts interacting with your extension by entering its keyword in the address bar and then pressing the space key.
273 omnibox.setDefaultSuggestion() API, Add-ons, Extensions, Method, Reference, WebExtensions, omnibox, setDefaultSuggestion
Set the default suggestion to appear in the address bar drop-down list when the user starts interacting with your extension.
274 pageAction API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, pageAction
A page action is a clickable icon inside the browser's address bar.
275 pageAction.ImageDataType API, Add-ons, Extensions, ImageDataType, Non-standard, Reference, Type, WebExtensions, pageAction
Pixel data for an image.
276 pageAction.getPopup() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, getPopup, pageAction
Gets the URL for the HTML document set as the popup for this page action.
277 pageAction.getTitle() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, getTitle, pageAction
Gets the title of the page action.
278 pageAction.hide() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, hide, pageAction
Hides the page action for a given tab.
279 pageAction.onClicked API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onClicked, pageAction
Fired when a page action icon is clicked. This event will not fire if the page action has a popup.
280 pageAction.openPopup() API, Add-ons, Extensions, Method, Reference, WebExtensions, close, sidebarAction
None.
281 pageAction.setIcon() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, pageAction, setIcon
Sets the icon for the page action.
282 pageAction.setPopup() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, pageAction, setPopup
Sets the HTML document to be opened as a popup when the user clicks on the page action's icon.
283 pageAction.setTitle() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, pageAction, setTitle
Sets the title of the page action. The title is displayed in a tooltip when the user hovers over the page action.
284 pageAction.show() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, pageAction, show
Shows the page action for a given tab. The page action is shown whenever the given tab is the active tab.
285 permissions API, Add-ons, Extensions, Permissions, Reference, WebExtensions
Extensions need permissions to access more powerful WebExtension APIs. They can ask for permissions at install time, by including the permissions they need in the permissions manifest.json key. The main advantages of asking for permissions at install time are:
286 Permissions API, Add-ons, Permissions, Reference, Type, WebExtensions
A Permissions object represents a collection of permissions.
287 permissions.contains() API, Add-ons, Contains, Method, Permissions, Reference, WebExtensions
Check whether the extension has the permissions listed in the given permissions.Permissions object.
288 permissions.getAll() API, Add-ons, Method, Permissions, Reference, WebExtensions, getAll
Retrieve a permissions.Permissions object containing all the permissions currently granted to the extension.
289 permissions.onAdded API, Add-ons, Event, Permissions, Reference, WebExtensions, onAdded
Fired when the extension granted new permissions.
290 permissions.onRemoved API, Add-ons, Event, Permissions, Reference, WebExtensions, onRemoved
Fired when some permissions are removed from the extension.
291 permissions.remove() API, Add-ons, Method, Permissions, Reference, WebExtensions, remove
Ask to give up the permissions listed in the given permissions.Permissions object.
292 permissions.request() API, Add-ons, Method, Permissions, Reference, WebExtensions, request
Ask for the set of permissions listed in the given permissions.Permissions object.
293 pkcs11 API, Add-ons, Extensions, Reference, WebExtensions, pkcs11
The pkcs11 API enables an extension to enumerate PKCS #11 security modules, and to make them accessible to the browser as sources of keys and certificates.
294 pkcs11.getModuleSlots() API, Add-ons, Extensions, Method, Reference, WebExtensions, getModuleSlots, pkcs11
Enumerate a module's slots. This function returns an array containing one entry for each slot. Each entry contains the slot's name and, if the slot contains a token, information about the token.
295 pkcs11.installModule() API, Add-ons, Extensions, Method, Reference, WebExtensions, installModule, pkcs11
Installs the named PKCS #11 module, making it available to Firefox.
296 pkcs11.isModuleInstalled() API, Add-ons, Extensions, Method, Reference, WebExtensions, isModuleInstalled, pkcs11
Checks whether the named PKCS #11 module is currently installed in Firefox.
297 pkcs11.uninstallModule() API, Add-ons, Extensions, Method, Reference, WebExtensions, pkcs11, uninstallModule
Uninstalls the named PKCS #11 module from Firefox.
298 privacy API, Add-ons, Extensions, Privacy, Reference, WebExtensions
Access and modify various privacy-related browser settings.
299 privacy.network API, Add-ons, Extensions, Network, Privacy, Property, Reference, WebExtensions
No summary!
300 privacy.services API, Add-ons, Extensions, Privacy, Property, Reference, Services
No summary!
301 privacy.websites API, Add-ons, Extensions, Privacy, Property, Reference, WebExtensions, websites
No summary!
302 proxy API, Add-ons, Proxy, WebExtensions
Use the proxy API to register an extended Proxy Auto-Configuration (PAC) file, which implements a policy for proxying web requests. This implementation deviates from standard PAC design in several ways because the de-facto specification for PAC files hasn't changed since its initial implementation circa 1995. There is no standards body maintaining the specification.
303 proxy.onProxyError API, Add-ons, Event, Proxy, Reference, WebExtensions, onProxyError
Fired when there is an error evaluating the PAC file.
304 proxy.register() API, Add-ons, Function, Method, Proxy, Reference, WebExtensions, register, registerProxyScript
Registers a Proxy Auto-Configuration (PAC) file. The file is executed immediately, and its FindProxyForURL() function will be called for any HTTP, HTTPS, or FTP requests.
305 proxy.unregister() API, Add-ons, Extensions, Method, Proxy, Reference, WebExtensions, unregister
Unregisters a Proxy Auto-Configuration (PAC) file. that was registered by an earlier call to proxy.register().
306 runtime API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, runtime
This module provides information about your extension and the environment it's running in.
307 runtime.MessageSender API, Add-ons, Extensions, MessageSender, Non-standard, Reference, Type, WebExtensions, runtime
An object containing information about the sender of a message or connection request; this is passed to the runtime.onMessage() listener.
308 runtime.OnInstalledReason API, Add-ons, Extensions, Non-standard, OnInstalledReason, Reference, Type, WebExtensions, runtime
The reason that the runtime.onInstalled event is being dispatched.
309 runtime.OnRestartRequiredReason API, Add-ons, Extensions, Non-standard, OnRestartRequiredReason, Reference, Type, WebExtensions, runtime
The reason that the onRestartRequired event is being dispatched.
310 runtime.PlatformArch API, Add-ons, Extensions, Non-standard, PlatformArch, Reference, Type, WebExtensions, runtime
The machine's processor architecture.
311 runtime.PlatformInfo API, Add-ons, Extensions, Non-standard, PlatformInfo, Reference, Type, WebExtensions, runtime
An object containing information about the current platform.
312 runtime.PlatformNaclArch API, Add-ons, Extensions, Non-standard, PlatformNaclArch, Reference, Type, WebExtensions, runtime
The native client architecture. This may be different from arch on some platforms.
313 runtime.PlatformOs API, Add-ons, Extensions, Non-standard, PlatformOs, Reference, Type, WebExtensions, runtime
The operating system the browser is running on.
314 runtime.Port API, Add-ons, Extensions, Non-standard, Reference, Type, WebExtensions, port, runtime
A Port object represents one end of a connection between two specific contexts, which can be used to exchange messages.
315 runtime.RequestUpdateCheckStatus API, Add-ons, Extensions, Non-standard, Reference, RequestUpdateCheckStatus, Type, WebExtensions, runtime
Result of a call to runtime.requestUpdateCheck().
316 runtime.connect() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, connect, runtime
Make a connection between different contexts inside the extension.
317 runtime.connectNative() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, connectNative, runtime
For more information, see Native messaging.
318 runtime.getBackgroundPage() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, getBackgroundPage, runtime
Retrieves the Window object for the background page running inside the current extension.
319 runtime.getBrowserInfo()
Returns information about the browser in which the extension is installed.
320 runtime.getManifest() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, getManifest, runtime
None.
321 runtime.getPackageDirectoryEntry() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, getPackageDirectoryEntry, runtime
Returns a DirectoryEntry object representing the package directory.
322 runtime.getPlatformInfo() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, getPlatformInfo, runtime
Returns information about the current platform.
323 runtime.getURL() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, getURL, runtime
string. The fully-qualified URL to the resource.
324 runtime.id API, Add-ons, Extensions, Non-standard, Property, Reference, WebExtensions, id, runtime
The ID of the extension.
325 runtime.lastError API, Add-ons, Extensions, Non-standard, Property, Reference, WebExtensions, lastError, runtime
The runtime.lastError property is set when an asynchronous function has an error condition that it needs to report to its caller.
326 runtime.onBrowserUpdateAvailable API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onBrowserUpdateAvailable, runtime
Fired when an update for the browser is available, but it isn't installed immediately because a browser restart is required.
327 runtime.onConnect API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onconnect, runtime
Fired when a connection is made with either an extension process or a content script.
328 runtime.onConnectExternal API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onConnectExternal, runtime
Fired when an extension receives a connection request from a different extension.
329 runtime.onInstalled API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onInstalled, runtime
Fired when the extension is first installed, when the extension is updated to a new version, and when the browser is updated to a new version.
330 runtime.onMessage API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onmessage, runtime
To send a message which will be received by the onMessage listener, use runtime.sendMessage() or (to send a message to a content script) tabs.sendMessage().
331 runtime.onMessageExternal API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onMessageExternal, runtime
This API can't be used in a content script.
332 runtime.onRestartRequired API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onRestartRequired, runtime
Fired when an app or the device that it runs on needs to be restarted. The app should close all its windows at its earliest convenience to let the restart happen. If the app does nothing, a restart will be enforced after a 24-hour grace period has passed. Currently, this event is only fired for Chrome OS kiosk apps.
333 runtime.onStartup API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onStartup, runtime
Fired when a profile that has this extension installed first starts up. This event is not fired when a private browsing/incognito profile is started, even if this extension is operating in 'split' incognito mode.
334 runtime.onSuspend API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onSuspend, runtime
Sent to the event page just before it is unloaded. This gives the extension an opportunity to do some cleanup. Note that since the page is unloading, any asynchronous operations started while handling this event are not guaranteed to complete.
335 runtime.onSuspendCanceled API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onSuspendCanceled, runtime
Sent after runtime.onSuspend to indicate that the app won't be unloaded after all.
336 runtime.onUpdateAvailable API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onUpdateAvailable, runtime
Fired when an update to the extension is available. This event enables an extension to delay an update: for example, because it is in the middle of some operation which should not be interrupted.
337 runtime.openOptionsPage() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, openOptionsPage, runtime
This is an asynchronous function that returns a Promise.
338 runtime.reload() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, reload, runtime
Reloads the extension.
339 runtime.requestUpdateCheck() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, requestUpdateCheck, runtime
Checks to see if an update for the extension is available.
340 runtime.sendMessage() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, runtime, sendMessage
Sends a single message to event listeners within your extension or a different extension.
341 runtime.sendNativeMessage() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, runtime, sendNativeMessage
Sends a single message from an extension to a native application.
342 runtime.setUninstallURL() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, runtime, setUninstallURL
Sets the URL to be visited when the extension is uninstalled. This may be used to clean up server-side data, do analytics, or implement surveys. The URL can be a maximum 255 characters.
343 sessions API, Add-ons, Extensions, Non-standard, Reference, WebExtensions, sessions
Use the sessions API to list, and restore, tabs and windows that have been closed while the browser has been running.
344 sessions.Filter API, Add-ons, Extensions, Non-standard, Reference, Type, WebExtensions, filter, sessions
The Filter object enables you to restrict the number of Session objects returned by a call to sessions.getRecentlyClosed().
345 sessions.MAX_SESSION_RESULTS API, Add-ons, Extensions, MAX_SESSION_RESULTS, Non-standard, Property, Reference, WebExtensions, sessions
This value represents the maximum number of sessions that will be returned by a call to sessions.getRecentlyClosed(). It is read-only for WebExtension code, and is set to 25.
346 sessions.Session API, Add-ons, Extensions, Non-standard, Reference, Session, Type, WebExtensions, sessions
The Session object represents a tab or window that the user has closed in the current browsing session.
347 sessions.forgetClosedTab() API, Add-ons, Extensions, Method, Reference, WebExtensions, forgetClosedTab, sessions
This is an asynchronous function that returns a Promise.
348 sessions.forgetClosedWindow() API, Add-ons, Extensions, Method, Reference, WebExtensions, forgetClosedWindow, sessions
This is an asynchronous function that returns a Promise.
349 sessions.getRecentlyClosed() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, getRecentlyClosed, sessions
Returns an array of Session objects, representing windows and tabs that were closed in the current browsing session (that is: the time since the browser was started).
350 sessions.getTabValue() API, Add-ons, Extensions, Method, Reference, WebExtensions, getTabValue, sessions
Retrieves a value previously stored by a call to sessions.setTabValue.
351 sessions.getWindowValue() API, Add-ons, Extensions, Method, Reference, WebExtensions, getWindowValue, sessions
Retrieves a value previously stored by a call to sessions.setWindowValue.
352 sessions.onChanged API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onChanged, sessions
Fired whenever the list of closed tabs or windows changes.
353 sessions.removeTabValue() API, Add-ons, Extensions, Method, Reference, WebExtensions, removeTabValue, sessions
Removes a value previously stored by a call to sessions.setTabValue.
354 sessions.removeWindowValue() API, Add-ons, Extensions, Method, Reference, WebExtensions, removeWindowValue, sessions
Removes a value previously stored by a call to sessions.setWindowValue.
355 sessions.restore() API, Add-ons, Extensions, Method, Non-standard, WebExtensions, restore, sessions
Restores a closed tab or window. Restoring doesn't just reopen the tab or window: it also restores the tab's navigation history so the back/forward buttons will work. Restoring a window will restore all the tabs that the window contained when it was closed.
356 sessions.setTabValue() API, Add-ons, Extensions, Method, Reference, WebExtensions, sessions, setTabValue
Stores a key/value pair to associate with a given tab. You can subsequently retrieve this value using sessions.getTabValue.
357 sessions.setWindowValue() API, Add-ons, Extensions, Method, Reference, WebExtensions, sessions, setWindowValue
Stores a key/value pair to associate with a given window. You can subsequently retrieve this value using sessions.getWindowValue.
358 sidebarAction
Gets and sets properties of an extension's sidebar.
359 sidebarAction.ImageDataType API, Add-ons, Extensions, ImageDataType, Reference, Type, WebExtensions, sidebarAction
Pixel data for an image. Must be an ImageData object (for example, from a <canvas> element).
360 sidebarAction.close() API, Add-ons, Extensions, Method, Reference, WebExtensions, close, sidebarAction
Closes the sidebar in the active window, if it is the extension's own sidebar.
361 sidebarAction.getPanel() API, Add-ons, Extensions, Method, Reference, WebExtensions, getPanel, sidebarAction
Gets a URL to the HTML document that defines the sidebar's contents.
362 sidebarAction.getTitle() API, Add-ons, Extensions, Method, Reference, WebExtensions, getTitle, sidebarAction
Gets the sidebar's title.
363 sidebarAction.open() API, Add-ons, Extensions, Method, Reference, open, sidebarAction
None.
364 sidebarAction.setIcon() API, Add-ons, Extensions, Method, Reference, WebExtensions, setIcon, sidebarAction
Sets the icon for the sidebar.
365 sidebarAction.setPanel() API, Add-ons, Extensions, Method, Reference, WebExtensions, setPanel, sidebarAction
Sets the HTML document that defines the content of this sidebar.
366 sidebarAction.setTitle() API, Add-ons, Extensions, Method, Reference, WebExtensions, setTitle, sidebarAction
Sets the sidebar's title. The title is displayed anywhere the browser lists available sidebars. For example, Firefox will show it in the "View > Sidebar" menu. It's also shown at the top o the sidebar when the sidebar is open.
367 storage API, Add-ons, Extensions, Interface, Non-standard, Reference, Storage, WebExtensions
Enables extensions to store and retrieve data, and listen for changes to stored items.
368 storage.StorageArea API, Add-ons, Extensions, Non-standard, Reference, Storage, StorageArea, Type, WebExtensions
StorageArea is an object representing a storage area.
369 StorageArea.clear() API, Add-ons, Extensions, Method, Non-standard, Reference, Storage, StorageArea, WebExtensions, remove
Removes all items from the storage area.
370 StorageArea.get() API, Add-ons, Extensions, Method, Non-standard, Reference, Storage, StorageArea, WebExtensions, get
Retrieves one or more items from the storage area.
371 StorageArea.getBytesInUse() API, Add-ons, Extensions, Method, Non-standard, Reference, Storage, StorageArea, WebExtensions, getBytesInUse
Gets the amount of storage space, in bytes, used one or more items being stored in the storage area.
372 StorageArea.remove() API, Add-ons, Extensions, Method, Non-standard, Reference, Storage, StorageArea, WebExtensions, remove
Removes one or more items from the storage area.
373 StorageArea.set() API, Add-ons, Extensions, Method, Non-standard, Reference, Storage, StorageArea, WebExtensions, set
Stores one or more items in the storage area, or update existing items.
374 storage.StorageChange API, Add-ons, Extensions, Non-standard, Reference, Storage, StorageChange, Type, WebExtensions
StorageChange objects contain the following properties:
375 storage.local API, Add-ons, Extensions, Non-standard, Property, Reference, Storage, WebExtensions, local
Represents the local storage area. Items in local storage are local to the machine the extension was installed on.
376 storage.managed API, Add-ons, Extensions, Non-standard, Property, Reference, Storage, WebExtensions, managed
A storage.StorageArea object that represents the managed storage area. Items in managed storage are set by the domain administrator or other native applications installed on user's computer, and are read-only for the extension. Trying to modify this storage area results in an error.
377 storage.onChanged API, Add-ons, Event, Extensions, Non-standard, Reference, Storage, WebExtensions, onChanged
Fired when one or more items change.
378 storage.sync API, Add-ons, Extensions, Non-standard, Property, Reference, Storage, Sync, WebExtensions
Represents the sync storage area. Items in sync storage are synced by the browser, and are available across all instances of that browser that the user is logged into (e.g. via Firefox sync, or a Google account), across different devices.
379 tabs API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, tabs
Interact with the browser's tab system.
380 tabs.MutedInfo API, Add-ons, Extensions, MutedInfo, Non-standard, Reference, Type, WebExtensions, tabs
This object contains a boolean indicating whether the tab is muted, and the reason for the last state change.
381 tabs.MutedInfoReason API, Add-ons, Extensions, MutedInfoReason, Non-standard, Reference, Type, WebExtensions, tabs
Specifies the reason a tab was muted or unmuted.
382 tabs.PageSettings API, Add-ons, Extensions, PageSettings, Reference, Type, WebExtensions, tabs
The type tabs.PageSettings is used to control how a tab is rendered as a PDF by the tabs.saveAsPDF() method.
383 tabs.TAB_ID_NONE API, Add-ons, Extensions, Non-standard, Property, Reference, TAB_ID_NONE, WebExtensions, tabs
A special ID value given to tabs that are not browser tabs (for example, tabs in devtools windows).
384 tabs.Tab API, Add-ons, Extensions, Non-standard, Reference, Tab, Type, WebExtensions, tabs
The type tabs.Tab contains information about a tab. This provides access to information about what content is in the tab, how large the content is, what special states or restrictions are in effect, and so forth.
385 tabs.TabStatus API, Add-ons, Extensions, Non-standard, Reference, TabStatus, Type, WebExtensions, tabs
Indicates whether the tab has finished loading.
386 tabs.WindowType API, Add-ons, Extensions, Non-standard, Reference, Type, WebExtensions, WindowType, tabs
The type of window that hosts this tab.
387 tabs.ZoomSettings API, Add-ons, Extensions, Non-standard, Reference, Type, WebExtensions, ZoomSettings, tabs
Defines zoom settings for a tab: modescope, and default zoom factor.
388 tabs.ZoomSettingsMode API, Add-ons, Extensions, Non-standard, Reference, Type, WebExtensions, ZoomSettingsMode, tabs
Defines how zoom changes are handled. Extensions can pass this value into tabs.setZoomSettings() to control how the browser handles attempts to change zoom settings for a tab. Defaults to "automatic".
389 tabs.ZoomSettingsScope API, Add-ons, Extensions, Non-standard, Reference, Type, WebExtensions, ZoomSettingsScope, tabs
Defines whether zoom changes will persist for the page's origin, or only take effect in this tab. This defaults to per-origin when tabs.zoomSettingsMode is "automatic", and is always per-tab otherwise.
390 tabs.captureVisibleTab() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, captureVisibleTab, tabs
Creates a data URI encoding an image of the visible area of the currently active tab in the specified window. You must have the <all_urls> permission to use this method.
391 tabs.connect() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, connect, tabs
Call this function to set up a connection between the extension's background scripts (or other privileged scripts, such as popup scripts or options page scripts) and any content scripts that belong to this extension and are running in the specified tab. This function returns a runtime.Port object.
392 tabs.create() API, Add-ons, Create, Extensions, Method, Non-standard, Reference, WebExtensions, tabs
Creates a new tab.
393 tabs.detectLanguage() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, detectLanguage, tabs
Detects the primary language of the content in a tab, using the Compact Language Detector (CLD).
394 tabs.discard() API, Add-ons, Extensions, Method, WebExtensions, discard, tabs
Discards one or more tabs.
395 tabs.duplicate() API, Add-ons, Duplicate, Extensions, Method, Non-standard, Reference, WebExtensions, tabs
Duplicates a tab, given its ID.
396 tabs.executeScript() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, executeScript, tabs
Injects JavaScript code into a page.
397 tabs.get() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, get, tabs
Given a tab ID, get the tab's details as a tabs.Tab object.
398 tabs.getAllInWindow() API, Add-ons, Deprecated, Extensions, Method, Non-standard, Reference, WebExtensions, getAllInWindow, tabs
Gets details about all tabs in the specified window.
399 tabs.getCurrent() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, getCurrent, tabs
Get a tabs.Tab containing information about the tab that this script is running in.
400 tabs.getSelected() API, Add-ons, Deprecated, Extensions, Method, Non-standard, Reference, WebExtensions, getSelected, tabs
Gets the tab that is selected in the specified window.
401 tabs.getZoom() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, getZoom, tabs
Gets the current zoom factor for the specified tab.
402 tabs.getZoomSettings() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, getZoomSettings, tabs
Gets the current zoom settings for a specified tab.
403 tabs.highlight() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, highlight, tabs
A Promise that will be fulfilled with a windows.Window object containing details about the window whose tabs were highlighted. If the window could not be found or some other error occurs, the promise will be rejected with an error message.
404 tabs.insertCSS() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, insertCSS, tabs
Injects CSS into a page.
405 tabs.move() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, move, tabs
Moves one or more tabs to a new position in the same window or to a different window.
406 tabs.onActivated API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onActivated, tabs
Fires when the active tab in a window changes. Note that the tab's URL may not be set at the time this event fired, but you can listen to tabs.onUpdated events to be notified when a URL is set.
407 tabs.onActiveChanged API, Add-ons, Deprecated, Event, Extensions, Non-standard, Reference, WebExtensions, onActiveChanged, tabs
Fires when the selected tab in a window changes. Note that the tab's URL may not be set at the time this event fired, but you can listen to tabs.onUpdated events to be notified when a URL is set.
408 tabs.onAttached API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onAttached, tabs
Fired when a tab is attached to a window, for example because it was moved between windows.
409 tabs.onCreated API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onCreated, tabs
Fired when a tab is created.
410 tabs.onDetached API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onDetached, tabs
Fired when a tab is detached from a window, for example because it is being moved between windows.
411 tabs.onHighlightChanged API, Add-ons, Deprecated, Event, Extensions, Non-standard, Reference, WebExtensions, onHighlightChanged, tabs
Fired when the highlighted or selected tabs in a window changes.
412 tabs.onHighlighted API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onHighlighted, tabs
Fired when the set of highlighted tabs in a window changes.
413 tabs.onMoved API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onMoved, tabs
Fired when a tab is moved within a window.
414 tabs.onRemoved API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onRemoved, tabs
Fired when a tab is closed.
415 tabs.onReplaced API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onReplaced, tabs
Fired when a tab is replaced with another tab due to prerendering or instant.
416 tabs.onSelectionChanged API, Add-ons, Deprecated, Event, Extensions, Non-standard, Reference, WebExtensions, onSelectionChanged, tabs
Fires when the selected tab in a window changes.
417 tabs.onUpdated API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onUpdated, tabs
Fired when a tab is updated.
418 tabs.onZoomChange API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onZoomChange, tabs
Fired when a tab is zoomed.
419 tabs.print() API, Add-ons, Extensions, Method, Reference, WebExtensions, print, tabs
Call this function to print the contents of the active tab. If this function is called, the user will be presented with the print dialog from the underlying platform, and will have the chance to change the print settings and then print the currently active tab.
420 tabs.printPreview() API, Add-ons, Extensions, Method, Reference, WebExtensions, printPreview, tabs
None.
421 tabs.query() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, query, tabs
Gets all tabs that have the specified properties, or all tabs if no properties are specified.
422 tabs.reload() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, reload, tabs
Reload a tab, optionally bypassing the local web cache.
423 tabs.remove() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, remove, tabs
Closes one or more tabs.
424 tabs.removeCSS() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, removeCSS, tabs
Removes from a page CSS which was previously injected by a call to tabs.insertCSS().
425 tabs.saveAsPDF() API, Add-ons, Extensions, Method, Reference, WebExtensions, saveAsPDF, tabs
Saves the current page as a PDF file. This will open a dialog, supplied by the underlying operating system, asking the user where they want to save the PDF file.
426 tabs.sendMessage() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, sendMessage, tabs
Sends a single message from the extension's background scripts (or other privileged scripts, such as popup scripts or options page scripts) to any content scripts that belong to the extension and are running in the specified tab.
427 tabs.sendRequest() API, Add-ons, Deprecated, Extensions, Method, Non-standard, Reference, WebExtensions, sendRequest, tabs
Sends a single request to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The extension.onRequest event is fired in each content script running in the specified tab for the current extension.
428 tabs.setZoom() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, setZoom, tabs
Zooms the specified tab.
429 tabs.setZoomSettings() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, setZoomSettings, tabs
Sets zoom settings for the specified tab. These settings are reset to the default settings upon navigating the tab.
430 tabs.toggleReaderMode() API, Add-ons, Extensions, Method, Reference, WebExtensions, tabs, toggleReaderMode
Toggles Reader Mode for the given tab.
431 tabs.update() API, Add-ons, Extensions, Method, Non-standard, Reference, Update, WebExtensions, tabs
Navigate the tab to a new URL, or modify other properties of the tab.
432 theme Extensions, Themes, WebExtensions, add-on
Enables browser extensions to update the browser theme.
433 Theme Extension, Theme, Type, WebExtensisons, add-on
A Theme object represents the specification of a theme.
434 theme.getCurrent() API, Add-ons, Extensions, Method, Reference, Theme, WebExtensions, getCurrent
Gets the currently used theme as a Theme object. The arguments available in the color object are listed in the properties of the color.
435 theme.onUpdated Add-ons, Event, Extensions, Theme, WebExtensions
Fires when a theme supplied as a browser extension is applied or removed. Specifically:
436 theme.reset() API, Add-ons, Extensions, Method, Reference, Theme, WebExtensions, reset
Resets any theme that was applied using the theme.update() method.
437 theme.update() API, Add-ons, Extensions, Method, Reference, Theme, Update, WebExtensions
Updates the browser theme according to the content of given Theme object.
438 topSites API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, topSites
Use the topSites API to get an array containing all the sites listed in the browser's "New Tab" page.
439 topSites.MostVisitedURL API, Add-ons, Extensions, MostVisitedURL, Non-standard, Reference, Type, WebExtensions, topSites
The MostVisitedURL type contains two properties: the title of a page and its URL.
440 topSites.get() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, get, topSites
Gets an array containing all the sites listed in the browser's "New Tab" page.
441 types API, Add-ons, Extensions, Reference, Types, WebExtensions
Defines the BrowserSetting type, which is used to represent a browser setting.
442 BrowserSetting API, Add-ons, BrowserSetting, Extensions, Reference, Type, Types, WebExtensions
A BrowserSetting is an object representing a browser setting.
443 BrowserSetting.onChange API, Add-ons, BrowserSetting, Event, Extensions, Privacy, Reference, WebExtensions, onchange
The BrowserSetting.onChange event is fired when the setting is changed.
444 clear() API, Add-ons, Extensions, Method, Reference, Types, WebExtensions, clear
Use BrowserSetting.clear() to clear any changes the extension has made to the browser setting. The browser setting will revert to its previous value.
445 get() API, Add-ons, Extensions, Method, Reference, Types, WebExtensions, get
The BrowserSetting.get() method gets the current value of the browser setting, and an enumeration indicating how the setting's value is currently controlled.
446 set() API, Add-ons, BrowserSetting, Extensions, Privacy, Reference, WebExtensions, set
Use BrowserSetting.set() to change the browser setting to a new value.
447 webNavigation API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, webNavigation
Add event listeners for the various stages of a navigation. A navigation consists of a frame in the browser transitioning from one URL to another, usually (but not always) in response to a user action like clicking a link or entering a URL in the location bar.
448 webNavigation.TransitionQualifier API, Add-ons, Extensions, Non-standard, Reference, TransitionQualifier, Type, WebExtensions, webNavigation
Values of this type are strings. Possible values are:
449 webNavigation.TransitionType API, Add-ons, Extensions, Non-standard, Reference, TransitionType, Type, WebExtensions, webNavigation
Cause of the navigation: for example, the user clicked a link, or typed an address, or clicked a bookmark.
450 webNavigation.getAllFrames() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, getAllFrames, webNavigation
Given a tab ID, retrieves information about all the frames it contains.
451 webNavigation.getFrame() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, getFrame, webNavigation
Retrieves information about a particular frame. A frame may be the top-level frame in a tab or a nested iframe, and is uniquely identified by a tab ID and a frame ID.
452 webNavigation.onBeforeNavigate API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onBeforeNavigate, webNavigation
Fired when the browser is about to start a navigation event.
453 webNavigation.onCommitted API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onCommitted, webNavigation
Fired when a navigation is committed. At least part of the new document has been received from the server and the browser has decided to switch to the new document.
454 webNavigation.onCompleted API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onCompleted, webNavigation
Fired when a document, including the resources it refers to, is completely loaded and initialized. This is equivalent to the DOM load event.
455 webNavigation.onCreatedNavigationTarget API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onCreatedNavigationTarget, webNavigation
Fired when a new window, or a new tab in an existing window, is created to host the target of a navigation. For example, this event is sent when:
456 webNavigation.onDOMContentLoaded API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onDOMContentLoaded, webNavigation
Fired when the DOMContentLoaded event is fired in the page. At this point the document is loaded and parsed, and the DOM is fully constructed, but linked resources such as images, stylesheets and subframes may not yet be loaded.
457 webNavigation.onErrorOccurred API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onErrorOccurred, webNavigation
Fired when an error occurs and the navigation is aborted. This can happen if either a network error occurred, or the user aborted the navigation.
458 webNavigation.onHistoryStateUpdated API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onHistoryStateUpdated, webNavigation
Fired when the page used the history API to update the URL displayed in the browser's location bar. All future events for this frame will use the updated URL.
459 webNavigation.onReferenceFragmentUpdated API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onReferenceFragmentUpdated, webNavigation
Events have three functions:
460 webNavigation.onTabReplaced API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onTabReplaced, webNavigation
Fired when the contents of the tab is replaced by a different (usually previously pre-rendered) tab.
461 webRequest API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, webRequest
Add event listeners for the various stages of making an HTTP request. The event listener receives detailed information about the request, and can modify or cancel the request.
462 webRequest.BlockingResponse API, Add-ons, BlockingResponse, Extensions, Non-standard, Reference, Type, WebExtensions, webRequest
An object of this type is returned by event listeners that have set "blocking" in their extraInfoSpec argument.
463 webRequest.HttpHeaders API, Add-ons, Extensions, HttpHeaders, Non-standard, Reference, Type, WebExtensions, webRequest
An array of HTTP headers. Each header is represented as an object with two properties: name and either value or binaryValue.
464 webRequest.MAX_HANDLER_BEHAVIOR_CHANGED_CALLS_PER_10_MINUTES API, Add-ons, Extensions, MAX_HANDLER_BEHAVIOR_CHANGED_CALLS_PER_10_MINUTES, Non-standard, Property, Reference, WebExtensions, webRequest
The maximum number of times that handlerBehaviorChanged() can be called in a 10 minute period.
465 webRequest.RequestFilter API, Add-ons, Extensions, Non-standard, Reference, RequestFilter, Type, WebExtensions, webRequest
An object describing filters to apply to webRequest events.
466 webRequest.ResourceType API, Add-ons, Extensions, Non-standard, Reference, ResourceType, Type, WebExtensions, webRequest
This type is a string, which represents the context in which a resource was fetched in a web request.
467 webRequest.StreamFilter API, Add-ons, Extensions, Reference, StreamFilter, Type, WebExtensions, webRequest
A StreamFilter is an object you can use to monitor and modify HTTP responses.
468 webRequest.StreamFilter.close() Add-ons, Extensions, Method, StreamFilter.close, WebExtensions, webRequest
Closes the request. After this is called, no further response data will be passed to the browser's rendering engine and no more filter events will be given to the extension.
469 webRequest.StreamFilter.disconnect() API, Add-ons, Extensions, StreamFilter.disconnect, WebExtensions, webRequest
You should always call disconnect() or close() once you don't need to interact with the response any further.
470 webRequest.StreamFilter.ondata API, Add-ons, Extensions, Reference, StreamFilter.ondata, WebExtensions, webRequest
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
471 webRequest.StreamFilter.onerror API, Add-ons, Extensions, Reference, StreamFilter.onerror, WebExtensions, webRequest
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
472 webRequest.StreamFilter.onstart API, Add-ons, Extensions, Reference, StreamFilter.onstart, WebExtensions, webRequest
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
473 webRequest.StreamFilter.onstop
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
474 webRequest.StreamFilter.resume() API, Add-ons, Extensions, Reference, StreamFilter.resume(), WebExtensions, webRequest
Resumes a request that was previously suspended through a call to suspend().
475 webRequest.StreamFilter.status API, Add-ons, Extensions, Reference, StreamFilter.status, WebExtensions, webRequest
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
476 webRequest.StreamFilter.suspend() API, Add-ons, Extensions, Reference, StreamFilter.suspend(), WebExtensions, webRequest
Suspends a request. After this is called, no more data will be delivered until the request is resumed with a call to resume().
477 webRequest.StreamFilter.write() API, Add-ons, Extensions, Reference, StreamFilter.write(), WebExtensions, webRequest
None.
478 webRequest.Streamfilter.error API, Add-ons, Extensions, Reference, StreamFilter.error, WebExtensions, webRequest
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
479 webRequest.UploadData API, Add-ons, Extensions, Non-standard, Reference, Type, UploadData, WebExtensions, webRequest
Contains data uploaded in a URL request.
480 webRequest.filterResponseData() API, Add-ons, Extensions, Method, Reference, WebExtensions, filterResponseData, webRequest
Use this function to create a webRequest.StreamFilter object for a particular request. You can then use the stream filter to monitor and modify the response. You'd typically call this function from a webRequest event listener.
481 webRequest.handlerBehaviorChanged() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, handlerBehaviorChanged, webRequest
Suppose an extension's job is to block web requests against a pattern, and the following scenario happens:
482 webRequest.onAuthRequired API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onAuthRequired, webRequest
Fired when the server sends a 401 or 407 status code: that is, when the server is asking the client to provide authentication credentials such as a username and password.
483 webRequest.onBeforeRedirect API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onBeforeRedirect, webRequest
Fired when a server-initiated redirect is about to occur.
484 webRequest.onBeforeRequest API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onBeforeRequest, webRequest
This event is triggered when a request is about to be made, and before headers are available. This is a good place to listen if you want to cancel or redirect the request.
485 webRequest.onBeforeSendHeaders API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onBeforeSendHeaders, webRequest
This event is triggered before sending any HTTP data, but after all HTTP headers are available. This is a good place to listen if you want to modify HTTP request headers.
486 webRequest.onCompleted API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onCompleted, webRequest
Fired when a request has completed.
487 webRequest.onErrorOccurred API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onErrorOccurred, webRequest
Fired when a request could not be processed due to an error: for example, a lack of Internet connectivity.
488 webRequest.onHeadersReceived API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onHeadersReceived, webRequest
Fired when the HTTP response headers associated with a request have been received. You can use this event to modify HTTP response headers.
489 webRequest.onResponseStarted API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onResponseStarted, webRequest
Fired when the first byte of the response body is received.
490 webRequest.onSendHeaders API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onSendHeaders, webRequest
This event is fired just before sending headers. If your extension or some other extension modified headers in onBeforeSendHeaders, you'll see the modified version here.
491 windows API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, Windows
Interact with browser windows. You can use this API to get information about open windows and to open, modify, and close windows. You can also listen for window open, close, and activate events.
492 windows.CreateType API, Add-ons, CreateType, Extensions, Non-standard, Reference, Type, WebExtensions, Windows
Specifies the type of browser window to create.
493 windows.WINDOW_ID_CURRENT API, Add-ons, Extensions, Non-standard, Property, Reference, WINDOW_ID_CURRENT, WebExtensions, Windows
browser.windows.WINDOW_ID_CURRENT holds the windowId value for the current window.
494 windows.WINDOW_ID_NONE API, Add-ons, Extensions, Non-standard, Property, Reference, WINDOW_ID_NONE, WebExtensions, Windows
The windowId value that represents the absence of a browser window.
495 windows.Window API, Add-ons, Extensions, Non-standard, Reference, Type, WebExtensions, Window, Windows
Information about a browser window.
496 windows.WindowState API, Add-ons, Extensions, Non-standard, Reference, Type, WebExtensions, WindowState, Windows
The state of this browser window.
497 windows.WindowType API, Add-ons, Extensions, Non-standard, Reference, Type, WebExtensions, WindowType, Windows
The type of browser window this is.
498 windows.create() API, Add-ons, Create, Extensions, Method, Non-standard, Reference, WebExtensions, Windows
Creates a new window.
499 windows.get() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, Windows, get
Gets details about a window, given its ID. The details are passed into a callback.
500 windows.getAll() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, Windows, getAll
Gets information about all open windows, passing them into a callback.
501 windows.getCurrent() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, Windows, getCurrent
Gets the current browser window, passing its details into a callback.
502 windows.getLastFocused() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, Windows, getLastFocused
Gets the window that was most recently focused — typically the window 'on top'.
503 windows.onCreated API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, Windows, onCreated
Fired when a window is created.
504 windows.onFocusChanged API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, Windows, onFocusChanged
Fired when the currently focused window changes. Will be windows.WINDOW_ID_NONE if all browser windows have lost focus.
505 windows.onRemoved API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, Windows, onRemoved
Fired when a window is closed.
506 windows.remove() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, Windows, remove
Closes a window and all the tabs inside it, given the window's ID.
507 windows.update() API, Add-ons, Extensions, Method, Non-standard, Reference, Update, WebExtensions, Windows
Updates the properties of a window. Use this to move, resize, and (un)focus a window, etc.
508 Match patterns WebExtensions
Match patterns are a way to specify groups of URLs: a match pattern matches a specific set of URLs. They are for extensions using WebExtensions APIs in a few places, most notably to specify which documents to load content scripts into, and to specify which URLs to add webRequest listeners to.
509 Modify a web page WebExtensions
One of the most common use cases for an extension is to modify a web page. For example, an extension might want to change the style applied to a page, hide particular DOM nodes, or inject extra DOM nodes into the page.
510 Native manifests Extensions, WebExtensions
Native manifests are specially formatted JSON files that are provisioned on the user's computer by some means outside the extension installation process. For example, a native manifest might be provisioned by a device administrator or by a native application installer.
511 Native messaging WebExtensions
Native messaging enables an extension to exchange messages with a native application installed on the user's computer. This enables native applications to provide a service to extensions without needing to be reachable over the web. One common example here is password managers: the native application manages storage and encryption of passwords, and communicates with the extension to populate web forms. Native messaging also enables extensions to access resources that are not accessible through WebExtension APIs, such as some particular piece of hardware.
512 Porting a Google Chrome extension WebExtensions
Extensions developed with WebExtension APIs are designed for cross-browser compatibility: to a large extent, the technology is directly code-compatible with the extension API supported by Google Chrome and Opera. Extensions written for these browsers will, in most cases, run in Firefox with just a few changes. Almost all of the WebExtension APIs are supported using callback functions under the chrome namespace, the same as Chrome. The only APIs which are not supported in the chrome namespace are those which are intentionally incompatible with Chrome. In those few cases, the API documentation page will explicitly state that it's only supported in the browser namespace. The process of porting an extension from Chrome or Opera is like this:
513 Porting a legacy Firefox extension WebExtensions
If you have developed a Firefox extension using XUL/XPCOM or the Add-on SDK, this page will help you migrate your extension to use WebExtensions APIs. The standard to build extensions for Firefox is to use
514 Prerequisites
All you need is Firefox 45 or higher. See Your first extension to get started.
515 Publishing your extension WebExtensions
Once you've finished writing and testing your extension, you'll probably want to share it with other people. Mozilla operates a website: addons.mozilla.org (commonly abbreviated to AMO), where developers can publish add-ons and users can find them. By publishing your extension on AMO, you can participate in our community of users and creators, and find an audience for your extension.
516 Request the right permissions Add-ons, Beginner, Extensions, How-to, Intermediate, Permissions
Or how to avoid permissions discouraging users from installing your extensions.
517 Safely inserting external content into a page Add-ons, Beginner, Extensions, How-to, Security, WebExtensions
There are times when you might want or need to include content from an external source in your extension. But, there is the risk that the source may have malicious scripts embedded in it—added by either the developer of the source or by a malicious third-party.
518 Temporary installation in Firefox WebExtensions
This article describes how an add-on developer can temporarily install an extension in Firefox for testing and debugging. The extension will stay installed until you restart Firefox. You can use this method with any kind of restartless extension, including bootstrapped extensions and Add-on SDK add-ons.
519 Tips and Tricks
This page contains various tips and tricks which should be useful to many people developing extensions using WebExtension APIs.
520 User experience best practices Add-ons, Extensions, Guide, UI, UX
The best Firefox extensions provide users with a new feature or capability that addresses a need. Addressing this need will help users work smarter or more efficiently, or get more pleasure out of their browsing experience.
521 User interface Landing, User Interface, WebExtensions
Extensions that use WebExtension APIs are provided with several user interface options so that their functionality can be made available to the user. A summary of those options is provided below, with a more detailed introduction to each user interface option in this section.
522 Address bar button User Interface, WebExtensions
Commonly referred to as a page action, this user interface option is a button added to the browser address bar. Users click the button to interact with your extension.
523 Address bar suggestions User Interface, WebExtensions
Using the omnibox API, extensions can customize the suggestions offered in the browser address bar's drop-down when the user enters a keyword.
524 Browser styles Add-ons, Extensions, WebExtensions
Certain user interface components - browser and page action popups, sidebars, and options pages - are specified by your extension in essentially the same way:
525 Context menu items WebExtensions
No summary!
526 Extension pages
You can include html pages in your extension to provide forms, help, or any other content your extension needs.
527 Notifications WebExtensions
No summary!
528 Options page WebExtensions
No summary!
529 Popups User Interface, WebExtensions
No summary!
530 Sidebars WebExtensions
No summary!
531 Toolbar button WebExtension
Commonly referred to as a browser action, this user interface option is a button added to the browser toolbar. Users click the button to interact with your extension.
532 devtools panels Beginner, Guide, User Interface, WebExtensions
When an extension provides tools that are of use to developers, it's possible to add a UI for them to the browser's developer tools as a new panel.
533 What are extensions? Extensions, WebExtensions
Extensions are bits of code that modify the functionality of a web browser. They are written using standard web technologies - JavaScript, HTML, and CSS - plus some dedicated JavaScript APIs. Among other things, extensions can add new features to the browser or change the appearance or content of particular websites.
534 Work with the Bookmarks API Add-ons, Beginner, Bookmarks, Extensions, How-to, WebExtensions
Bookmarks enable users to collect and organize lists of web pages, so they can easily get back to their favorites. Using the Bookmarks API, your extensions can manipulate bookmarks in much the same way users can.
535 Work with the Cookies API Add-ons, Beginner, Cookies, Extensions, How-to, WebExtensions
With the Cookies API your extensions have access to capabilities similar to those used by websites to store and read cookies. The API’s features give extensions the ability to store information on a site-by-site basis. So, as we shall see in the example, you could store details of a user’s choice of background color for a site. Then, when the user revisits the site, your extension can use the API’s ability to get details about cookies and read them to recover the user’s choice and apply it to the website.
536 Working with files Guide, WebExtensions
Your browser extension may need to work with files to deliver its full functionality. This article looks at the five mechanisms you have for handling files:
537 Working with the Tabs API Add-ons, Beginner, Extensions, How-to, WebExtensions, tabs
Tabs let a user open several web pages in their browser window and then switch between those web pages. With the Tabs API, you can work with and manipulate these tabs to create utilities that provide users with new ways to work with tabs or to deliver the features of your extension.
538 Your first extension Guide, WebExtensions
In this article we'll walk through creating an extension for Firefox, from start to finish. The extension just adds a red border to any pages loaded from "mozilla.org" or any of its subdomains.
539 Your second extension WebExtensions
No summary!
540 manifest.json Add-ons, Extensions, WebExtensions
The manifest.json file is a JSON-formatted file, and is the only file that every extension using WebExtension APIs must contain.
541 applications Add-ons, Extensions, WebExtensions
The applications key contains keys that are specific to a particular host application.
542 author Add-ons, Extensions, WebExtensions
The extension's author, intended for display in the browser's user interface. If the developer key is supplied and it contains the "name" property, it will override the author key. There's no way to specify multiple authors.
543 background Add-ons, Extensions, WebExtensions
Use the background key to include one or more background scripts, and optionally a background page in your extension.
544 browser_action Add-ons, Extensions, WebExtensions
A browser action is a button that your extension adds to the browser's toolbar. The button has an icon, and may optionally have a popup whose content is specified using HTML, CSS, and JavaScript.
545 chrome_settings_overrides Add-ons, Extensions, WebExtensions, chrome_settings_overrides, manifest.json
Use the chrome_settings_overrides key to override certain browser settings. Two settings are available:
546 chrome_url_overrides Add-ons, Extensions, WebExtensions
Use the chrome_url_overrides key to provide a custom replacement for the documents loaded into various special pages usually provided by the browser itself.
547 commands Add-ons, Extensions, WebExtensions
Use the commands key to define one or more keyboard shortcuts for your extension.
548 content_scripts Add-ons, Extensions, WebExtensions
Instructs the browser to load content scripts into web pages whose URL matches a given pattern.
549 content_security_policy Add-ons, Extensions, WebExtensions
Extensions have a content security policy applied to them by default. The default policy restricts the sources from which they can load<script> and <object> resources, and disallows potentially unsafe practices such as the use of eval(). See Default content security policy to learn more about the implications of this.
550 default_locale Add-ons, Extensions, WebExtensions
This key must be present if the extension contains the _locales directory, and must be absent otherwise. It identifies a subdirectory of _locales, and this subdirectory will be used to find the default strings for your extension.
551 description Add-ons, Extensions, WebExtensions
A short description of the extension, intended for display in the browser's user interface.
552 developer Add-ons, Extensions, WebExtensions
The name of the extension's developer and their homepage URL, intended for display in the browser's user interface.
553 devtools_page
Use this key to enable your extension to extend the browser's built-in devtools.
554 homepage_url Add-ons, Extensions, WebExtensions
URL for the extension's home page.
555 icons Add-ons, Extensions, WebExtensions
The icons key specifies icons for your extension. Those icons will be used to represent the extension in components such as the Add-ons Manager.
556 incognito Add-ons, WebExtensions, incognito, manifest.json
Use the incognito key to control how the extension works with private browsing windows.
557 manifest_version Add-ons, Extensions, WebExtensions
This key specifies the version of manifest.json used by this extension.
558 name Add-ons, Extensions, WebExtensions
Name of the extension. This is used to identify the extension in the browser's user interface and on sites like addons.mozilla.org.
559 omnibox Add-ons, Extensions, WebExtensions
Use the omnibox key to define an omnibox keyword for your extension.
560 optional_permissions Add-ons, WebExtensions, manifest.json, optional_permissions
Use the optional_permissions key to list permissions which you want to ask for at runtime, after your extension has been installed.
561 options_ui Add-ons, Extensions, WebExtensions
Use the options_ui key to define an options page for your extension.
562 page_action Add-ons, Extensions, WebExtensions
A page action is an icon that your extension adds inside the browser's URL bar.
563 permissions Add-ons, Extensions, WebExtensions
Use the permissions key to request special powers for your extension. This key is an array of strings, and each string is a request for a permission.
564 protocol_handlers Add-ons, Extensions, WebExtensions, manifest.json
Use this key to register one or more web-based protocol handlers.
565 short_name Add-ons, Extensions, WebExtensions
Short name for the extension. If given, this will be used in contexts where the name field is too long. It's recommended that the short name should not exceed 12 characters. If the short name field is not included in manifest.json, then name will be used instead and may be truncated.
566 sidebar_action WebExtensions
A sidebar is a pane that is displayed at the left-hand side of the browser window, next to the web page. The browser provides a UI that enables the user to see the currently available sidebars and to select a sidebar to display.
567 theme Add-ons, Themes
Use the theme key to define a static theme to apply to Firefox.
568 version Add-ons, Extensions, WebExtensions
Version of the extension, formatted as numbers and ASCII characters separated by dots. For the details of the version format, see the Version format page.
569 web_accessible_resources Add-ons, Extensions, WebExtensions
Sometimes you will want to package some resources - for example, images, HTML, CSS, or JavaScript - with your extension, and make them available to web pages.
570 web-ext command reference Options, Reference, Tools, WebExtensions, commands, web-ext
This page lists all the commands and options available under the web-ext command line tool.
571 Creating an appealing add-on listing Add-ons, Beginner, Guide, WebExtension, publishing
There are two essential steps to getting people to use your add-on: they need to discover your add-on and open the listing page, then the listing page needs to encourage them to click the Add to Firefox button. The content you add to a listing is therefore vital: from making effective use of keywords in your descriptions, to get visibility in external search engine results, through having an icon that attracts a user’s attention from a category list, to screenshots that show how useful your add-on is.
572 Index Add-ons, Glossary, Guide, Index
Found 582 pages:
573 Signing and distributing your add-on
Once you have a first build of your add-on, you'll want to distribute it so others can give it a try. Whether you are distributing your add-on publicly or privately, through addons.mozilla.org (AMO) or elsewhere, you'll want to have your add-on package signed.
574 Submitting an add-on Add-ons, Tutorial, WebExtensions
This article walks you through the process of submitting an add-on. If you are just looking to submit your add-on, click here
575 Source Code Submission Add-ons, Review Policy
When uploading extensions to addons.mozilla.org (AMO), you are given the option to attach source code. There are certain cases where this is required, but others where it is not recommended. This page will explain when and where source code should be uploaded, and how to provide reviewers with instructions on reading your source code. Providing clear instructions to the reviewer will help you get a speedier review for your add-on.
576 Themes Add-ons, Look & Feel, Themes
Themes allow you to change the look and feel of the user interface and personalize it to your tastes. Learn how to create and share themes!
577 Create Your Own Firefox Background Theme
No summary!
578 Lightweight themes Add-ons, Lightweight themes, Personas, Themes
No summary!
579 Frequently Asked Questions for Lightweight themes
Lightweight themes are easy-to-install, easy-to-use skins that change the look of your Firefox web browser. There are hundreds of thousands community-designed themes to choose from, with more added every day. Start looking here for designs that fit your style.
580 Obsolete
This page contains theme documents and resources that we don't expect will ever be updated, but which we're keeping for the time being as potential source material for updated docs.
581 Theme concepts Theme, add-on
Themes developed using the WebExtensions API in Firefox enable you to change the look of the browser by adding images to the header area of the Firefox browser; this is the area behind the menu bar, toolbars, address bar, search bar, and tab strip.
582 Updates
Firefox supports automated updates to add-ons using JSON update manifests. Add-ons hosted on AMO automatically receive updates to new versions posted there. Other add-ons must specify the location of their update manifests.

Document Tags and Contributors

 Contributors to this page: wbamberg, dkocho4, fscholz
 Last updated by: wbamberg,