This plugin provides integration with the Yahoo! UI Library. When installing the plugin, it downloads and installs automatically the latest YUI 2.5.2 distribution in your application, and registers itself to be used with the adapative AJAX tags. It also contains two helper tags to easily include additional YUI javascript and css files as well.
Installation
To install the YUI plugin type this command from your project's root folder:
grails install-plugin yui
The complete YUI distribution is downloaded and installed under your project's web-appjsyui2.5.2 folder.
Usage
To use Grails' adaptive AJAX support just add the folowing line in the head section:
<g:javascript library="yui" />
If you want to include additional YUI javascript and css files include them using:
<yui:javascript dir="calendar" file="calendar-min.js" />
<yui:javascript dir="calendar" file="calendar-min.js" version="2.5.2" />
// version to be used in case multiple version installed
<yui:stylesheet dir="calendar/assets" file="calendar.css" />
Refer to the Ajax section of the Grails reference documentation for usage.
Overriding default javascript files
By default only yahoo-dom-event.js and connection-min.js are included when using <g:javascript library="yui" />. Adding additional libraries to the default list can be done in a BootStrap (+) class:
import org.codehaus.groovy.grails.plugins.web.taglib.JavascriptTagLib
class BootStrap {
def init = { servletContext ->
JavascriptTagLib.LIBRARY_MAPPINGS.yui += ["yui/2.5.2/calendar/calendar-min",
"yui/2.5.2/container/container-min"]
}
def destroy = {
}
}
It's also possible to replace all default included javascript libraries. For example if you want to use the YUI debug javascript files in development mode:
import grails.util.GrailsUtil
import org.codehaus.groovy.grails.plugins.web.taglib.JavascriptTagLib
class BootStrap {
def init = { servletContext ->
if (GrailsUtil.isDevelopmentEnv()) {
JavascriptTagLib.LIBRARY_MAPPINGS.yui = ["yui/2.5.2/yahoo/yahoo-debug",
"yui/2.5.2/dom/dom-debug",
"yui/2.5.2/event/event-debug",
"yui/2.5.2/connection/connection-debug"]
}
}
def destroy = {
}
}
Serving YUI Files from Yahoo! Servers
It's also possible to serve the javascript from the Yahoo! servers. First delete the yui folder from web-appjs after installing the plugin. Then, in a BootStrap class, override the mapping which contains the javascript files to include by default:
import org.codehaus.groovy.grails.plugins.web.taglib.JavascriptTagLib
class BootStrap {
def init = { servletContext ->
JavascriptTagLib.LIBRARY_MAPPINGS.yui = []
}
def destroy = {
}
}
The only drawback is that you need to include the references to the javascript files manually. Probably the easiest way is to do this in the main.gsp layout.
Upgrading
If you want to upgrade:
- Delete the plugin from the project's plugins folder
- (Optional) Delete the previous YUI version folder from web-appjsyui
- Re-install the plugin by executing grails install-plugin yui
posted on 2008-07-29 22:38
周銳 閱讀(526)
評論(0) 編輯 收藏 所屬分類:
Groovy&Grails