GM.registerMenuCommand: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
m (Misc formatting and commenting) |
m (Arantius moved page GM registerMenuCommand to GM.registerMenuCommand: New GM-4 name with dot, not underscore.) |
||
(31 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
== Description == | == Description == | ||
This | This method allows user scripts to add an item to the [[Greasemonkey_Manual:Monkey_Menu#The_Menu|User Script Commands]] menu. | ||
[[# | Compatibility: [[Version_history#4.11|Greasemonkey 4.11+]] | ||
== Syntax == | == Syntax == | ||
{{Function|GM.registerMenuCommand|caption, commandFunc, accessKey}} | |||
==== | === Arguments === | ||
: | ; <code>caption</code> | ||
: <code>String</code> The caption to display on the menu item. | |||
; <code>commandFunc</code> | |||
: <code>Function</code> The function to call when this menu item is selected by the user. | |||
; <code>accessKey</code> | |||
: <code>String</code> A single character that can be used to select command when the menu is open. It should be a letter in the <code>caption</code>. [https://developer.mozilla.org/en/XUL/Attribute/accesskey] | |||
==== History ==== | |||
This method existed in a similar but different form before Greasemonkey 4.0. | |||
== Returns == | |||
<code>undefined</code> | |||
== Examples == | == Examples == | ||
<pre class='sample'>GM_registerMenuCommand("Hello, world (simple)", () => alert("Hello, world!"));</pre> | |||
<pre class='sample'>function hello() { ... } | |||
GM_registerMenuCommand("Hello, world!", hello, "h");</pre> | |||
[[ | [[Category:API_Reference|R]] | ||
== | == See Also == | ||
[[ | The [[GM_config]] <code>@require</code> library is frequently used with <code>GM.registerMenuCommand</code>. | ||
Revision as of 01:10, 28 January 2021
Description
This method allows user scripts to add an item to the User Script Commands menu.
Compatibility: Greasemonkey 4.11+
Syntax
function GM.registerMenuCommand( caption, commandFunc, accessKey )
Arguments
caption
String
The caption to display on the menu item.commandFunc
Function
The function to call when this menu item is selected by the user.accessKey
String
A single character that can be used to select command when the menu is open. It should be a letter in thecaption
. [1]
History
This method existed in a similar but different form before Greasemonkey 4.0.
Returns
undefined
Examples
GM_registerMenuCommand("Hello, world (simple)", () => alert("Hello, world!"));
function hello() { ... } GM_registerMenuCommand("Hello, world!", hello, "h");
See Also
The GM_config @require
library is frequently used with GM.registerMenuCommand
.