Skip to content
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.

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

Document changes to action.openPopup API #22267

Merged
merged 4 commits into from
Aug 29, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,22 @@ Open the browser action's popup.

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

You can only call this function from inside the handler for a [user action](/en-US/docs/Mozilla/Add-ons/WebExtensions/User_actions).
oliverdunk marked this conversation as resolved.
Show resolved Hide resolved

## Syntax

```js-nolint
browser.action.openPopup()
browser.action.openPopup(
options // object
oliverdunk marked this conversation as resolved.
Show resolved Hide resolved
)
```

### Parameters

None.
- `details`
oliverdunk marked this conversation as resolved.
Show resolved Hide resolved

- : An object with the following properties:

- `windowId` {{optional_inline}}
- : `integer`. Window to open the popup for. Defaults to the current window.

### Return value

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,22 @@ browser-compat: webextensions.api.browserAction.openPopup

Open the browser action's popup.

You can only call this function from inside the handler for a [user action](/en-US/docs/Mozilla/Add-ons/WebExtensions/User_actions).

## Syntax

```js-nolint
browser.browserAction.openPopup()
browser.browserAction.openPopup(
options // object
)
```

### Parameters

None.
- `details`

- : An object with the following properties:

- `windowId` {{optional_inline}}
- : `integer`. Window to open the popup for. Defaults to the current window.

### Return value

Expand Down