Skip to content
This repository has been archived by the owner on Mar 16, 2018. It is now read-only.

Options

Jump to bottom
Klap-in edited this page Nov 3, 2011 · 8 revisions

autocomplete( url or data, [options] )

$("#tags").autocomplete("search.php");

$("#tags").autocomplete(["c++", "java", "php", "coldfusion", "javascript", "asp"], {
	max: 4,
	highlight: false
});

var aData = var data = "Core Selectors Attributes Traversing Manipulation Ajax Utilities".split(" ");
$("#tags").autocomplete( aData, {
	max: 4,
	highlight: false
});

$("#tags").autocomplete("search.php", {
	max: 4,
	highlight: false
});

autoFill Boolean
Default: false

Fill the textinput while still selecting a value, replacing the value if more is typed or something else is selected.

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

delay Number
Default: 400 for remote, 10 for local

The delay in milliseconds the autocompleter waits after a keystroke to activate itself.

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

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

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

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

highlight Boolean, Function
Default: Wraps the search term in a 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.

matchCase Boolean
Default: false

Whether or not the comparison is case sensitive. Important only if you use caching.

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

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

max Number
Default: 10

Limit the number of items in the select box. Is also sent as a "limit" parameter with a remote request.

minChars Number
Default: 1

The minimum number of characters a user has to type before the autocompleter activates.

multiple Boolean
Default: false

Whether to allow more than one autocompleted-value to enter.

multipleSeparator String
Default: ", "

Seperator to put between values when using multiple option.

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

scroll Boolean
Default: true

Whether to scroll when more results than configured via scrollHeight are available.

scrollHeight Number
Default: 180

height of scrolled autocomplete control in pixels

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

width Number
Default: width of the input Element

Specify a custom width for the select box.

Clone this wiki locally