// $Id: README.txt,v 1.10 2010-09-09 03:04:24 sun Exp $

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Installation
 * API


INTRODUCTION
------------

Authors:
* Rob Loach (Rob Loach)

jQuery UI (http://ui.jquery.com/) is a set of cool widgets and effects that
developers can use to add some pizazz to their modules.

This module is more-or-less a utility module that should simply be required by
other modules that depend on jQuery UI being available. It doesn't do anything
on its own.

For a full description of the module, visit the project page:
  http://drupal.org/project/jquery_ui

To submit bug reports and feature suggestions, or to track changes:
  http://drupal.org/project/issues/jquery_ui


-- INSTALLATION --


* Apply the patch from http://drupal.org/node/315100

* Copy the jquery_ui module directory to your sites/all/modules directory, so it
  is located in sites/all/modules/jquery_ui/.

* Download the latest jQuery UI 1.7 release from:

    http://code.google.com/p/jquery-ui/downloads/list?q=1.7

* Put the downloaded archive into the module directory:

    /sites/all/modules/jquery_ui/jquery.ui-1.7.zip

* Extract the archive.  This will create the following sub-directory:

    /sites/all/modules/jquery_ui/jquery.ui-1.7/

* Rename the sub-directory into "jquery.ui" within the jquery_ui module folder:

    /sites/all/modules/jquery_ui/jquery.ui/

  so the actual jQuery UI JavaScript files are located in:

    /sites/all/modules/jquery_ui/jquery.ui/ui/*.js

* Enable the module at Administer >> Site building >> Modules.


-- API --

Developers who wish to use jQuery UI effects in their modules need only make
the following changes:

* In your module's .info file, add the following line:

    dependencies[] = jquery_ui

  This will force users to have the jQuery UI module installed before they can
  enable your module.

* In your module, call the following function:

    jquery_ui_add($files);

  See the contents of the jquery.ui-X.X sub-directory for a list of available
  files that may be included, and see http://ui.jquery.com/docs for details on
  how to use them. The required ui.core file is automatically included, as is
  effects.core if you include any effects files.

  If you know the jQuery selector you are adding the widget to, you can have it
  processed by the behaviors by calling:

    drupal_add_js_library('ui.accordion', '#accordion');