JQueryLibPlugin

Description

Provides jQuery libraries to Foswiki. Also includes jQuery UI libraries, themes and some jQuery plugins.

Macros

%JQSCRIPT{"plugins/myplugin/myplugin.js"}% : include the specified script to the HTML head of your topic. Keep in mind that the jquery.js script must be loaded before plug-ins scripts. Scripts will be included in the order in which they appear in the topic. Topic included scripts will be loaded after every scripts listed in {Plugins}{JQueryLibPlugin}{Scripts}. Duplicates will be ignored.

%JQSTYLE{"plugins/myplugin/myplugin.css"}% : include the specified style to the HTML head of your topic. Styles will be included in the order in which they appear in the topic. Topic included styles will be loaded after every styles listed in {Plugins}{JQueryLibPlugin}{Styles}. Duplicates will be ignored.

Settings

Once installed and enabled you get extra JQueryLibPlugin settings in configure.

{Plugins}{JQueryLibPlugin}{Scripts} let you define the scripts to be added in the HTML head of every pages returned by your Foswiki installation.
{Plugins}{JQueryLibPlugin}{Styles} let you define the styles to be added in the HTML head of every pages returned by your Foswiki installation.

Scripts and styles will be added to the HTML head in the order provided in the settings.

jQuery UI 1.5

To use jQuery UI 1.5 go to configure and use the following settings:

{Plugins}{JQueryLibPlugin}{Scripts}=jquery-1.2.6.min.js, jquery-ui-1.5.3.min.js
{Plugins}{JQueryLibPlugin}{Styles}=themes/1.5/lightness/ui.all.css

See JQueryLibPluginDemo for some examples.

jQuery UI 1.7

To use jQuery UI 1.7 got to configure and use the following settings:

{Plugins}{JQueryLibPlugin}{Scripts}=jquery-1.3.2.min.js, jquery-ui-1.7.1.min.js
{Plugins}{JQueryLibPlugin}{Styles}=themes/1.7/smoothness/jquery-ui.css

See JQueryLibPluginFoswikiDemo for some examples.

Performance consideration

To reduce the size of your server pages we recommend you use the macros JQSCRIPT and JQSTYLE on topic per topic basis rather than adding too many unused styles and scripts to your configuration. However for a foswiki installation using a jQuery themed skin we recommend the following configuration:

{Plugins}{JQueryLibPlugin}{Scripts}=jquery-1.3.2.min.js, plugins/foswiki/foswiki.js
{Plugins}{JQueryLibPlugin}{Styles}=themes/1.7/smoothness/jquery-ui.css, plugins/foswiki/foswiki.css

Supported jQuery plugins

• Farbtastic color picker: comes with DataForms color type support and PatternSkinEasyColorSettings.
• foswiki: Includes foswiki jQuery ui CSS framework, foswiki jQuery widget behavior and utility functions.
• spinner: spinning wheel to make the user happy while waiting on some AJAX response.

Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

Info

Many thanks to the following sponsors for supporting this work: Slion.net