browserAction.isEnabled()
Returns true
if the browser action is enabled.
This is an asynchronous function that returns a Promise
.
Syntax
let gettingIsEnabled = browser.browserAction.isEnabled( details // object )
Parameters
details
-
object
. An object optionally containing thetabId
orwindowId
to check. -
-
tabId
Optional -
integer
. ID of a tab to check. -
windowId
Optional -
integer
. ID of a window to check.
-
- If windowId and tabId are both supplied, the function fails.
- If windowId and tabId are both omitted, the global enabled/disabled status is returned.
Return value
A Promise
that will be fulfilled with true
if the extension's browser action is enabled, and false
otherwise.
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
isEnabled |
No |
No |
59 |
? |
No |
No |
? |
? |
79 |
? |
? |
? |
Examples
Check the global state:
browser.browserAction.isEnabled({}).then(result => { console.log(result); });
Check the state of the currently 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); }
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/browserAction/isEnabled