From a2738daff7c95006f4e8477b6e936e7eb2924019 Mon Sep 17 00:00:00 2001 From: Iain Barnett Date: Wed, 3 Oct 2012 16:36:48 +0100 Subject: [PATCH 1/9] Added README for autocomplete --- autocomplete/README.md | 48 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 autocomplete/README.md diff --git a/autocomplete/README.md b/autocomplete/README.md new file mode 100644 index 0000000..8355d6d --- /dev/null +++ b/autocomplete/README.md @@ -0,0 +1,48 @@ +## jQuery UI Autocomplete Extensions ## + +These are extensions to the [jQuery UI Autocomplete](http://docs.jquery.com/UI/Autocomplete) widget. + +### Accent Folding ### + +See [accentFolding.html](accentFolding.html) + +Enable accent folding in your search terms. This makes it possible to search for values that contain accents without requiring the user to type the accented characters. For example, a user could search for "Jörn" by simply typing "Jorn". + + +#### API #### + +This extension does not expose any API. Accent folding is automatically enabled for all autocomplete fields. + + +### Auto Select ### + +See [autoSelect.html](autoSelect.html) + +Automatically select an item if the user types a valid value and leaves the text field without explicitly selecting the item from the menu. + + +#### API #### + +This extension does not expose any API. Values are automatically selected for all autocomplete fields if there is a perfect match in the results. + + +### HTML labels ### + +See [html.html](html.html) + +Allow HTML to be displayed for each item's label. + +#### API #### + +This extension adds a boolean `html` option. When set to true, the label will be interpreted as HTML. When set to false, the label will be interpreted as text + + +### Select First Item ### + +See [selectFirst.html](selectFirst.html) + +Automatically place focus on the first item in the menu. This reduces the number of keystrokes necessary to choose an item. + +#### API #### + +This extension adds a boolean `selectFirst` option. When set to true, the first item in the menu will automatically be focused when the menu is shown. From 1d5a6f5b0e86d44f8eb40e78133916efc5c2335a Mon Sep 17 00:00:00 2001 From: Iain Barnett Date: Wed, 3 Oct 2012 16:37:51 +0100 Subject: [PATCH 2/9] Added main project README --- README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a11d57b --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +## jQuery UI Extensions ## + +See the README's in each folder for documentation. From 8166185c9fc71feb5e631ad0ac0d71d0d02ccda1 Mon Sep 17 00:00:00 2001 From: Iain Barnett Date: Wed, 3 Oct 2012 16:41:07 +0100 Subject: [PATCH 3/9] Github markdown marks links relative from the root of the project, updated the links to reflect this. --- autocomplete/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/autocomplete/README.md b/autocomplete/README.md index 8355d6d..04d961d 100644 --- a/autocomplete/README.md +++ b/autocomplete/README.md @@ -4,7 +4,7 @@ These are extensions to the [jQuery UI Autocomplete](http://docs.jquery.com/UI/A ### Accent Folding ### -See [accentFolding.html](accentFolding.html) +See [accentFolding.html](autocomplete/accentFolding.html) Enable accent folding in your search terms. This makes it possible to search for values that contain accents without requiring the user to type the accented characters. For example, a user could search for "Jörn" by simply typing "Jorn". @@ -16,7 +16,7 @@ This extension does not expose any API. Accent folding is automatically enabled ### Auto Select ### -See [autoSelect.html](autoSelect.html) +See [autoSelect.html](autocomplete/autoSelect.html) Automatically select an item if the user types a valid value and leaves the text field without explicitly selecting the item from the menu. @@ -28,7 +28,7 @@ This extension does not expose any API. Values are automatically selected for al ### HTML labels ### -See [html.html](html.html) +See [html.html](autocomplete/html.html) Allow HTML to be displayed for each item's label. @@ -39,7 +39,7 @@ This extension adds a boolean `html` option. When set to true, the label will be ### Select First Item ### -See [selectFirst.html](selectFirst.html) +See [selectFirst.html](autocomplete/selectFirst.html) Automatically place focus on the first item in the menu. This reduces the number of keystrokes necessary to choose an item. From b84c0bcdb44ad59a31f8a7f06e1e3ac311d0d90c Mon Sep 17 00:00:00 2001 From: Iain Barnett Date: Wed, 3 Oct 2012 16:43:57 +0100 Subject: [PATCH 4/9] Added README for dialog. --- dialog/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 dialog/README.md diff --git a/dialog/README.md b/dialog/README.md new file mode 100644 index 0000000..c4963db --- /dev/null +++ b/dialog/README.md @@ -0,0 +1,13 @@ +## jQuery UI Dialog Extensions ## + +These are extensions to the [jQuery UI Dialog](http://docs.jquery.com/UI/Dialog) widget. + +##Auto Reposition + +See [autoReposition.html](dialog/autoReposition.html) + +Automatically reposition dialogs when the window is resized. + +### API ### + +This extension does not expose any API. All open dialogs are automatically repositioned when the window is resized. \ No newline at end of file From 29c4abb491bb13a3348e5d08d54294d049c9fc4e Mon Sep 17 00:00:00 2001 From: Iain Barnett Date: Wed, 3 Oct 2012 16:45:30 +0100 Subject: [PATCH 5/9] Added links to main README for convenience. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index a11d57b..98c1178 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ ## jQuery UI Extensions ## See the README's in each folder for documentation. + +* [Autocomplete](autocomplete/README.md) +* [Dialog](dialog/README.md) \ No newline at end of file From 6c9b0d5640eb89d93eb91a0f49fc6524279f6556 Mon Sep 17 00:00:00 2001 From: Iain Barnett Date: Wed, 3 Oct 2012 16:47:41 +0100 Subject: [PATCH 6/9] Trying to get the relative links right for Github's markdown. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 98c1178..ed70e12 100644 --- a/README.md +++ b/README.md @@ -2,5 +2,5 @@ See the README's in each folder for documentation. -* [Autocomplete](autocomplete/README.md) -* [Dialog](dialog/README.md) \ No newline at end of file +* [Autocomplete](jquery-ui-extensions/autocomplete/README.md) +* [Dialog](jquery-ui-extensions/dialog/README.md) \ No newline at end of file From e4115e709ae0eed847906165d1097a525c820eab Mon Sep 17 00:00:00 2001 From: Iain Barnett Date: Wed, 3 Oct 2012 16:48:58 +0100 Subject: [PATCH 7/9] Relative links won't work from the base readme so removed. --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index ed70e12..fca18b8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,3 @@ ## jQuery UI Extensions ## -See the README's in each folder for documentation. - -* [Autocomplete](jquery-ui-extensions/autocomplete/README.md) -* [Dialog](jquery-ui-extensions/dialog/README.md) \ No newline at end of file +See the README's in each folder for documentation. \ No newline at end of file From d5406e14735636662200b259f9c80bc27f0edde5 Mon Sep 17 00:00:00 2001 From: Iain Barnett Date: Wed, 3 Oct 2012 16:49:37 +0100 Subject: [PATCH 8/9] Grammar error, fixed. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fca18b8..63efaa3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,3 @@ ## jQuery UI Extensions ## -See the README's in each folder for documentation. \ No newline at end of file +See the README in each folder for documentation. \ No newline at end of file From 64cccddbdbb75b7f993ec93fa31f25b933b8e0eb Mon Sep 17 00:00:00 2001 From: Iain Barnett Date: Wed, 3 Oct 2012 16:58:13 +0100 Subject: [PATCH 9/9] Updated README with some of responses given by scottgonzalez. --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 63efaa3..a445cdc 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ ## jQuery UI Extensions ## -See the README in each folder for documentation. \ No newline at end of file +See the README in each folder for documentation. + +### Installation ### + +Select the extension you want to use, take the script and put it in your app's javascript dir and refer to it *after* the jQuery standard libs. + +### Will these clobber existing jQuery UI stuff? ### + +No, they work alongside. + +### Which versions of jQuery will this work with? ### + +Presumably 1.8+, but to be honest, I don't do any testing beyond the day that I write the individual extensions. At some point I will have time to actually write tests and documentation and add more extensions. + + +### Contributing ### + +Feel free to send PRs to add descriptions to the demos. \ No newline at end of file