A page action is shown as a clickable icon inside the browser's address bar. You can listen for clicks on the icon, or can specify a popup that will open when the icon is clicked. Page actions are for actions that are only relevant to particular pages. If your icon should always be available, use a browser action instead.
If you specify a popup, you can define its contents and behavior using HTML, CSS and JavaScript, just like a normal web page. JavaScript running in the popup gets access to all the same WebExtension APIs as your background scripts.
You can define most of a page action's properties declaratively using the page_action key in manifest.json, but can also redefine them programmatically using this API.
Types
pageAction.ImageDataType- Pixel data for an image.
Functions
pageAction.show()- Shows the page action for a given tab.
pageAction.hide()- Hides the page action for a given tab.
pageAction.setTitle()- Sets the title of the page action. This is displayed in a tooltip over the page action.
pageAction.getTitle()- Gets the title of the page action.
pageAction.setIcon()- Sets the icon for the page action.
pageAction.setPopup()- Sets the HTML for the page action's popup.
pageAction.getPopup()- Gets the HTML for the page action's popup.
Events
pageAction.onClicked- Fired when a page action icon is clicked. This event will not fire if the page action has a popup.
Browser compatibility
| Edge | Firefox | Chrome | Opera | |
|---|---|---|---|---|
ImageDataType | ? | 45.0 | Yes | 33 |
getPopup | ? | 45.0 | Yes | 33 |
getTitle | ? | 45.0 | Yes | 33 |
hide | ? | 45.0 | Yes | 33 |
onClicked | ? | 45.0 | Yes | 33 |
setIcon | ? | 45.0 | Yes | 33 |
setPopup | ? | 45.0 | Yes | 33 |
setTitle | ? | 45.0 | Yes | 33 |
show | ? | 45.0 | Yes | 33 |
| Firefox | |
|---|---|
ImageDataType | No |
getPopup | No |
getTitle | No |
hide | No |
onClicked | No |
setIcon | No |
setPopup | No |
setTitle | No |
show | No |
The "Chrome incompatibilities" section is included from https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities using the WebExtChromeCompat macro.
If you need to update this content, edit https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities, then shift-refresh this page to see your changes.
Chrome incompatibilities
None.
Example add-ons
This API is based on Chromium's chrome.pageAction API. This documentation is derived from page_action.json in the Chromium code.
// Copyright 2015 The Chromium Authors. All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
