Add special shortcut _execute_action #22018

rebloor · 2022-11-02T23:05:48Z

Description

Adds details about the special shortcut _execute_action which became available to MV3 Extensions with the introduction of the action API and manifest key.

Related issues and pull requests

Addresses the outstanding documentation needs of Bug 1706398 Implement "action" API / manifest key.

github-actions · 2022-11-02T23:08:41Z

Preview URLs

(this comment was updated 2022-11-03 21:13:49.909782)

rebloor · 2022-11-02T23:19:28Z

files/en-us/mozilla/add-ons/webextensions/api/menus/createproperties/index.md

@@ -22,9 +22,12 @@ An `object` passed to the {{WebExtAPIRef("menus.create()", "menus.create()")}} o
  - : `string`. String describing an action that should be taken when the user clicks the item. Possible values are:

    - `"_execute_browser_action"`: simulate a click on the extension's browser action, opening its popup if it has one
+    - `"_execute_action"`: simulate a click on the extension's action, opening its popup if it has one


@Rob--W This file appears to be orphaned. menu.create includes the information directly and menu.update makes reference to menu.create. Should I delete this page (with an appropriate redirect)?

I seem to have an issue with the delete:

yarn content delete Mozilla/Add-ons/WebExtensions/API/menus/createProperties yarn run v1.22.18 $ env-cmd --silent cross-env CONTENT_ROOT=files yari-tool delete Mozilla/Add-ons/WebExtensions/API/menus/createProperties node:events:505 throw er; // Unhandled 'error' event ^ Error: spawn yari-tool ENOENT at Process.ChildProcess._handle.onexit (node:internal/child_process:283:19) at onErrorNT (node:internal/child_process:478:16) at processTicksAndRejections (node:internal/process/task_queues:83:21) Emitted 'error' event on ChildProcess instance at: at Process.ChildProcess._handle.onexit (node:internal/child_process:289:12) at onErrorNT (node:internal/child_process:478:16) at processTicksAndRejections (node:internal/process/task_queues:83:21) { errno: -2, code: 'ENOENT', syscall: 'spawn yari-tool', path: 'yari-tool', spawnargs: [ 'delete', 'Mozilla/Add-ons/WebExtensions/API/menus/createProperties' ] } error Command failed with exit code 1. info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

Thoughts? Open a ticket on the yari?

Did you install the dependencies? The error seems to suggest that yari-tool is not available.

According to #16945, the binaries are provided by @mdn/yari.

