You are here

Home » API reference » jQuery UI 5

README.txt in jQuery UI 5

Same filename and directory in other branches
  1. 8 README.txt
  2. 6 README.txt
  3. 7 README.txt
-- SUMMARY --

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


-- REQUIREMENTS --

* The jQuery UI library.


-- INSTALLATION --

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

* Download the jQuery UI 1.6 release from:

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

* Put the downloaded archive into the module directory:

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

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

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

* 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.

* If desired, configure the module at Administer >> Site configuration >>
  jQuery UI. Here you may select which level of compression the jQuery library
  should use. It defaults to 'minified' compression, which strips comments and
  white space.


-- 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);

  For example:

    jquery_ui_add(array('ui.draggable', 'ui.droppable', 'ui.sortable'));

    jquery_ui_add('ui.sortable');  // For a single file

  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.

-- CONTACT --

Current maintainers:
* Jeff Robbins (jjeff)
* Angela Byron (webchick)
* Addison Berry (add1sun)
* Daniel F. Kudwien (sun) - http://drupal.org/user/54136

File

README.txt
View source 
  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 module directory:

  33. 

  34.     /sites/all/modules/jquery_ui/jquery.ui-1.6.zip

  35. 

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

  37. 

  38.     /sites/all/modules/jquery_ui/jquery.ui-1.6/

  39. 

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

  41. 

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

  43. 

  44.   so the actual jQuery UI JavaScript files are located in:

  45. 

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

  47. 

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

  49. 

  50. * If desired, configure the module at Administer >> Site configuration >>

  51.   jQuery UI. Here you may select which level of compression the jQuery library

  52.   should use. It defaults to 'minified' compression, which strips comments and

  53.   white space.

  54. 

  55. 

  56. -- API --

  57. 

  58. Developers who wish to use jQuery UI effects in their modules need only make

  59. the following changes:

  60. 

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

  62. 

  63.     dependencies[] = jquery_ui

  64. 

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

  66.   enable your module.

  67. 

  68. * In your module, call the following function:

  69. 

  70.     jquery_ui_add($files);

  71. 

  72.   For example:

  73. 

  74.     jquery_ui_add(array('ui.draggable', 'ui.droppable', 'ui.sortable'));

  75. 

  76.     jquery_ui_add('ui.sortable');  // For a single file

  77. 

  78.   See the contents of the jquery.ui-X.X sub-directory for a list of available

  79.   files that may be included, and see http://ui.jquery.com/docs for details on

  80.   how to use them. The required ui.core file is automatically included, as is

  81.   effects.core if you include any effects files.

  82. 

  83. -- CONTACT --

  84. 

  85. Current maintainers:

  86. * Jeff Robbins (jjeff)

  87. * Angela Byron (webchick)

  88. * Addison Berry (add1sun)

  89. * Daniel F. Kudwien (sun) - http://drupal.org/user/54136

  90.