GM.registerMenuCommand

Greasemonkey Manual
Using Greasemonkey
Installing Scripts
Monkey Menu
Getting Help
User Script Authoring
Editing
Environment
API

Description

This API method allows user scripts to add a menu command to the "User Script Commands" submenu.

Examples | Notes

Syntax

GM_registerMenuCommand( commandName, commandFunc, accelKey, accelModifiers, accessKey )

Value: Function

Returns: undefined

Compatibility: Greasemonkey 0.2.5+

Parameters

Properties	Event Handlers
commandName	commandFunc
accelKey
accelModifiers
accessKey

• All properties and event handlers are optional except commandName and commandFunc.

top

Properties

---

commandName

Value: String

Usage: commandName = "Some Name";

• Name to display in the "User Script Commands" submenu.

top | back

commandFunc

Value: Function

Usage: commandFunc = function(){ /* some code */ };

• Function to call

top | back

accelKey

Value: String

Usage: accelKey = "g";

• A single character or keycode that can trigger the command.

top | back

accelModifiers

Value: String

Usage: accelModifiers = "control alt";

• A string listing modifiers that must be pressed with the accelKey. If there's more than one, then they should be separated with spaces. Available modifiers are: shift, alt, meta, control, and accel.

top | back

accessKey

Value: String

Usage: accessKey = "g";

• A single character that can be used to jump to the command when the menu is open. It should be a letter in commandName.

top | back

Examples

GM_registerMenuCommand( "Hello, world!", hello, "e", "control", "h" );

GM_registerMenuCommand( "Hello, world! (again)", hello2, "e", "shift alt", "w" );

GM_registerMenuCommand( "Hello, world (simple)", helloSimple );

top

Notes

top