GM.getResourceUrl: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
m →<code>resourceName</code>: Some redundancy dumped |
m →Examples: Neutralized the example |
||
| Line 38: | Line 38: | ||
<code><pre> | <code><pre> | ||
// ==UserScript== | // ==UserScript== | ||
// @name | // @name My Script | ||
// @namespace | // @namespace <nowiki>http://www.example.com/gmscripts/</nowiki> | ||
// @description | // @description Scripting is fun | ||
// @include | // @include <nowiki>http://www.example.com/*</nowiki> | ||
/ | // @resource fooLogo http://www.example.com/logo.png | ||
// @resource | |||
// ==/UserScript== | // ==/UserScript== | ||
/ | (function() | ||
{ | |||
// some code | |||
var | var fooLogo = GM_getResourceURL("fooLogo"); | ||
) | |||
// some code | |||
})(); | |||
</pre></code> | </pre></code> | ||
Revision as of 07:49, 12 December 2007
Description
This API method loads an external resource, such as an image, and returns the string containing the base64 encoded data: URL scheme for use in the DOM.
Syntax
GM_getResourceURL( resourceName )
- Value: Function
- Returns: String
- Compatibility: Greasemonkey 0.8.0+
Parameters Properties resourceName
- All properties are optional except resourceName.
Properties
resourceName
- Value: String
- Usage:
resourceName = "metadata-resource-name[1]";
- This value is used in retrieval of the same named resource specified in the corresponding metadata block @resource key. After it is retrieved, it will be base64 encoded into the data: URL scheme, and returned upon completion of this API method.
Examples
// ==UserScript==
// @name My Script
// @namespace http://www.example.com/gmscripts/
// @description Scripting is fun
// @include http://www.example.com/*
// @resource fooLogo http://www.example.com/logo.png
// ==/UserScript==
(function()
{
// some code
var fooLogo = GM_getResourceURL("fooLogo");
// some code
})();
Notes
[1] While the variable names here are non-semantic, it is assumed that it should be compatible with JavaScript variable naming conventions and XML/CSS naming conventions to help keep things consistent.
