W3cubDocs
/Web ExtensionspageAction
A page action is a clickable icon inside the browser's address bar.
You can listen for clicks on the icon, or specify a popup that will open when the icon is clicked.
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 your manifest.json, but can also redefine them programmatically using this API.
Page actions are for actions that are only relevant to particular pages (such as "bookmark the current tab"). If they are relevant to the browser as a whole (such as "show all bookmarks"), use a browser action instead.
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.isShown()- Checks whether the page action is shown or not.
pageAction.setTitle()- Sets the page action's title. This is displayed in a tooltip over the page action.
pageAction.getTitle()- Gets the page action's title.
pageAction.setIcon()- Sets the page action's icon.
pageAction.setPopup()- Sets the URL for the page action's popup.
pageAction.getPopup()- Gets the URL for the page action's popup.
pageAction.openPopup()- Opens 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
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
ImageDataType |
Yes |
79 |
45 |
? |
Yes |
14 |
? |
? |
No |
? |
? |
? |
getPopup |
Yes |
14 |
45 |
? |
Yes |
14 |
? |
? |
50
The 'tabId' parameter is ignored: the page action popup is the same for all tabs.
|
? |
? |
? |
getTitle |
Yes |
14 |
45 |
? |
Yes |
14 |
? |
? |
No |
? |
? |
? |
hide |
Yes |
14 |
45 |
? |
Yes |
No |
? |
? |
50
Before version 56, the 'tabId' parameter was ignored, and the page action was hidden for all tabs.
|
? |
? |
? |
isShown |
No |
No |
59 |
? |
No |
No |
? |
? |
No |
? |
? |
? |
onClicked |
Yes |
14 |
45 |
? |
Yes |
14 |
? |
? |
50 |
? |
? |
? |
openPopup |
No |
No |
57 |
? |
No |
No |
? |
? |
No |
? |
? |
? |
setIcon |
Yes
Before Chrome 23, `path` couldn't specify multiple icon files, but had to be a string specifying a single icon path.
|
14 |
45 |
? |
15 |
14 |
? |
? |
No |
? |
? |
? |
setPopup |
Yes |
14 |
45 |
? |
Yes |
14 |
? |
? |
50
The 'tabId' parameter is ignored, and the popup is set for all tabs.
|
? |
? |
? |
setTitle |
Yes |
14 |
45 |
? |
Yes |
14 |
? |
? |
No |
? |
? |
? |
show |
Yes |
14 |
45 |
? |
Yes |
No |
? |
? |
50
Before version 56, the 'tabId' parameter was ignored, and the page action was shown for all tabs.
|
? |
? |
? |
Example extensions
Note: This API is based on Chromium's chrome.pageAction API. This documentation is derived from page_action.json in the Chromium code.
Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/pageAction