pageAction

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. If your icon should always be available, 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.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.

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

ChromeEdgeFirefoxFirefox for AndroidOpera
ImageDataTypeYesNo45NoYes
getPopupYesYes4550 *Yes
getTitleYesYes45NoYes
hideYesYes4550 *Yes
onClickedYesYes4550Yes
setIconYes *Yes *45No15
setPopupYesYes4550 *Yes
setTitleYesYes45NoYes
showYesYes4550 *Yes

Edge incompatibilities

Promises are not supported in Edge. Use callbacks instead.

Example extensions

Acknowledgements

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.

Document Tags and Contributors

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