JQueryUI
[JavaScript]

Include JQueryUI components on all or some pages. More...

Classes
class	ConfigJQueryUI
	JQueryUI Config options. More...
class	JavascriptJQueryUIEventSink
	EventSink to catch JCSSManager events. More...
class	JQueryUI
	Helper for using JQueryUI, defines widgets and dependencies. More...

---

Detailed Description

Include JQueryUI components on all or some pages.

Usage

On install, the module copies JQuery UI Javascript and CSS files folders below web root.

To define the version of JQueryUI to use, use the constant APP_JQUERYUI_VERSION. Valid values are "1.7" for JQueryUI 1.7.2, and "1.8" for JQueryUI 1.8.11. Default is "1.8":

 define('APP_JQUERYUI_VERSION', '1.8');

Attention:

The default version policy changed to "newest", so if you do not define a JQuery UI version, you will automaticalyy get the latest release

Note that javascript and css files get prefixed by "jquery." since version 1.8. For example "ui.accordion" became "jquery.ui.accordion". When updating from 1.7 to a higher version, make sure to delete the old files.

To enable components, you may call JQueryUI::enable_components() and pass either an array or a single component:

 JQueryUI::enable_components(JQueryUI::WIDGET_DATEPICKER);
 JQueryUI::enable_components(array(JQueryUI::WIDGET_DATEPICKER, JQueryUI::WIDGET_PROGRESSBAR));

This module resolves any dependencies for the components selected, so no need to worry about that.

To enable localization for a given language use

 JQueryUI::enable_locales('de');

This module will automatically include localization files, if available. Note it's still up to you to correctly initialize the accordings components, e.g. within the document.ready() event.

To include components on each page and to have them compressed by JCSSManager, its best to include according code in the file start.inc.php in your app directory.

You must use WidgetJCSS of JCSSManager module to render head data for this module to work.

Theming

Themes can be downloaded on http://jqueryui.com/download. Just drop the css files (or just ui.theme.css) and image folder in app/www/css/jqueryui/

Additional notes

The 1.7 release includes the autocomplete plugin by Jörn Zaefferer, which became a part of JQueryUI in 1.8 release. For details see http://bassistance.de/jquery-plugins/jquery-plugin-autocomplete/

The JS and CSS file have been renamed to ui.autocomplete for consistency.

The autocomplete plugin for 1.7 is not themed, since it is not part of the original JQuery UI package.

JQueryUI and the autocomplete plugin are released under MIT license.

See also:

http://jqueryui.com/ for details about JQueryUI