collective.js.jqueryui 1.8.16.5

Introduction

Integration of jQueryUI in Plone 4.

This version includes jQueryUI 1.8.16 without the tabs plugin.

It is different from collective.jqueryui in many ways:

• no skin dirs (js and css are in resource dirs)

• no all the bunch of files and documentations from original jQueryUI

• this one is minified

• just add all jQueryUI to portal_js, and default css to portal_css (if you apply the profile)

To have an example of the current integration you can check @@example.jqueryui page. You must activate example within portal_properties.

WARNINGS

For Plone 3 you need version 1.7.x of this package

JQueryUI > 1.8.6 is supposed to be compatible with jQuery 1.3.2. At the moment you should prefer to use the 1.7.X version of jQueryUI (same package exists for 1.7 branch)

include plugins and optimizations

By default this addon register all plugins and activate all of them except tabs. So ui.tabs is registred but not activated.

Because jQueryUI is big on both javascripts and css you may want to optimize the configuration of your site or your addon which depends on this one.

So you can activate/unactivate plugins using registry profile or the jQueryUI controlpanel.

Using registry.xml, you can activate only what you want:

<registry>
    <records interface="collective.js.jqueryui.controlpanel.IJQueryUIPlugins">
      <value key="ui_draggable">True</value>
      <value key="ui_droppable">True</value>
    </records>
</registry>

In the case of a policy you can do a full configuration:

<registry>
    <records interface="collective.js.jqueryui.controlpanel.IJQueryUIPlugins">
      <value key="ui_core">True</value>
      <value key="ui_widget">True</value>
      <value key="ui_mouse">True</value>
      <value key="ui_position">True</value>
      <value key="ui_draggable">True</value>
      <value key="ui_droppable">True</value>
      <value key="ui_resizable">True</value>
      <value key="ui_selectable">True</value>
      <value key="ui_sortable">True</value>
      <value key="ui_accordion">False</value>
      <value key="ui_autocomplete">False</value>
      <value key="ui_button">False</value>
      <value key="ui_dialog">False</value>
      <value key="ui_slider">False</value>
      <value key="ui_tabs">False</value>
      <value key="ui_datepicker">False</value>
      <value key="ui_progressbar">False</value>
      <value key="effects_core">False</value>
      <value key="effects_blind">False</value>
      <value key="effects_bounce">False</value>
      <value key="effects_clip">False</value>
      <value key="effects_drop">False</value>
      <value key="effects_explode">False</value>
      <value key="effects_fade">False</value>
      <value key="effects_fold">False</value>
      <value key="effects_highlight">False</value>
      <value key="effects_pulsate">False</value>
      <value key="effects_scale">False</value>
      <value key="effects_shake">False</value>
      <value key="effects_slide">False</value>
      <value key="effects_transfer">False</value>
    </records>
    <records interface="collective.js.jqueryui.controlpanel.IJQueryUICSS">
      <value key="css">False</value>
      <value key="patch">False</value>
    </records>
</registry>

Using the control panel, you can select plugins you want. If you unselect a plugin it will be unactivated (but not its dependencies)

Using python, you just have to use plone.registry api:

from zope.component import getUtility
from plone.registry.interfaces import IRegistry
from collective.js.jqueryui.config import DEPS
from collective.js.jqueryui.interfaces import IJQueryUICSS, IJQueryUIPlugins
#is plone.app.registry
registry = getUtility(IRegistry)
proxy = registry.forInterface(IJQueryUIPlugins)
setattr(proxy, 'ui_draggable', True)
setattr(proxy, 'ui_droppable', True)

Credits and contributions

• Planet Makina Corpus Contact us

• Ecreall

Contributors

• Vincent Fretin [vincentfretin]

• Hanno Schlichting [hanno]

• Nathan Vangheem [vangheem]

• Marcos F. Romero [marcosfromero]

• Kees Hink [khink]

• Robert Niederreiter [rnix]

• JeanMichel FRANCOIS [toutpt]

How to upgrade this package

• Go to http://jqueryui.com/download

• Unselect the tabs plugins which conflict with jquerytools

• Download jquery-ui-1.8.X.custom.zip

• Go to the URL specified in the collective/js/jqueryui/css/sunburst/jquery-ui-1.8.12.custom.css file to pre-load current theme settings.

• Click on “Download theme” in the left-side “Theme rollover”.

• Click on “Advanced Theme Settings” to expand options and type “sunburst” in “Theme Folder Name” field.

• Create theme directory

• Download jquery-ui-1.8.X.custom.zip

Commands to execute:

PKG="/home/toutpt/workspace/collective.js.jqueryui/collective/js/jqueryui"
VERSION="1.8.13"
PREV="1.8.12"
cd /tmp/
unzip ~/jquery-ui-$VERSION.custom.zip
rm $PKG/jquery-ui-$PREV.custom.min.js
rm $PKG/jquery-ui-$PREV.custom.js
cp js/jquery-ui-$VERSION.custom.min.js $PKG/jquery-ui-$VERSION.custom.js
cp js/jquery-ui-$VERSION.custom.min.js $PKG/jquery-ui-$VERSION.custom.min.js
cp development-bundle/ui/i18n/jquery-ui-i18n.js $PKG/jquery-ui-i18n.js

cd themes
unzip ~/jquery-ui-$VERSION.custom.zip
rm $PKG/css/sunburst/images/*
rm $PKG/css/sunburst/jqueryui.css
cp css/sunburst/jquery-ui-$VERSION.custom.css $PKG/css/sunburst/jqueryui.css
cp css/sunburst/images/* $PKG/css/sunburst/images/

• update version in README.txt and configure.zcml and config.py

• increment the profile version in metadata.xml

• add ugprade step:

  <genericsetup:upgradeStep
      source="1895"
      destination="1896"
      title="Upgrade jqueryui to 1.8.16"
      description=""
      profile="collective.js.jqueryui:default"
      handler=".upgrades.cook_resources"
  />

Changelog