I assumed so (as I've been running yarn start for a while). However, reinstalling has resolved the issue. Thanks.

rebloor · 2022-11-02T23:20:11Z

files/en-us/mozilla/add-ons/webextensions/api/menus/create/index.md

@@ -44,9 +44,12 @@ browser.menus.create(
      - : `string`. String describing an action that should be taken when the user clicks the item. Possible values are:



@Rob--W was your feedback to remove the list from here and simply rely on a link to the special shortcut documentation?

The main point was to link a central place with detailed documentation, which you have done. Deletion of the list is not strictly necessary.

One change that may be considered is the addition of "(MV2)" to _execute_browser_action and "(MV3)" to _execute_action (across all 3 pages where this concise list appears).

Rob--W · 2022-11-03T00:21:50Z

files/en-us/mozilla/add-ons/webextensions/api/menus/create/index.md

        - `"_execute_page_action"`: simulate a click on the extension's page action, opening its popup if it has one
        - `"_execute_sidebar_action"`: open the extension's sidebar

+        See the documentation of special shortcuts in the manifest.json key [`commands`](/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/commands#special_shortcuts) for details.
+
        Clicking the item will still trigger the {{WebExtAPIRef("menus.onClicked")}} event, but there's no guarantee of the ordering here: the command may be executed before `onClicked` fires.


This documentation is incorrect. When the command is supported, the onClicked event is not fired. When it's not recognized, the event is fired, which the extension can use to implement a fallback if they like.

This behavior changed in Fx 91 in the bug associated with this PR.

This review comment applies to menus.create and update.

I'm slightly confused by the use of the term supported and recognized. Do you mean whether the special shortcut is implemented or not implemented? I've attempted an update, please confirm.

Rob--W · 2022-11-03T00:25:11Z

files/en-us/mozilla/add-ons/webextensions/api/menus/createproperties/index.md

@@ -22,9 +22,12 @@ An `object` passed to the {{WebExtAPIRef("menus.create()", "menus.create()")}} o
  - : `string`. String describing an action that should be taken when the user clicks the item. Possible values are:

    - `"_execute_browser_action"`: simulate a click on the extension's browser action, opening its popup if it has one
+    - `"_execute_action"`: simulate a click on the extension's action, opening its popup if it has one


Rob--W · 2022-11-03T00:33:44Z

files/en-us/mozilla/add-ons/webextensions/manifest.json/commands/index.md

+  <tr>
+    <th></th>
+    <th>Manifest V2</th>
+    <th>Manifiest V3</th>


Suggested change

<th>Manifiest V3</th>

<th>Manifest V3</th>

Typo

Rob--W · 2022-11-03T00:34:51Z

files/en-us/mozilla/add-ons/webextensions/user_interface/popups/index.md

@@ -16,7 +16,7 @@ A popup is a dialog that's associated with a [toolbar button](/en-US/docs/Mozill

 When the user clicks the button, the popup is shown. When the user clicks anywhere outside the popup, the popup is closed. The popup can be closed programmatically by calling [`window.close()`](/en-US/docs/Web/API/Window/close) from a script running in the popup. However, you can't open the popup programmatically from an extension's JavaScript; it can be opened only in response to a user action.

-You can define a keyboard shortcut that opens the popup using the `"_execute_browser_action"` and `"_execute_page_action"` shortcuts. See the documentation for the manifest.json key [`commands`](/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/commands).
+You can define a keyboard shortcut that opens the popup using the `"_execute_browser_action"` and `"_execute_page_action"` shortcuts in Manifest V2 and `"_execute_action"`and, where supported, `"_execute_page_action"` shortcuts in Manifiest V3. See the documentation for the special shortcuts in manifest.json key [`commands`](/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/commands#special_shortcuts).


Suggested change

You can define a keyboard shortcut that opens the popup using the `"_execute_browser_action"` and `"_execute_page_action"` shortcuts in Manifest V2 and `"_execute_action"`and, where supported, `"_execute_page_action"` shortcuts in Manifiest V3. See the documentation for the special shortcuts in manifest.json key [`commands`](/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/commands#special_shortcuts).

You can define a keyboard shortcut that opens the popup using the `"_execute_browser_action"` and `"_execute_page_action"` shortcuts in Manifest V2 and `"_execute_action"`and, where supported, `"_execute_page_action"` shortcuts in Manifest V3. See the documentation for the special shortcuts in manifest.json key [`commands`](/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/commands#special_shortcuts).

Rob--W · 2022-11-03T00:39:49Z

files/en-us/mozilla/add-ons/webextensions/api/menus/create/index.md

@@ -44,9 +44,12 @@ browser.menus.create(
      - : `string`. String describing an action that should be taken when the user clicks the item. Possible values are:



The main point was to link a central place with detailed documentation, which you have done. Deletion of the list is not strictly necessary.

One change that may be considered is the addition of "(MV2)" to _execute_browser_action and "(MV3)" to _execute_action (across all 3 pages where this concise list appears).

Rob--W · 2022-11-03T16:33:45Z

files/en-us/mozilla/add-ons/webextensions/api/menus/createproperties/index.md


-    Clicking the item will still trigger the {{WebExtAPIRef("menus.onClicked")}} event, but there's no guarantee of the ordering here: the command may be executed before `onClicked` fires.
+    When specified, clicking the item does not trigger the {{WebExtAPIRef("menus.onClicked")}} event; instead, the pop-up is opened. When not specified, clicking the item triggers {{WebExtAPIRef("menus.onClicked")}} and can be used to implement fallback behavior.


Suggested change

When specified, clicking the item does not trigger the {{WebExtAPIRef("menus.onClicked")}} event; instead, the pop-up is opened. When not specified, clicking the item triggers {{WebExtAPIRef("menus.onClicked")}} and can be used to implement fallback behavior.

When the given command is recognized by the browser, clicking the item does not trigger the {{WebExtAPIRef("menus.onClicked")}} event; instead, the associated action is triggered, such as opening the pop-up. When not specified or not recognized, clicking the item triggers {{WebExtAPIRef("menus.onClicked")}} and can be used to implement fallback behavior.

Suggested change of message; rephrase as needed.

The issue with the previous wording was that it seemed to suggest that if someone were to specify command: "bogus", that the onClicked listener would not be triggered. That's inaccurate. The listener is only not triggered if the command is recognized.

Please check my update

…o action-aliases

Add special shortcut _execute_action

547ebf8

rebloor added the Content:WebExt WebExtensions docs label Nov 2, 2022

rebloor requested a review from Rob--W November 2, 2022 23:05

rebloor self-assigned this Nov 2, 2022

rebloor requested a review from a team as a code owner November 2, 2022 23:05

rebloor requested review from willdurand and removed request for a team November 2, 2022 23:05

github-actions bot added the Content:Other Any docs not covered by another "Content:" label label Nov 2, 2022

Release notes update

ff90855

rebloor requested a review from a team as a code owner November 2, 2022 23:16

rebloor requested review from bsmth and removed request for a team November 2, 2022 23:16

rebloor commented Nov 2, 2022

View reviewed changes

Rob--W reviewed Nov 3, 2022

View reviewed changes

Feedback updates

67a0201

rebloor requested a review from Rob--W November 3, 2022 16:15

Rob--W requested changes Nov 3, 2022

View reviewed changes

Merge branch 'main' into action-aliases

f825dc0

willdurand removed their request for review November 3, 2022 19:58

rebloor added 4 commits November 4, 2022 10:01

Feedback update, removed orphaned page

edc88ab

Merge branch 'main' into action-aliases

2ca03a1

Delete orphaned file

add4496

Merge branch 'action-aliases' of ssh://github.com/rebloor/content int…

154cd41

…o action-aliases

rebloor requested a review from Rob--W November 3, 2022 21:12

Rob--W approved these changes Nov 3, 2022

View reviewed changes

rebloor merged commit c8ea5e9 into mdn:main Nov 3, 2022

rebloor deleted the action-aliases branch November 4, 2022 17:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add special shortcut _execute_action #22018

Add special shortcut _execute_action #22018

rebloor commented Nov 2, 2022

github-actions bot commented Nov 2, 2022 •

edited

rebloor Nov 2, 2022

Rob--W Nov 3, 2022

rebloor Nov 3, 2022

Rob--W Nov 3, 2022

rebloor Nov 3, 2022

rebloor Nov 2, 2022

Rob--W Nov 3, 2022

rebloor Nov 3, 2022

Rob--W Nov 3, 2022

rebloor Nov 3, 2022

Rob--W Nov 3, 2022

Rob--W Nov 3, 2022

rebloor Nov 3, 2022

Rob--W Nov 3, 2022

rebloor Nov 3, 2022

Rob--W Nov 3, 2022

Rob--W Nov 3, 2022

rebloor Nov 3, 2022

		@@ -44,9 +44,12 @@ browser.menus.create(
		- : `string`. String describing an action that should be taken when the user clicks the item. Possible values are:


		Clicking the item will still trigger the {{WebExtAPIRef("menus.onClicked")}} event, but there's no guarantee of the ordering here: the command may be executed before `onClicked` fires.
		When specified, clicking the item does not trigger the {{WebExtAPIRef("menus.onClicked")}} event; instead, the pop-up is opened. When not specified, clicking the item triggers {{WebExtAPIRef("menus.onClicked")}} and can be used to implement fallback behavior.

	When specified, clicking the item does not trigger the {{WebExtAPIRef("menus.onClicked")}} event; instead, the pop-up is opened. When not specified, clicking the item triggers {{WebExtAPIRef("menus.onClicked")}} and can be used to implement fallback behavior.
	When the given command is recognized by the browser, clicking the item does not trigger the {{WebExtAPIRef("menus.onClicked")}} event; instead, the associated action is triggered, such as opening the pop-up. When not specified or not recognized, clicking the item triggers {{WebExtAPIRef("menus.onClicked")}} and can be used to implement fallback behavior.

Add special shortcut _execute_action #22018

Add special shortcut _execute_action #22018

Conversation

rebloor commented Nov 2, 2022

Description

Related issues and pull requests

github-actions bot commented Nov 2, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Nov 2, 2022 •

edited