diff --git a/README.md b/README.md new file mode 100644 index 0000000..a445cdc --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +## jQuery UI Extensions ## + +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 diff --git a/autocomplete/README.md b/autocomplete/README.md new file mode 100644 index 0000000..04d961d --- /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](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". + + +#### API #### + +This extension does not expose any API. Accent folding is automatically enabled for all autocomplete fields. + + +### Auto Select ### + +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. + + +#### 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](autocomplete/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](autocomplete/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. 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