action.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.
Note: This API is available in Manifest V3 or higher.
Syntax
js
let gettingIsEnabled = browser.action.isEnabled(
details // optional object or integer
)
Parameters
detailsOptional-
integerorobject. An anintegerit defines the ID of a tab to check. As anobjectit contains:tabIdOptional-
integer. ID of a tab to check. windowIdOptional-
integer. ID of a window to check.
If
windowIdandtabIdare supplied, the function fails.
Note:
Chrome only support the details as an integer, the ID of a tab to check.
Return value
A Promise fulfilled with true if the extension's browser action is enabled, and false otherwise.
Examples
Check the global state:
js
browser.action.isEnabled({}).then((result) => {
console.log(result);
});
Check the state of the active tab:
js
async function enabledInActiveTab() {
let tabs = await browser.tabs.query({
currentWindow: true,
active: true,
});
let enabled = await browser.action.isEnabled({
tabId: tabs[0].id,
});
console.log(enabled);
}
Browser compatibility
| desktop | mobile | ||||||
|---|---|---|---|---|---|---|---|
isEnabled
|
|
|
|
|
|
|
|
details (object)
|
|
|
|
|
|
|
|
details.windowId
|
|
|
|
|
|
|
|
details (integer, tabId)
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support