Difference: JQueryPlugin (r4 vs. r3)

JQuery Plugin

jQuery JavaScript library for TWiki

Description

This plugin contains the latest version of the jQuery JavaScript library.

"jQuery is a fast, concise, JavaScript Library that simplifies how you traverse HTML documents, handle events, perform animations, and add Ajax interactions to your web pages."

See the JQueryPluginExamples page for a demo of a couple of widgets used by TWiki.

Included libraries

  1. jquery - base jQuery library, loaded when JQueryPlugin is enabled
  2. jquery-ui - jQuery UI library, load with %JQSCRIPT{"jquery-ui.js"}% or a %JQTHEME{"..."}% - content:
    • UI Core:
      • Core - the core of jQuery UI, required for all interactions and widgets
      • Widget - the widget factory, base for all widgets
      • Mouse - the mouse widget, a base class for all interactions and widgets with heavy mouse interaction
      • Position - a utility plugin for positioning elements relative to other elements
    • Interactions - adding basic behaviors to any element and are used by many components below
      • Draggable - makes any element on the page draggable
      • Droppable - generated drop targets for draggable elements
      • Resizable - makes any element on the page resizable
      • Selectable - makes a list of elements mouse selectable by dragging a box or clicking on them
      • Sortable - makes a list of items sortable
    • Widgets - full-featured UI Controls - each has a range of options and is fully themeable:
      • Accordion - creates an accordion navigation widget
      • Autocomplete - creates an autocomplete widget
      • Button - creates an button widget
      • Dialog - opens existing markup in a draggable and resizable dialog
      • Slider - a flexible slider with ranges and accessibility via keyboard
      • Tabs - transforms a set of container elements into a tab structure
      • Datepicker - a datepicker than can be toggled from a input or displayed inline
      • Progressbar - a status indicator that can be used for a loading state and standard percentage indicators
    • Effects - a rich effect API and ready to use effects:
      • Effects Core - extends the internal jQuery effects, includes morphing, easing and is required by all other effects
      • Effect "Blind" - blinds the element
      • Effect "Bounce" - bounces an element horizontally or vertically n-times
      • Effect "Clip" - clips the element on and off like an old TV
      • Effect "Drop" - a Drop out effect by moving the element in one direction and hiding it at the same time
      • Effect "Explode" - the element explodes in all directions into n pieces. Also supports imploding again
      • Effect "Fade" - fades the element
      • Effect "Fold" - folds the element first horizontally and then vertically
      • Effect "Highlight" - highlights the background of the element in a defined color for a custom duration
      • Effect "Pulsate" - the element pulsates n times by changing the opacity to zero and back
      • Effect "Scale" - grow or shrink any element and it's content and restore it again
      • Effect "Shake" - shakes the element horizontally or vertically n times
      • Effect "Slide" - the element slides in and out of the viewport
      • Effect "Transfer" - transfer effect from one element to another
  3. jquery.bgiframe.js - fix z-index issue in IE 6, loaded when JQueryPlugin is enabled
  4. jquery.blockUI.js - simulate synchronous behavior when using AJAX, without locking the browser, loaded when JQueryPlugin is enabled
  5. jquery.cookie.js - cookie managers, load with %JQSCRIPT{"jquery.cookie.js"}%
  6. jquery.debug.js - debug, load with %JQSCRIPT{"jquery.debug.js"}%
  7. jquery.dom.js - loaded when JQueryPlugin is enabled
  8. jquery.easing.js - set custom easing types for standard animations, loaded when JQueryPlugin is enabled
  9. jquery.hoverIntent.js - delay onMouseOver, loaded when JQueryPlugin is enabled
  10. jquery.innerfade.js - loaded when JQueryPlugin is enabled
  11. jquery.metadata.js - extract metadata from classes, random attributes, child elements and HTML5 data-* attributes, load with %JQSCRIPT{"jquery.metadata.js"}%
  12. jquery.nifty.js - rounded corners, loaded when JQueryPlugin is enabled
  13. jquery.shrinkurls.js - shrink URLs, loaded when JQueryPlugin is enabled
  14. jquery.spinner.js - spinners, load with %JQSCRIPT{"jquery.spinner.js"}%
  15. jquery.superfish.css
  16. jquery.superfish.js - pulldown menues, load with %JQSCRIPT{"jquery.superfish.js"}%
  17. jquery.tabpane.js - tapped panes, loaded when JQueryPlugin is enabled
  18. jquery.tooltip.js - tool tips, loaded when JQueryPlugin is enabled
  19. jquery.treeview.async.js - expandable trees, loaded when JQueryPlugin is enabled
  20. jquery.treeview.edit.js - expandable trees, load with %JQSCRIPT{"jquery.treeview.edit.js"}%
  21. jquery.treeview.sortable.js - expandable trees, load with %JQSCRIPT{"jquery.treeview.sortable.js"}%
  22. jquery.treeview.js - expandable trees, loaded when JQueryPlugin is enabled
  23. jquery.twiki.js - TWiki specific code, loaded when JQueryPlugin is enabled

