ContextQMD
Back to Content

pageAction.isShown()

files/en-us/mozilla/add-ons/webextensions/api/pageaction/isshown/index.md

latest1009 B
Original Source

Returns true if the page action is being shown for the given tab.

This is an asynchronous function that returns a Promise.

Syntax

js-nolint
let gettingIsShown = browser.pageAction.isShown(
  details // object
)

Parameters

  • details
    • : object. An object containing the tabId to check.
      • tabId
        • : integer. ID of the tab to check.

Return value

A Promise that will be fulfilled with true if the extension's page action is being shown for the given tab, and false otherwise.

Examples

Check the state of the currently active tab:

js
async function shownInActiveTab() {
  let tabs = await browser.tabs.query({
    currentWindow: true,
    active: true,
  });
  let shown = await browser.pageAction.isShown({
    tabId: tabs[0].id,
  });
  console.log(shown);
}

{{WebExtExamples}}

Browser compatibility

{{Compat}}