You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+49-46Lines changed: 49 additions & 46 deletions
Original file line number
Diff line number
Diff line change
@@ -11,52 +11,55 @@ The standard jquery.autocomplete.js file is around 2.7KB when minified via Closu
11
11
12
12
*`$(selector).autocomplete(options);`
13
13
* Sets up autocomplete for input field(s).
14
-
*`options`: An object literal which defines the settings to use for the autocomplete plugin.
15
-
*__Ajax settings__
16
-
*`serviceUrl`: Server side URL or callback function that returns serviceUrl string. Optional if local lookup data is provided.
17
-
*`type`: Ajax request type to get suggestions. Default: `GET`.
18
-
*`dataType`: type of data returned from server. Either 'text' (default) or 'jsonp', which will cause the autocomplete to use jsonp. You may return a json object in your callback when using jsonp.
19
-
*`paramName`: Default `query`. The name of the request parameter that contains the query.
20
-
*`params`: Additional parameters to pass with the request, optional.
21
-
*`deferRequestBy`: Number of miliseconds to defer ajax request. Default: `0`.
22
-
*`ajaxSettings`: Any additional [Ajax Settings](http://api.jquery.com/jquery.ajax/#jQuery-ajax-settings) that configure the jQuery Ajax request.
23
-
*__Searching process__
24
-
*`noCache`: Boolean value indicating whether to cache suggestion results. Default `false`.
25
-
*`delimiter`: String or RegExp, that splits input value and takes last part to as query for suggestions.
26
-
Useful when for example you need to fill list of coma separated values.
27
-
*`onSearchStart`: `function (query) {}` called before ajax request. `this` is bound to input element.
28
-
*`onSearchComplete`: `function (query, suggestions) {}` called after ajax response is processed. `this` is bound to input element. `suggestions` is an array containing the results.
29
-
*`onSearchError`: `function (query, jqXHR, textStatus, errorThrown) {}` called if ajax request fails. `this` is bound to input element.
30
-
*`transformResult`: `function(response, originalQuery) {}` called after the result of the query is ready. Converts the result into response.suggestions format.
31
-
*`onSelect`: `function (suggestion) {}` Callback function invoked when user selects suggestion
32
-
from the list. `this` inside callback refers to input HtmlElement.
33
-
*`minChars`: Minimum number of characters required to trigger autosuggest. Default: `1`.
34
-
*`lookupLimit`: Number of maximum results to display for local lookup. Default: no limit.
35
-
*`lookup`: Callback function or lookup array for the suggestions. It may be array of strings or `suggestion` object literals.
36
-
*`suggestion`: An object literal with the following format: `{ value: 'string', data: any }`.
37
-
*`lookupFilter`: `function (suggestion, query, queryLowerCase) {}` filter function for local lookups. By default it does partial string match (case insensitive).
38
-
*`triggerSelectOnValidInput`: Boolean value indicating if `select` should be triggered if it matches suggestion. Default `true`.
39
-
*`preventBadQueries`: Boolean value indicating if it shoud prevent future ajax requests for queries with the same root if no results were returned. E.g. if `Jam` returns no suggestions, it will not fire for any future query that starts with `Jam`. Default `true`.
40
-
*`autoSelectFirst`: if set to `true`, first item will be selected when showing suggestions. Default value `false`.
41
-
*`onHide`: `function (container) {}` called before container will be hidden
42
-
*__Displaying__
43
-
*`beforeRender`: `function (container) {}` called before displaying the suggestions. You may manipulate suggestions DOM before it is displayed.
44
-
*`formatResult`: `function (suggestion, currentValue) {}` custom function to
45
-
format suggestion entry inside suggestions container, optional.
46
-
*`groupBy`: property name of the suggestion `data` object, by which results should be grouped.
47
-
*`maxHeight`: Maximum height of the suggestions container in pixels. Default: `300`.
48
-
*`width`: Suggestions container width in pixels, e.g.: 300. Default: `auto`, takes input field width.
49
-
*`zIndex`: 'z-index' for suggestions container. Default: `9999`.
50
-
*`appendTo`: container where suggestions will be appended. Default value `document.body`. Can be jQuery object, selector or html element. Make sure to set `position: absolute` or `position: relative` for that element.
51
-
*`forceFixPosition`: Default: `false`. Suggestions are automatically positioned when their container is appended to body (look at `appendTo` option), in other cases suggestions are rendered but no positioning is applied.
52
-
Set this option to force auto positioning in other cases.
53
-
*`orientation`: Default `bottom`. Vertical orientation of the displayed suggestions, available values are `auto`, `top`, `bottom`.
54
-
If set to `auto`, the suggestions will be orientated it the way that place them closer to middle of the view port.
55
-
*`preserveInput`: if `true`, input value stays the same when navigating over suggestions. Default: `false`.
56
-
*`showNoSuggestionNotice`: Default `false`. When no matching results, display a notification label.
57
-
*`noSuggestionNotice`: Default `No results`. Text or htmlString or Element or jQuery object for no matching results label.
58
-
*`onInvalidateSelection`: `function () {}` called when input is altered after selection has been made. `this` is bound to input element.
59
-
*`tabDisabled`: Default `false`. Set to true to leave the cursor in the input field after the user tabs to select a suggestion.
14
+
*`options`: An object literal which defines the settings to use for the autocomplete plugin. Available option settings listed below.
15
+
16
+
###Ajax Settings
17
+
*`serviceUrl`: Server side URL or callback function that returns serviceUrl string. Optional if local lookup data is provided.
18
+
*`type`: Ajax request type to get suggestions. Default: `GET`.
19
+
*`dataType`: type of data returned from server. Either 'text' (default) or 'jsonp', which will cause the autocomplete to use jsonp. You may return a json object in your callback when using jsonp.
20
+
*`paramName`: Default `query`. The name of the request parameter that contains the query.
21
+
*`params`: Additional parameters to pass with the request, optional.
22
+
*`deferRequestBy`: Number of miliseconds to defer ajax request. Default: `0`.
23
+
*`ajaxSettings`: Any additional [Ajax Settings](http://api.jquery.com/jquery.ajax/#jQuery-ajax-settings) that configure the jQuery Ajax request.
24
+
25
+
###Configuration Settings
26
+
*`noCache`: Boolean value indicating whether to cache suggestion results. Default `false`.
27
+
*`delimiter`: String or RegExp, that splits input value and takes last part to as query for suggestions.
28
+
Useful when for example you need to fill list of coma separated values.
29
+
*`onSearchStart`: `function (query) {}` called before ajax request. `this` is bound to input element.
30
+
*`onSearchComplete`: `function (query, suggestions) {}` called after ajax response is processed. `this` is bound to input element. `suggestions` is an array containing the results.
31
+
*`onSearchError`: `function (query, jqXHR, textStatus, errorThrown) {}` called if ajax request fails. `this` is bound to input element.
32
+
*`transformResult`: `function(response, originalQuery) {}` called after the result of the query is ready. Converts the result into response.suggestions format.
33
+
*`onSelect`: `function (suggestion) {}` Callback function invoked when user selects suggestion
34
+
from the list. `this` inside callback refers to input HtmlElement.
35
+
*`minChars`: Minimum number of characters required to trigger autosuggest. Default: `1`.
36
+
*`lookupLimit`: Number of maximum results to display for local lookup. Default: no limit.
37
+
*`lookup`: Callback function or lookup array for the suggestions. It may be array of strings or `suggestion` object literals.
38
+
*`suggestion`: An object literal with the following format: `{ value: 'string', data: any }`.
39
+
*`lookupFilter`: `function (suggestion, query, queryLowerCase) {}` filter function for local lookups. By default it does partial string match (case insensitive).
40
+
*`triggerSelectOnValidInput`: Boolean value indicating if `select` should be triggered if it matches suggestion. Default `true`.
41
+
*`preventBadQueries`: Boolean value indicating if it shoud prevent future ajax requests for queries with the same root if no results were returned. E.g. if `Jam` returns no suggestions, it will not fire for any future query that starts with `Jam`. Default `true`.
42
+
*`autoSelectFirst`: if set to `true`, first item will be selected when showing suggestions. Default value `false`.
43
+
*`onHide`: `function (container) {}` called before container will be hidden
44
+
45
+
###Presentation Settings
46
+
*`beforeRender`: `function (container) {}` called before displaying the suggestions. You may manipulate suggestions DOM before it is displayed.
47
+
*`formatResult`: `function (suggestion, currentValue) {}` custom function to
48
+
format suggestion entry inside suggestions container, optional.
49
+
*`groupBy`: property name of the suggestion `data` object, by which results should be grouped.
50
+
*`maxHeight`: Maximum height of the suggestions container in pixels. Default: `300`.
51
+
*`width`: Suggestions container width in pixels, e.g.: 300. Default: `auto`, takes input field width.
52
+
*`zIndex`: 'z-index' for suggestions container. Default: `9999`.
53
+
*`appendTo`: container where suggestions will be appended. Default value `document.body`. Can be jQuery object, selector or html element. Make sure to set `position: absolute` or `position: relative` for that element.
54
+
*`forceFixPosition`: Default: `false`. Suggestions are automatically positioned when their container is appended to body (look at `appendTo` option), in other cases suggestions are rendered but no positioning is applied.
55
+
Set this option to force auto positioning in other cases.
56
+
*`orientation`: Default `bottom`. Vertical orientation of the displayed suggestions, available values are `auto`, `top`, `bottom`.
57
+
If set to `auto`, the suggestions will be orientated it the way that place them closer to middle of the view port.
58
+
*`preserveInput`: if `true`, input value stays the same when navigating over suggestions. Default: `false`.
59
+
*`showNoSuggestionNotice`: Default `false`. When no matching results, display a notification label.
60
+
*`noSuggestionNotice`: Default `No results`. Text or htmlString or Element or jQuery object for no matching results label.
61
+
*`onInvalidateSelection`: `function () {}` called when input is altered after selection has been made. `this` is bound to input element.
62
+
*`tabDisabled`: Default `false`. Set to true to leave the cursor in the input field after the user tabs to select a suggestion.
0 commit comments