JQuery Library Documentation

Syntax Rules

  • %JQSCRIPT{"jquery.js"}% - include the specified script. Keep in mind that the jquery.js script must be loaded before plug-ins scripts.
  • %JQTHEME{"mythemename"}% - include the specified theme. Better load the desired theme before any script.
  • %JQIMAGESURLPATH{"myimage.png"}% - expand to the specified image path.
  • %JQIMAGESURLPATH%/myimage.png - Same result as the above. Available images:
    • spinner_arrows.gif
    • spinner_big.png
    • spinner.gif
    • spinner.png

Themes

See jQuery Theme Roller for look & feel of available themes. The JQueryPlugin ships with the following themes that can be activated using %JQTHEME{...}%:

  • black-tie
  • cupertino
  • redmond
  • smoothness - recommended for TWiki
  • ui-lightness

Examples

Known Issues

  • jquery.tooltip does not work in JQueryPlugin release 1.2 (2011-03-01)
  • jquery.treeview does not work in JQueryPlugin release 1.2 (2011-03-01)

Note to Plugin Maintainer

  • See pub/TWiki/JQueryPlugin/readme.txt

Installation Instructions

  • Download the ZIP file from the Plugin web (see below)
  • Unzip JQueryPlugin.zip in your twiki installation directory. Content:
    File:Description:
    data/Sandbox/JQueryPluginExamples.txt Example topic
    data/Sandbox/PluginTestJQueryPlugin.txt Test topic
    data/TWiki/JQueryPlugin.txt Plugin documentation topic
    data/TWiki/VarJQ*.txt Variable documentation topics
    lib/CPAN/lib/CSS/Minifier.pm Perl module
    lib/CPAN/lib/JavaScript/Minifier.pm Perl module
    lib/TWiki/Plugins/JQueryPlugin.pm Perl module
    lib/TWiki/Plugins/JQueryPlugin/Core.pm Perl module
    pub/TWiki/JQueryPlugin/Makefile Makefile
    pub/TWiki/JQueryPlugin/jquery-all.css Main stylesheet file
    pub/TWiki/JQueryPlugin/jquery-all.js Main Javascript file
    pub/TWiki/JQueryPlugin/jquery-all.js.gz Main Javascript file, compressed
    pub/TWiki/JQueryPlugin/*.css Stylesheet files
    pub/TWiki/JQueryPlugin/*.js Javascript files
    pub/TWiki/JQueryPlugin/*.gif and .png Image files
    pub/TWiki/JQueryPlugin/i18n/*.js Style sheets for internationalization
    pub/TWiki/JQueryPlugin/images/*.gif and *.png Image library
    pub/TWiki/JQueryPlugin/themes/* Themes
    tools/minifycss Utility
    tools/minifyjs Utility
  • Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
  • Test Sandbox.JQueryPluginExamples for functionality.

Plugin Info

Plugin Author: TWiki:Main.MichaelDaum, TWiki:Main.PeterThoeny
Copyright: © 2007-2008 Michael Daum http://michaeldaumconsulting.com
© 2008-2011 TWiki:TWiki.TWikiContributor
License: GPL (GNU General Public License)
Plugin Version: 1.3 (2011-04-01) 1.4 (2011-07-08)
Change History:  
2011-03-01: 2011-07-08: TWikibug:Item6675 TWikibug:Item6725 : Possible Plugins: Change global package variables from "use vars" to specify "our" JQTHEME more than once per page, but only first one takes effect -- TWiki:Main.PeterThoeny
2011-03-01: TWikibug:Item6653 TWikibug:Item6675 : Update Possible plugin to jquery-1.5.1 and jquery-ui-1.8.10 specify JQTHEME more than once per page, but only first one takes effect -- TWiki:Main.PeterThoeny
2010-06-08: 2011-03-01: TWikibug:Item6486 TWikibug:Item6653 - upgrade : Update plugin to latest jquery-1.4.2 release jquery-1.5.1 and jquery-ui-1.8.10 -- TWiki:Main/SopanShewale TWiki:Main.PeterThoeny ; add variable documentation topics VarJQTABPANE, VarJQTAB, VarJQENDTAB, VarJQENDTABPANE -- TWiki:Main/PeterThoeny
2010-04-25: 2010-06-08: TWikibug:Item6436 TWikibug:Item6486 - renamed upgrade too generic variable names BUTTON, TOGGLE, CLEAR, TABPANE, ENDTABPANE, TAB, ENDTAB to JQBUTTON, JQTOGGLE, JQCLEAR, JQTABPANE, latest jquery-1.4.2 release -- JQENDTABPANE, JQTAB, JQENDTAB, respectively. Old variables names available if configure setting is set: $TWiki::cfg{JQueryPlugin}{Legacy2008} = 1;TWiki:Main/SopanShewale; add variable documentation topics VarJQTABPANE, VarJQTAB, VarJQENDTAB, VarJQENDTABPANE -- TWiki:Main/PeterThoeny
2010-04-22: 2010-04-25: TWikibug:Item6433 TWikibug:Item6436 - doc improvements, no code changes renamed too generic variable names BUTTON, TOGGLE, CLEAR, TABPANE, ENDTABPANE, TAB, ENDTAB to JQBUTTON, JQTOGGLE, JQCLEAR, JQTABPANE, JQENDTABPANE, JQTAB, JQENDTAB, respectively. Old variables names available if configure setting is set: $TWiki::cfg{JQueryPlugin}{Legacy2008} = 1; -- TWiki:Main/PeterThoeny
15 2010-04-22: Jul 2008: updated to ui-1.5.2; added async treeview; added async options to tabpane TWikibug:Item6433 - doc improvements, no code changes
03 15 Jul 2008: updated to ui-1.5.1 ui-1.5.2; added async treeview; added async options to tabpane
05 Jun 03 Jul 2008: updated to jquery-1.2.6 ui-1.5.1 and ui-1.5-RC1
30 Apr 05 Jun 2008: repackaged updated to contain jquery UI jquery-1.2.6 and ui-1.5-RC1
13 Feb 30 Apr 2008: upgrade repackaged to jquery-1.2.3, as well contain jquery UI as most plugins
17 Jan 13 Feb 2008: added upgrade jquery.metadata plugin; implemented a jquery.tabpane plugin; updated jquery.dimensions plugin; added jquery.empty plugin to ease development of new jquery-1.2.3, as well as most plugins
15 Nov 2007: 17 Jan 2008: use skin independent way added jquery.metadata plugin; implemented a jquery.tabpane plugin; updated jquery.dimensions plugin; added jquery.empty plugin to add javascript files to header ease development of new plugins
10 Oct 15 Nov 2007: upgraded use skin independent way to jQuery-1.1.4; compressed js and css add javascript files to header
12 Jul 10 Oct 2007: initial package containing jQuery-1.1.3.1 upgraded to jQuery-1.1.4; compressed js and css
Dependencies: 12 Jul 2007: None initial package containing jQuery-1.1.3.1
Plugin Dependencies: Home: http://twiki.org/cgi-bin/view/Plugins/JQueryPlugin None
Feedback: Plugin Home: http://twiki.org/cgi-bin/view/Plugins/JQueryPluginDev http://twiki.org/cgi-bin/view/Plugins/JQueryPlugin
Appraisal: Feedback: http://twiki.org/cgi-bin/view/Plugins/JQueryPluginAppraisal http://twiki.org/cgi-bin/view/Plugins/JQueryPluginDev
Appraisal: http://twiki.org/cgi-bin/view/Plugins/JQueryPluginAppraisal

Related topics: VarJQTABPANE, VarJQTAB, VarJQENDTAB, VarJQENDTABPANE, PluginTestJQueryPlugin, JQueryPluginExamples, TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory

View topic | View difference side by side | History: r4 < r3 < r2 < r1 | More topic actions
 
This site is powered by the TWiki collaboration platformCopyright © 1999-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.JQueryPlugin.