index.md

---

title: pageAction
slug: Mozilla/Add-ons/WebExtensions/API/pageAction
page-type: webextension-api
tags:
  - API
  - Add-ons
  - Extensions
  - Interface
  - Non-standard
  - Reference
  - WebExtensions
  - pageAction
browser-compat: webextensions.api.pageAction

---

{{AddonSidebar}}

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

• {{WebExtAPIRef("pageAction.ImageDataType")}}

  • : Pixel data for an image.

Functions

• {{WebExtAPIRef("pageAction.show()")}}

  • : Shows the page action for a given tab.

• {{WebExtAPIRef("pageAction.hide()")}}

  • : Hides the page action for a given tab.

• {{WebExtAPIRef("pageAction.isShown()")}}

  • : Checks whether the page action is shown or not.

• {{WebExtAPIRef("pageAction.setTitle()")}}

  • : Sets the page action's title. This is displayed in a tooltip over the page action.

• {{WebExtAPIRef("pageAction.getTitle()")}}

  • : Gets the page action's title.

• {{WebExtAPIRef("pageAction.setIcon()")}}

  • : Sets the page action's icon.

• {{WebExtAPIRef("pageAction.setPopup()")}}

  • : Sets the URL for the page action's popup.

• {{WebExtAPIRef("pageAction.getPopup()")}}

  • : Gets the URL for the page action's popup.

• {{WebExtAPIRef("pageAction.openPopup()")}}

  • : Opens the page action's popup.

Events

• {{WebExtAPIRef("pageAction.onClicked")}}

  • : Fired when a page action icon is clicked. This event will not fire if the page action has a popup.

Browser compatibility

{{Compat}}

{{WebExtExamples("h2")}}

Note: This API is based on Chromium's chrome.pageAction API. This documentation is derived from page_action.json in the Chromium code.