GM.registerMenuCommand: Difference between revisions

From GreaseSpot Wiki
Jump to navigationJump to search
m (Arantius moved page GM registerMenuCommand to GM.registerMenuCommand: New GM-4 name with dot, not underscore.)
(→‎See Also: Rephrase GM_config reference to make it even clearer that this is a 3rd party tool, not a native feature/function.)
 
(One intermediate revision by one other user not shown)
Line 28: Line 28:
== Examples ==
== Examples ==


<pre class='sample'>GM_registerMenuCommand("Hello, world (simple)", () => alert("Hello, world!"));</pre>
<pre class='sample'>GM.registerMenuCommand("Hello, world (simple)", () => alert("Hello, world!"));</pre>


<pre class='sample'>function hello() { ... }
<pre class='sample'>function hello() { ... }
GM_registerMenuCommand("Hello, world!", hello, "h");</pre>
GM.registerMenuCommand("Hello, world!", hello, "h");</pre>


[[Category:API_Reference|R]]
[[Category:API_Reference|R]]
Line 37: Line 37:
== See Also ==
== See Also ==


The [[GM_config]] <code>@require</code> library is frequently used with <code>GM.registerMenuCommand</code>.
The third-party <code>@require</code> library "[[GM_config]]" by ''sizzlemctwizzle'' is frequently used with <code>GM.registerMenuCommand</code>.

Latest revision as of 02:11, 13 December 2023

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 the caption. [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 third-party @require library "GM_config" by sizzlemctwizzle is frequently used with GM.registerMenuCommand.