GM config: Difference between revisions

From GreaseSpot Wiki
Jump to navigationJump to search
Created page with '{{DISPLAYTITLE:GM_config}} '''Note:''' This tool, despite its name, is ''not'' an official Greasemonkey API. == Description == The purpose of GM_config is to create a very…'
 
Recommend the OUJS url since it is whitelisted by GreasyFork and the script page will automatically link to the library page on OUJS.
 
(10 intermediate revisions by 5 users not shown)
Line 5: Line 5:
== Description ==
== Description ==


The purpose of GM_config is to create a very lightweight graphical settings dialog that can be easily used in user scripts through @require.
The purpose of GM_config is to create a lightweight graphical settings dialog that can be easily used in user scripts, through <tt>@require</tt>.
A scriptwrighter using GM_config will pass an JSON object that contains the information about the values to be stored. <ref>http://code.google.com/p/gmconfig/</ref>


== Usage ==
== Usage ==


To use this tool in your script, simply include in the [[Metdata block]]:
To use this tool in your script, simply include in the [[Metadata Block]], for example:


<pre class='sample'>// @require http://gmconfig.googlecode.com/svn/trunk/gm_config.js</pre>
<pre class='sample'>
// @require https://openuserjs.org/src/libs/sizzle/GM_config.js
// @grant  GM_getValue
// @grant  GM_setValue
</pre>


For detailed usage and reference, please see the "usage guide" linked below.
For detailed usage and reference, please see the "wiki" linked below.


== See also ==
== See also ==


* [http://userscripts.org/groups/68 GM_config Dev] group at userscripts.org
* [https://github.com/sizzlemctwizzle/GM_config/wiki GM_config Wiki]
* [http://userscripts.org/guides/11 Usage guide]
* [https://github.com/sizzlemctwizzle/GM_config/ Source, at github.com]
* [http://sizzlemctwizzle.github.io/GM_config/ Live Demo]


== Footnotes ==
[[Category:@require Library]]
 
<references/>

Latest revision as of 22:27, 13 March 2015


Note: This tool, despite its name, is not an official Greasemonkey API.

Description

The purpose of GM_config is to create a lightweight graphical settings dialog that can be easily used in user scripts, through @require.

Usage

To use this tool in your script, simply include in the Metadata Block, for example:

// @require https://openuserjs.org/src/libs/sizzle/GM_config.js
// @grant   GM_getValue
// @grant   GM_setValue

For detailed usage and reference, please see the "wiki" linked below.

See also