jQuery Plugin
Current maintainer:
Finn Herpich
Author :
Sergey Nebolsin
Contributers :
Craig Jones,
Finn HerpichThis plugin provides integration with jQuery-Javascript-library. When installing the plugin, it downloads and installs automatically the latest jQuery 1.4 distribution in your application and registers itself to be used with the adaptive AJAX tags.
Before upgrading to 1.4.* from a prior version please check http://jquery14.com/day-01/jquery-14 for changes which may break your code.
The code has moved to http://gitorious.org/grails-jquery
Index
- Find help
- Usage
- Upgrading
- Releases
Find help
Question?
Ask on the Grails user mailinglist. If you have no luck and you'll get no response please mail the current maintainer.
Found a bug?
Please file a bugreport at
http://jira.codehaus.org/browse/GRAILSPLUGINS/component/13544 JIRA for the grails-jquery component.
Usage
Ajax via jQuery
To have the Grails' adaptive AJAX support adapt itself to jQuery (rather than the default of Prototype, or another choice like YUI or Dojo):
Since Grails 1.2:
Add this line to your layout-file
<g:javascript library="jquery"/>
and the following to your grails-app/conf/config.groovy
grails.views.javascript.library="jquery"
Add the following line in the head section of every GSP that needs it. (Note: It is NOT sufficient to add it only to main.gsp in layouts.)
<g:javascript library="jquery"/>
Thereafter the <g:remoteField>, <g:remoteLink>, <g:formRemote> etc. tags will utilize jQuery for the ajax calls. (See the Grails documentation, or "The Definitive Guide to Grails" chapter 9, etc.)
Ajax via jQuery in Partial GSP
Sometimes, the GSP being rendered is itself an Ajax respose. That is, rather than being a whole HTML page in response to a regular HTTP request, it's partial HTML that will dynamically replace the body of a DIV. In this case, there is no head section, so the g:javascript tag is not the right way to trigger the jquery binding.
Instead, use the g:setProvider tag at the top of the response (or anywhere above the first ajax-adpative tag).
<g:setProvider library="jquery"/>
Delayed Javascript execution
One of the advantages of jQuery is that you can specify that your javascript is not to run until the page has loaded completely. To do that with this plugin, use the supplied jq:jquery tag (instead of g:javascript):
<jq:jquery> your delayed-action javascript here </jq:jquery>
Everything inside this tag will be wrapped into
<script type="text/javascript">jQuery(function(){ your delayed-action javascript here });</script>Manually Installing jQuery plugins ("sub-plugins")
Manually installing a plugin is quite easy.
First, save the plugin code to your web-app/js/jquery folder. It's not required, but for consistency, you might make sure it has a dot-notation prefix of "jquery.". For example, to use Josh Bush's progress bar plugin
(http://digitalbush.com/projects/progress-bar-plugin/), open
http://digitalbush.com/wp-content/uploads/2007/02/jqueryprogressbar.js
and save it as
<working-folder>/web-app/js/jquery/jquery.progressbar.js
Next, edit your application.properties file and add a corresponding jquery.plugins line:
jquery.plugins.progressbar=jquery.progressbar.js
You can now take advantage of the jq:plugin tag to load the plugin code as needed, as described above.
<jq:plugin name="progressbar"/>
(Of course, how to actually use the plugin depends on the plugin.)
Upgrading
If you want to upgrade:
- Delete the plugin from the projects /plugin folder
- (Optional) Delete the previous jQuery version folder from /web-app/js/jQuery
- Install the plugin by executing grails install-plugin jquery
Plugin version history
2010-01-26 1.4.1.1
2010-01-18 1.4.0.1
2009-06-11 1.3.2.4
- Added config-file JQueryConfig.groovy
- Moved sources and version to jquery.sources and jquery.version
2009-06-09 1.3.2.3
2009-06-08 1.3.2.2
2009-02-22 1.0RC2b
2009-02-22 1.0RC2
- Update to jQuery 1.3.1
- Code clean up
2008-10-28 1.0RC1
First release candidate
javascript
Fisheye
Docs
Edit Plugin
Close