| 类型 |
对象
|
|---|---|
| Mandatory | No |
| 范例 |
|
使用
命令
key to define one or more keyboard shortcuts for your extension.
Each keyboard shortcut is defined with a
名称
，
combination of keys
，和
description
. Once you've defined commands in your extension's
manifest.json
, you can listen for their associated key combinations with the
命令
JavaScript API.
命令
key is an object, and each shortcut is a property of it.
The property's name is the name of the shortcut.
Each shortcut's value is an object, with up to 2 properties:
suggested_key
: the combination of keys that activate the shortcut.
description
: a string that describes the shortcut; i.e. what it does.
suggested_key
property is an object with any of the following properties (all strings):
"default"
"mac"
"linux"
"windows"
"chromeos"
"android"
"ios"
The value of each property is the keyboard shortcut for the command on that platform, as a string containing keys separated by "
+
". The value for
"default"
is used on all platforms that are not explicitly listed.
例如：
"commands": {
"toggle-feature": {
"suggested_key": {
"default": "Alt+Shift+U",
"linux": "Ctrl+Shift+U"
},
"description": "Send a 'toggle-feature' event to the extension"
},
"do-another-thing": {
"suggested_key": {
"default": "Ctrl+Shift+Y"
}
}
}
This JSON defines 2 shortcuts:
"toggle-feature"
, accessed with
Ctrl
+
Shift
+
U
on Linux, and
Alt
+
Shift
+
U
on all other platforms.
"do-another-thing"
, accessed with
Ctrl
+
Shift
+
Y
在所有平台。
You could then listen for the
"toggle-feature"
command with code like this:
browser.commands.onCommand.addListener(function (command) {
if (command === "toggle-feature") {
console.log("Toggling the feature!");
}
});
There are 3
special shortcuts with default actions
, for which the
commands.onCommand
event is not fired:
_execute_browser_action
: works like a click on the extension's
browser action
.
_execute_page_action
: works like a click on the extension's
page action
.
_execute_sidebar_action
: opens the extension's
sidebar
. Only supported in Firefox 54 and newer.
For example, this JSON defines a key combination that clicks the extension's browser action:
"commands": {
"_execute_browser_action": {
"suggested_key": {
"default": "Ctrl+Shift+Y"
}
}
}
There are two valid formats for shortcut keys: as a key combination 或作为 media key .
注意：
On Macs,
"Ctrl"
被解释成
"Command"
, so if you actually need
"Ctrl"
, specify
"MacCtrl"
.
Key combinations must consist of 2 or 3 keys:
"Ctrl"
,
"Alt"
,
"Command"
，或
"MacCtrl"
.
"Shift"
or (for Firefox ≥ 63) any one of
"Ctrl"
,
"Alt"
,
"Command"
，或
"MacCtrl"
. Must not be the modifier already used as the main modifier.
A
–
Z
0
–
9
F1
–
F12
Comma
,
Period
,
首页
,
End
,
PageUp
,
PageDown
,
Space
,
插入
,
删除
,
向上
,
Down
,
Left
,
Right
The key is then given as a string containing the set of key values, in the order listed above, separated by "
+
". For example,
"Ctrl+Shift+Z"
.
If a key combination is already used by the browser (like
"Ctrl+P"
) or by an existing add-on, then you can't override it. You can define it, but your event handler will not be called when the user presses the key combination.
Alternatively, the shortcut may be specified as one of the following media keys:
"MediaNextTrack"
"MediaPlayPause"
"MediaPrevTrack"
"MediaStop"
Shortcuts can be updated via
commands.update()
. Users can also update shortcuts via the "Manage Extension Shortcuts" option at
about:addons
in Firefox, as shown in
this video
. In Chrome, users can change shortcuts at
chrome://extensions/shortcuts
.
Define a single keyboard shortcut, using only the default key combination:
"commands": {
"toggle-feature": {
"suggested_key": {
"default": "Ctrl+Shift+Y"
},
"description": "Send a 'toggle-feature' event"
}
}
Define two keyboard shortcuts, one with a platform-specific key combination:
"commands": {
"toggle-feature": {
"suggested_key": {
"default": "Alt+Shift+U",
"linux": "Ctrl+Shift+U"
},
"description": "Send a 'toggle-feature' event"
},
"do-another-thing": {
"suggested_key": {
"default": "Ctrl+Shift+Y"
}
}
}
BCD tables only load in the browser
最后修改： , 由 MDN 贡献者