Bug-1538451 documentation for commands.openShortcutSetting

[rebloor]

Description

Addresses the dev-docs-needed requirements of Bug 1538451 Make extension shortcut management page accessible by a link/URL for a WebExtension by adding documentation for commands.openShortcutSetting along with accompanying release note.

Related issues and pull requests

BCD for commands.openShortcutSetting added in mdn/browser-compat-data#25944

[github-actions]

Preview URLs (7 pages)

• /en-US/docs/Mozilla/Add-ons/WebExtensions/API/commands/getAll
• /en-US/docs/Mozilla/Add-ons/WebExtensions/API/commands/openShortcutSettings
• /en-US/docs/Mozilla/Add-ons/WebExtensions/API/commands/reset
• /en-US/docs/Mozilla/Add-ons/WebExtensions/API/commands/update
• /en-US/docs/Mozilla/Add-ons/WebExtensions/API/commands
• /en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/commands
• /en-US/docs/Mozilla/Firefox/Releases/137

External URLs (5)

URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/API/commands/openShortcutSettings
Title: openShortcutSettings()

• https://support.mozilla.org/en-US/kb/manage-extension-shortcuts-firefox (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/API/commands/getAll
Title: getAll()

• https://developer.chrome.com/docs/extensions/reference/api/commands (1 time)

---

URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/commands
Title: commands

• https://bug1303384.bmoattachments.org/attachment.cgi?id=9051647 (1 time) (Note! This may be a new URL 👀)
• https://support.mozilla.org/en-US/kb/manage-extension-shortcuts-firefox (2 times) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Mozilla/Firefox/Releases/137
Title: Firefox 137 for developers

• https://bugzil.la/1538451 (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2025-02-23 18:05:05)

[Rob--W]

Rephrased documentation to make it more generic, and added browser-specific guidance.

[dotproto]

Just did a quick search and it appears that Safari does not allow users to change keyboard shortcuts for web extensions. (Corroborated in the commands compatibility note for Safari). Should we call this out here?

[rebloor]

Actually, there's probably a broader issue here in that we don't call out in the API overview that only Firefox supports updating and resetting the shortcut keys programmatically. At the same time it's probably also worth pointing out that Safari doesn't provide for changing them at all. I'll update the PR.

[Rob--W]

Approved provided that the feedback below is addressed.

[Rob--W]

The sentences about Chrome and Safari are not about API behavior, but browser UI. I'm not sure if that text belongs here. If we drop that, then the only remaining sentence is about Firefox's API support for updating shortcuts.

If you'd like to emphasize the update behavior and browser UI, I suggest adding a brief note that connects the relevant APIs, along with the existing note at https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/commands#updating_shortcuts

Here is an example, rephrase as needed:

Suggested change

	In Firefox, this API provides features to update the shortcut key settings. In Chrome, the user can update shortcut key settings through the extension options UI. Safari doesn't support user modification of extension shortcut keys.
	Shortcuts can be [updated](/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/commands#updating_shortcuts) through {{WebExtAPIRef("commands.update")}}, or by the user via browser UI (see {{WebExtAPIRef("commands.openShortcutSettings")}}).

[Rob--W]

Let's also reference the new method from the existing commands documentation on updating shortcuts at https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/commands#updating_shortcuts

E.g. by appending a note,

To open this browser UI, use {{WebExtAPIRef("commands.openShortcutSettings")}}.

You can also put Safari-specific notes here, as a follow-up to #38234 (comment)

[dotproto]

No additional comments beyond what @Rob--W identified.

[github-actions]

This pull request has merge conflicts that must be resolved before it can be merged.