(转) JQuery 插件 Autocomplete——输入自动提示 参数文档

原文地址：http://docs.jquery.com/Plugins/Autocomplete/autocomplete

 

 

autocomplete ( url or data, [ options] )

Options:

autoFill cacheLength delay extraParams formatItem formatMatch formatResult highlight matchCase matchContains matchSubset max minChars multiple multipleSeparator mustMatch scroll scrollHeight selectFirst width

Boolean	Default: false
Fill the textinput while still selecting a value, replacing the value if more is typed or something else is selected.
Number	Default: 10
The number of backend query results to store in cache. If set to 1 (the current result), no caching will happen. Must be >= 1.
Number	Default: 400 for remote, 10 for local
The delay in milliseconds the autocompleter waits after a keystroke to activate itself.
Object
Extra parameters for the backend. If you were to specify { bar:4 }, the autocompleter would call my_autocomplete_backend.php?q=foo&bar=4 (assuming the input box contains "foo"). The param can be a function that is called to calculate the param before each request.
Function	Default: Assumes that a single row contains a single value.
Provides advanced markup for an item. For each row of results, this function will be called. The returned value will be displayed inside an LI element in the results list. Autocompleter will provide 4 parameters: the results row, the position of the row in the list of results (starting at 1), the number of items in the list of results and the search term.
Function	Default: formatItem is used
Use this option if you want to limit the data that autocomplete searches for matches. For example, there may be items you want displayed to the user, but don't want included in the data that's searched. Gets called with the same arguments as formatItem.
Function	Default: Assumes either plain data to use as result or uses the same value as provided by formatItem.
Similar to formatItem, but provides the formatting for the value to be put into the input field. Again three arguments: Data, position (starting with one) and total number of data.
Boolean , Function	Default: Wraps the search term in a <strong> Element
Whether and how to highlight matches in the select box. Set to false to disable. Set to a function to customize. The function gets the value as the first argument and the search term as the second and must return the formatted value.
Boolean	Default: false
Whether or not the comparison is case sensitive. Important only if you use caching.
Boolean	Default: false
Whether or not the comparison looks inside (i.e. does "ba" match "foo bar") the search results. Important only if you use caching. Don't mix with autofill.
Boolean	Default: true
Whether or not the autocompleter can use a cache for more specific queries. This means that all matches of "foot" are a subset of all matches for "foo". Usually this is true, and using this options decreases server load and increases performance. Only useful with cacheLength settings bigger than one, like 10.
Number	Default: 10
Limit the number of items in the select box. Is also sent as a "limit" parameter with a remote request.
Number	Default: 1
The minimum number of characters a user has to type before the autocompleter activates.
Boolean	Default: false
Whether to allow more than one autocompleted-value to enter.
String	Default: ", "
Seperator to put between values when using multiple option.
Boolean	Default: false
If set to true, the autocompleter will only allow results that are presented by the backend. Note that illegal values result in an empty input box.
Boolean	Default: true
Whether to scroll when more results than configured via scrollHeight are available.
Number	Default: 180
height of scrolled autocomplete control in pixels
Boolean	Default: true
If this is set to true, the first autocomplete value will be automatically selected on tab/return, even if it has not been handpicked by keyboard or mouse action. If there is a handpicked (highlighted) result, that result will take precedence.
Number	Default: width of the input Element
Specify a custom width for the select box.