JQuery autocomplete 使用手冊

更新時間：2010年04月01日 21:06:21 作者：

Jquery autocomplete是一個很強大的類似google suggest的自動提示插件。它幾乎可以滿足我們所有的需要。

官方網(wǎng)站：http://bassistance.de/jquery-plugins/jquery-plugin-autocomplete
當(dāng)前版本：1.1
需要JQuery版本：1.2.6+
首先是最重要的方法
autocomplete( url or data, [options] )
第一個參數(shù)可以是數(shù)組或者url。options參數(shù)比較復(fù)雜：
* minChars (Number):
在觸發(fā)autoComplete前用戶至少需要輸入的字符數(shù).Default: 1，如果設(shè)為0，在輸入框內(nèi)雙擊或者刪除輸入框內(nèi)內(nèi)容時顯示列表
* width (Number):
指定下拉框的寬度. Default: input元素的寬度
* max (Number):
autoComplete下拉顯示項目的個數(shù).Default: 10
* delay (Number):
擊鍵后激活autoComplete的延遲時間(單位毫秒).Default: 遠程為400 本地10
* autoFill (Boolean):
要不要在用戶選擇時自動將用戶當(dāng)前鼠標(biāo)所在的值填入到input框. Default: false
* mustMatch (Booolean):
如果設(shè)置為true,autoComplete只會允許匹配的結(jié)果出現(xiàn)在輸入框,所有當(dāng)用戶輸入的是非法字符時將會得不到下拉框.Default: false
* matchContains (Boolean):
決定比較時是否要在字符串內(nèi)部查看匹配,如ba是否與foo bar中的ba匹配.使用緩存時比較重要.不要和autofill混用.Default: false
* selectFirst (Boolean):
如果設(shè)置成true,在用戶鍵入tab或return鍵時autoComplete下拉列表的第一個值將被自動選擇,盡管它沒被手工選中(用鍵盤或鼠標(biāo)).當(dāng)然如果用戶選中某個項目,那么就用用戶選中的值. Default: true
* cacheLength (Number):
緩存的長度.即對從數(shù)據(jù)庫中取到的結(jié)果集要緩存多少條記錄.設(shè)成1為不緩存.Default: 10
* matchSubset (Boolean):
autoComplete可不可以使用對服務(wù)器查詢的緩存,如果緩存對foo的查詢結(jié)果,那么如果用戶輸入foo就不需要再進行檢索了,直接使用緩存.通常是打開這個選項以減輕服務(wù)器的負(fù)擔(dān)以提高性能.只會在緩存長度大于1時有效.Default: true
* matchCase (Boolean):
比較是否開啟大小寫敏感開關(guān).使用緩存時比較重要.如果你理解上一個選項,這個也就不難理解,就好比foot要不要到FOO的緩存中去找.Default: false
* multiple (Boolean):
是否允許輸入多個值即多次使用autoComplete以輸入多個值. Default: false
* multipleSeparator (String):
如果是多選時,用來分開各個選擇的字符. Default: ","
* scroll (Boolean):
當(dāng)結(jié)果集大于默認(rèn)高度時是否使用卷軸顯示 Default: true
* scrollHeight (Number):
自動完成提示的卷軸高度用像素大小表示 Default: 180
* formatItem (Function):
為每個要顯示的項目使用高級標(biāo)簽.即對結(jié)果中的每一行都會調(diào)用這個函數(shù),返回值將用LI元素包含顯示在下拉列表中. Autocompleter會提供三個參數(shù)(row, i, max): 返回的結(jié)果數(shù)組, 當(dāng)前處理的行數(shù)(即第幾個項目,是從1開始的自然數(shù)), 當(dāng)前結(jié)果數(shù)組元素的個數(shù)即項目的個數(shù). Default: none, 表示不指定自定義的處理函數(shù),這樣下拉列表中的每一行只包含一個值.
* formatResult (Function):
和formatItem類似,但可以將將要輸入到input文本框內(nèi)的值進行格式化.同樣有三個參數(shù),和formatItem一樣.Default: none,表示要么是只有數(shù)據(jù),要么是使用formatItem提供的值.
* formatMatch (Function):
對每一行數(shù)據(jù)使用此函數(shù)格式化需要查詢的數(shù)據(jù)格式. 返回值是給內(nèi)部搜索算法使用的. 參數(shù)值row
* extraParams (Object):
為后臺(一般是服務(wù)端的腳本)提供更多的參數(shù).和通常的作法一樣是使用一個鍵值對對象.如果傳過去的值是{ bar:4 },將會被autocompleter解析成my_autocomplete_backend.php?q=foo&bar=4 (假設(shè)當(dāng)前用戶輸入了foo). Default: {}

result(handler, item)
為選中后觸發(fā)的事件。item為選中的相。
例如，我們可以在選中后直接跳轉(zhuǎn)頁面：

復(fù)制代碼代碼如下:

 
var data = [ {text:'Link A', url:'/page1'}, {text:'Link B', url: '/page2'} ]; 
$("...").autocomplete(data, { 
formatItem: function(item) { 
return item.text; 
} 
}).result(function(event, item) { 
location.href = item.url; 
}); 

文檔地址：http://docs.jquery.com/Plugins/Autocomplete#API_Documentation

使用實例代碼：
Jquery AutoComplete自動完成的使用方法實例

您可能感興趣的文章: