Skip to content

Bug-2012727 isEnabled updates for action and browseAction #42997

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rebloor wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −14
Open

Bug-2012727 isEnabled updates for action and browseAction #42997

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions files/en-us/mozilla/add-ons/webextensions/api/action/isenabled/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ Returns `true` if the browser action is enabled.
> [!NOTE]
> This API is available in Manifest V3 or higher.

This is an asynchronous function that returns a [`Promise`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise).

## Syntax

```js-nolint
Expand All @@ -23,7 +21,7 @@ let gettingIsEnabled = browser.action.isEnabled(

### Parameters

- `details`
- `details` {{optional_inline}}
- : `object`. An object optionally containing the `tabId` or `windowId` to check.
- `tabId` {{optional_inline}}
- : `integer`. ID of a tab to check.
Expand All @@ -32,12 +30,15 @@ let gettingIsEnabled = browser.action.isEnabled(

<!---->

- If windowId and tabId are both supplied, the function fails.
- If windowId and tabId are both omitted, the global enabled/disabled status is returned.
- If `windowId` and `tabId` are supplied, the function fails.
- If `details`, or `windowId` and `tabId` are omitted, the global status is returned.

> [!NOTE]
> Chrome doesn't support the `details` object. It provides for setting an optional `tabId` only.

### Return value

A [`Promise`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) that will be fulfilled with `true` if the extension's browser action is enabled, and `false` otherwise.
A [`Promise`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) fulfilled with `true` if the extension's browser action is enabled, and `false` otherwise.

## Examples

Expand All @@ -49,7 +50,7 @@ browser.action.isEnabled({}).then((result) => {
});
```

Check the state of the currently active tab:
Check the state of the active tab:

```js
async function enabledInActiveTab() {
Expand Down
12 changes: 5 additions & 7 deletions files/en-us/mozilla/add-ons/webextensions/api/browseraction/isenabled/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ sidebar: addonsidebar

Returns `true` if the browser action is enabled.

This is an asynchronous function that returns a [`Promise`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise).

## Syntax

```js-nolint
Expand All @@ -20,7 +18,7 @@ let gettingIsEnabled = browser.browserAction.isEnabled(

### Parameters

- `details`
- `details` {{optional_inline}}
- : `object`. An object optionally containing the `tabId` or `windowId` to check.
- `tabId` {{optional_inline}}
- : `integer`. ID of a tab to check.
Expand All @@ -29,12 +27,12 @@ let gettingIsEnabled = browser.browserAction.isEnabled(

<!---->

- If windowId and tabId are both supplied, the function fails.
- If windowId and tabId are both omitted, the global enabled/disabled status is returned.
- If `windowId` and `tabId` are supplied, the function fails.
- If `details`, or `windowId` and `tabId` are omitted, the global status is returned.

### Return value

A [`Promise`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) that will be fulfilled with `true` if the extension's browser action is enabled, and `false` otherwise.
A [`Promise`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) fulfilled with `true` if the extension's browser action is enabled, and `false` otherwise.

## Examples

Expand All @@ -46,7 +44,7 @@ browser.browserAction.isEnabled({}).then((result) => {
});
```

Check the state of the currently active tab:
Check the state of the active tab:

```js
async function enabledInActiveTab() {
Expand Down