MDN self-hosted library · e01.org

browserAction.isEnabled()

Returns true if the browser action is enabled. Returns the global status if the details parameter is omitted or empty, or all its properties are empty.

Open notebook · 2 cells webextension-api-function upstream source

Returns true if the browser action is enabled. Returns the global status if the details parameter is omitted or empty, or all its properties are empty.

Syntax

let gettingIsEnabled = browser.browserAction.isEnabled(
  details // optional object or integer
)

Parameters

  • details
  • : integer or object. As an integer it defines the ID of a tab to check. As an object it contains:

    • tabId
    • : integer. ID of a tab to check.
    • windowId
    • : integer. ID of a window to check.

    If windowId and tabId are supplied, the function fails.

Return value

A Promise fulfilled with true if the extension's browser action is enabled, and false otherwise.

Examples

Check the global state:

browser.browserAction.isEnabled({}).then((result) => {
  console.log(result);
});

Check the state of the active tab:

async function enabledInActiveTab() {
  let tabs = await browser.tabs.query({
    currentWindow: true,
    active: true,
  });
  let enabled = await browser.browserAction.isEnabled({
    tabId: tabs[0].id,
  });
  console.log(enabled);
}

Browser compatibility