modules/jquery_ui/README.txt

// $Id: README.txt,v 1.7 2009/06/19 20:53:26 robloach 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.


INSTALLATION
------------

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

2. Copy the jquery_ui module directory to your sites/all/modules directory.

3. Download the latest jQuery 1.7 development package from:

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

4. Extract it as a sub-directory called 'jquery-ui' in the jquery_ui folder:

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

5. 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:

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

2. In your module, call the following function:

     drupal_add_js_library('ui.accordion');

   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');
1	// $Id: README.txt,v 1.7 2009/06/19 20:53:26 robloach Exp $
2
3	CONTENTS OF THIS FILE
4	---------------------
5
6	* Introduction
7	* Installation
8	* API
9
10
11	INTRODUCTION
12	------------
13
14	Authors:
15	* Rob Loach (Rob Loach)
16
17	jQuery UI (http://ui.jquery.com/) is a set of cool widgets and effects that
18	developers can use to add some pizazz to their modules.
19
20	This module is more-or-less a utility module that should simply be required by
21	other modules that depend on jQuery UI being available. It doesn't do anything
22	on its own.
23
24
25	INSTALLATION
26	------------
27
28	1. Apply the patch from http://drupal.org/node/315100 .
29
30	2. Copy the jquery_ui module directory to your sites/all/modules directory.
31
32	3. Download the latest jQuery 1.7 development package from:
33
34	http://code.google.com/p/jquery-ui/downloads/list?can=3&q=1.7
35
36	4. Extract it as a sub-directory called 'jquery-ui' in the jquery_ui folder:
37
38	/sites/all/modules/jquery_ui/jquery-ui/
39
40	5. Enable the module at Administer >> Site building >> Modules.
41
42
43	API
44	---
45
46	Developers who wish to use jQuery UI effects in their modules need only make
47	the following changes:
48
49	1. In your module's .info file, add the following line:
50
51	dependencies[] = jquery_ui
52
53	This will force users to have the jQuery UI module installed before they can
54	enable your module.
55
56	2. In your module, call the following function:
57
58	drupal_add_js_library('ui.accordion');
59
60	See the contents of the jquery.ui-X.X sub-directory for a list of available
61	files that may be included, and see http://ui.jquery.com/docs for details on
62	how to use them. The required ui.core file is automatically included, as is
63	effects.core if you include any effects files.
64
65	If you know the jQuery selector you are adding the widget to, you can have it
66	processed by the behaviors by calling:
67
68	drupal_add_js_library('ui.accordion', '#accordion');