[Summary view] [Print] [Text view]

   1  // $Id: README.txt,v 1.5.2.6 2010/09/09 03:04:34 sun Exp $
   2  
   3  -- SUMMARY --
   4  
   5  jQuery UI (http://ui.jquery.com/) is a set of cool widgets and effects that
   6  developers can use to add some pizazz to their modules.
   7  
   8  This module is more-or-less a utility module that should simply be required by
   9  other modules that depend on jQuery UI being available. It doesn't do anything
  10  on its own.
  11  
  12  For a full description of the module, visit the project page:
  13    http://drupal.org/project/jquery_ui
  14  
  15  To submit bug reports and feature suggestions, or to track changes:
  16    http://drupal.org/project/issues/jquery_ui
  17  
  18  
  19  -- REQUIREMENTS --
  20  
  21  * The jQuery UI library.
  22  
  23  
  24  -- INSTALLATION --
  25  
  26  * Copy the jquery_ui module directory to your sites/all/modules directory, so it
  27    is located in sites/all/modules/jquery_ui/.
  28  
  29  * Download the jQuery UI 1.6 release from:
  30  
  31      http://code.google.com/p/jquery-ui/downloads/list?q=1.6
  32  
  33  * Put the downloaded archive into the module directory:
  34  
  35      /sites/all/modules/jquery_ui/jquery.ui-1.6.zip
  36  
  37  * Extract the archive.  This will create the following sub-directory:
  38  
  39      /sites/all/modules/jquery_ui/jquery.ui-1.6/
  40  
  41  * Rename the sub-directory into "jquery.ui" within the jquery_ui module folder:
  42  
  43      /sites/all/modules/jquery_ui/jquery.ui/
  44  
  45    so the actual jQuery UI JavaScript files are located in:
  46  
  47      /sites/all/modules/jquery_ui/jquery.ui/ui/*.js
  48  
  49  * Enable the module at Administer >> Site building >> Modules.
  50  
  51  
  52  -- JQUERY UI 1.7 --
  53  
  54  The jQuery UI module uses jQuery UI 1.6 because jQuery UI 1.7 requires at least
  55  jQuery 1.3, which is not shipped with Drupal 6. If you absolutely need to move
  56  to jQuery UI 1.7, you can get around this by doing the following:
  57  
  58  * Download and install the corresponding jQuery Update module from:
  59  
  60      http://drupal.org/project/jquery_update
  61  
  62  * Download the latest jQuery UI 1.7 release from:
  63  
  64      http://code.google.com/p/jquery-ui/downloads/list?q=1.7
  65  
  66  * Put the downloaded archive into the module directory:
  67  
  68      /sites/all/modules/jquery_ui/jquery.ui-1.7.zip
  69  
  70  * Extract the archive.  This will create the following sub-directory:
  71  
  72      /sites/all/modules/jquery_ui/jquery.ui-1.7/
  73  
  74  * Rename the sub-directory into "jquery.ui" within the jquery_ui module folder:
  75  
  76      /sites/all/modules/jquery_ui/jquery.ui/
  77  
  78    so the actual jQuery UI JavaScript files are located in:
  79  
  80      /sites/all/modules/jquery_ui/jquery.ui/ui/*.js
  81  
  82  * Enable the module at Administer >> Site building >> Modules.
  83  
  84  
  85  -- API --
  86  
  87  Developers who wish to use jQuery UI effects in their modules need only make
  88  the following changes:
  89  
  90  * In your module's .info file, add the following line:
  91  
  92      dependencies[] = jquery_ui
  93  
  94    This will force users to have the jQuery UI module installed before they can
  95    enable your module.
  96  
  97  * In your module, call the following function:
  98  
  99      jquery_ui_add($files);
 100  
 101    For example:
 102  
 103      jquery_ui_add(array('ui.draggable', 'ui.droppable', 'ui.sortable'));
 104  
 105      jquery_ui_add('ui.sortable');  // For a single file
 106  
 107    See the contents of the jquery.ui-X.X sub-directory for a list of available
 108    files that may be included, and see http://ui.jquery.com/docs for details on
 109    how to use them. The required ui.core file is automatically included, as is
 110    effects.core if you include any effects files.
 111  
 112  -- CONTACT --
 113  
 114  Current maintainers:
 115  * Jeff Robbins (jjeff)
 116  * Angela Byron (webchick)
 117  * Addison Berry (add1sun)
 118  * Daniel F. Kudwien (sun) - http://drupal.org/user/54136
 119