Greasemonkey Manual:API

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

This section of the manual will be short and sweet. As mentioned elsewhere, Greasemonkey provides several methods in its API to enhance the power of user scripts. They are listed here, with a brief description, but each separate method has its own page with more in-depth information, please continue reading there!

Headers

Metadata Block

Through JavaScript comments, Greasemonkey has metadata, which gives information about the script and provides resources and functionality to scripts.

comment6,

comment3,

Common Task Helpers

GM_addStyle

A function, taking one parameter, a string of CSS to apply to the page.

GM_xmlhttpRequest

A version of the XMLHttpRequest method underlying AJAX, this API call does not use the same-origin policy that a script running in a normal page is limited with, allowing complex mashups.

unsafeWindow

This object provides access to the raw JavaScript window scope of the content page. It is most commonly used to access JavaScript variables on the page.

Other

GM_log

A function that accepts a parameter which will be routed to the Error Console, useful for examining values when writing a script.

GM_openInTab

Similar in spirit to window.open(), this function accepts a single parameter, the URL of a page to open in a new tab.

GM_registerMenuCommand

An advanced function which allows a user script to register a menu item, and command to run when clicked, in the Firefox user interface.