Skip to content Skip to sidebar Skip to footer

How To Convert A Bookmarklet Into A Greasemonkey Userscript?

Is there a easy way to do this. And is there anything that needs to be changed due to differences in how it is ran?

Solution 1:

The easiest way to do this:

  1. Run the bookmarklet code through a URL decoder. so that javascript:alert%20('Hi%20Boss!')%3B, for example, becomes: javascript:alert ('Hi Boss!');

  2. Strip the leading javascript: off.   Result: alert ('Hi Boss!');

  3. Add this code to the end of your Greasemonkey file. For example, create a file named, Hello World.user.js, with this code:

    // ==UserScript==
    // @name            Hello World!
    // @description     My first GM script from a bookmarklet
    // @include         https://stackoverflow.com/questions/*
    // @grant           none
    // ==/UserScript==
    
    alert ('Hi Boss!');
    
  4. Open Hello World.user.js with Firefox (CtrlO ).   Greasemonkey will prompt to install the script.

  5. Now the bookmarklet code will run automatically on whatever pages you specified with the @include and @exclude directives.

  6. Update: To ensure maximum compatibility, use the @grant none directive that was added in later versions of Greasemonkey and Tampermonkey.


IMPORTANT:

Solution 2:

Here is a very good article to avoid common pitfalls because of differences between "normal" JS and Greasemonkey.

The most important things at the beginning:

  • Do not use functions as strings, like: window.setTimeout("my_func()", 1000); but rather window.setTimeout(my_func, 1000); or window.setTimeout(function(){doSomething(); doSomethingOther();}, 1000);

  • Do not set element.onclick but rather element.addEventListener("click", my_func, true);

  • Some code that normally returns various DOM objects, in Greasemonkey environment returns those objects wrapped in XPCNativeWrapper. This is for security reasons.

    Some methods and properties are "transparent" and you can invoke them on wrapped object, but some not. Read in the mentioned article about how to circumvent this; you can also use (this is not recommended generally, but for testing etc.) wrappedJSObject property. It is, when obj.something/obj.something() doesn't work in Greasemonkey, try obj.wrappedJSObject.something/obj.wrappedJSObject.something().

Post a Comment for "How To Convert A Bookmarklet Into A Greasemonkey Userscript?"