action.disable()

Disables the browser action for a tab, meaning that it cannot be clicked when that tab is active.

Note: This API is available in Manifest V3 or higher.

Syntax

js
browser.action.disable(
  tabId // optional integer
)

Parameters

tabId Optional

integer. The id of the tab for which you want to disable the browser action.

Examples

Disable the browser action when clicked, and re-enable it every time a new tab is opened:

js
browser.tabs.onCreated.addListener(() => {
  browser.action.enable();
});

browser.action.onClicked.addListener(() => {
  browser.action.disable();
});

Disable the browser action only for the active tab:

js
browser.action.onClicked.addListener((tab) => {
  browser.action.disable(tab.id);
});

Browser compatibility

BCD tables only load in the browser

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