Index: chrome/common/extensions/docs/server2/templates/intros/experimental_commands.html |
diff --git a/chrome/common/extensions/docs/server2/templates/intros/experimental_keybinding.html b/chrome/common/extensions/docs/server2/templates/intros/experimental_commands.html |
similarity index 85% |
rename from chrome/common/extensions/docs/server2/templates/intros/experimental_keybinding.html |
rename to chrome/common/extensions/docs/server2/templates/intros/experimental_commands.html |
index 5d6141a871b6a9ae4f6f38fef88aacd02465ab06..13d695c56a1be68c07673d7cd5a3d395003f434e 100644 |
--- a/chrome/common/extensions/docs/server2/templates/intros/experimental_keybinding.html |
+++ b/chrome/common/extensions/docs/server2/templates/intros/experimental_commands.html |
@@ -1,30 +1,33 @@ |
-<!-- BEGIN AUTHORED CONTENT --> |
<p> |
-The keybinding API allows you to add keyboard shortcuts that trigger actions in |
+The commands API allows you to add keyboard shortcuts that trigger actions in |
your extension. An action can be opening the browser action or page action popup |
or sending a command to the extension. |
</p> |
+ |
<h2 id="manifest">Manifest</h2> |
<p> |
-In addition to the "experimental" permission you must declare the "keybinding" |
+In addition to the "experimental" permission you must declare the "commands" |
permission in your extension's manifest to use this API and set manifest_version |
to (at least) 2. |
</p> |
+ |
<pre>{ |
"name": "My extension", |
... |
<b> "permissions": [ |
"experimental", |
- "keybinding", |
+ "commands", |
]</b>, |
... |
}</pre> |
+ |
<h2 id="usage">Usage</h2> |
-<p>The keybinding API allows you to define specific commands, and bind them to a |
+<p>The commands API allows you to define specific commands, and bind them to a |
default key combination. Each command your extension accepts must be listed in |
the manifest as an attribute of the 'commands' manifest key. Note: Combinations |
that involve Ctrl+Alt are not permitted in order to avoid conflicts with the |
AltGr key.</p> |
+ |
<pre>{ |
"name": "My extension", |
... |
@@ -54,18 +57,20 @@ AltGr key.</p> |
}</b>, |
... |
}</pre> |
+ |
<p>In your background page, you can bind a handler to each of the commands |
defined in the manifest (except for '_execute_browser_action' and |
'_execute_page_action') via onCommand.addListener. For example:</p> |
+ |
<pre> |
-chrome.experimental.keybinding.onCommand.addListener(function(command) { |
+chrome.experimental.commands.onCommand.addListener(function(command) { |
console.log('Command:', command); |
}); |
</pre> |
+ |
<p>The '_execute_browser_action' and '_execute_page_action' commands are |
reserved for the action of opening your extension's popups. They won't normally |
generate events that you can handle. If you need to take action based on your |
popup opening, consider listening for an 'onDomReady' event inside your popup's |
code. |
</p> |
-<!-- END AUTHORED CONTENT --> |