GM.getResourceText: Difference between revisions

From GreaseSpot Wiki
Jump to navigationJump to search
m (Notated a concern about the resourceName variable... note I extrapolated this variable name from the developer group when I created this article... so I didn't do it ;D)
m (→‎Syntax: Monkey colored tables)
Line 16: Line 16:
:Compatibility: [[Version_history#0.8.0|Greasemonkey 0.8.0+]]
:Compatibility: [[Version_history#0.8.0|Greasemonkey 0.8.0+]]


:{| border="1" cellpadding="5"
:{| cellpadding="5" style="border-style:solid; background:#FFFFE0;"
|+ Parameters
|+ Parameters
!|'''Properties'''
!style="background:#CC9900;"|'''Properties'''
|-
|-
| <code>[[#resourceName |resourceName]]</code>
| <code><span style="background:#FFFFE0;">[[#resourceName |resourceName]]</span></code>
|}
|}
:* All properties are optional except [[#resourceName|resourceName]].
:* All properties are optional except [[#resourceName|resourceName]].

Revision as of 22:36, 11 December 2007

Template:Underscore


Description

This API method loads an external resource, such as an external JavaScript routine, and returns the string for use in the DOM.

Examples | Notes

Syntax

GM_getResourceText( resourceName )

Value: Function
Returns: String
Compatibility: Greasemonkey 0.8.0+
Parameters
Properties
resourceName

top

Properties


resourceName

Value: String
Usage: resourceName = "metadata-resource-name[1]";
  • This value is used to retrieve the metadata block @resource name URI which will be retrieved, unformatted, and returned upon completion of this API method.

top | back

Examples

// ==UserScript==
// @name           My Script
// @namespace      http://www.example.com/gmscripts/
// @description    Example GM_getResourceText
// @include        http://www.example.com/*
// @resource       prototype http://www.prototypejs.org/assets/2007/11/6/prototype.js
// ==/UserScript==

/* some code */

location.href = "javascript:void(" + GM_getResourceText("prototype") + ")"; 

top

Notes

[1] While the variable name described here has hyphens in it, it is assumed that it should be compatible with JavaScript variable naming conventions and XML/CSS naming conventions to help keep things consistent.

top