You are here

Home » API reference » jQuery UI 7

README.txt in jQuery UI 7

Same filename and directory in other branches
  1. 8 README.txt
  2. 5 README.txt
  3. 6 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 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);

  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 latest jQuery UI 1.7 release from:

  29. 

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

  31. 

  32. * Put the downloaded archive into the module directory:

  33. 

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

  35. 

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

  37. 

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

  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. 

  51. -- API --

  52. 

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

  54. the following changes:

  55. 

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

  57. 

  58.     dependencies[] = jquery_ui

  59. 

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

  61.   enable your module.

  62. 

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

  64. 

  65.     jquery_ui_add($files);

  66. 

  67.   For example:

  68. 

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

  70. 

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

  72. 

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

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

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

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

  77. 

  78. -- CONTACT --

  79. 

  80. Current maintainers:

  81. * Jeff Robbins (jjeff)

  82. * Angela Byron (webchick)

  83. * Addison Berry (add1sun)

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

  85.