[Summary view] [Print] [Text view]

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