jquery-autocomplete的用法及引數

langgufu314發表於2012-02-29

var emails = [
{ name: "Peter Pan", to: "
peter@pan.de" },
{ name: "Molly", to: "
molly@yahoo.com" },
{ name: "Forneria Marconi", to: "
live@japan.jp" },
{ name: "Master <em>Sync</em>", to: "
205bw@samsung.com" },
{ name: "Dr. <strong>Tech</strong> de Log", to: "
g15@logitech.com" },
{ name: "Don Corleone", to: "
don@vegas.com" },
{ name: "Mc Chick", to: "
info@donalds.org" },
{ name: "Donnie Darko", to: "
dd@timeshift.info" },
{ name: "Quake The Net", to: "
webmaster@quakenet.org" },
{ name: "Dr. Write", to: "
write@writable.com" }
];
//emails的陣列格式如上,formatItem代表的是顯示的格式,formatMatch表示匹配的內容,formatResult表示結果的內容

$("#suggest13").autocomplete(emails, {
minChars: 0,
width: 310,
matchContains: true,
autoFill: false,
formatItem: function(row, i, max) {
return i + "/" + max + ": \"" + row.name + "\" [" + row.to + "]";
},
formatMatch: function(row, i, max) {
return row.name + " " + row.to;
},
formatResult: function(row) {
return row.to;
}
});


引數說明:
* minChars (Number):
在觸發autoComplete前使用者至少需要輸入的字元數.Default: 1,如果設為0,在輸入框內雙擊或者刪除輸入框內內容時顯示列表
* width (Number):
指定下拉框的寬度. Default: input元素的寬度
* max (Number):
autoComplete下拉顯示專案的個數.Default: 10
* delay (Number):
擊鍵後啟用autoComplete的延遲時間(單位毫秒).Default: 遠端為400 本地10
* autoFill (Boolean):
要不要在使用者選擇時自動將使用者當前滑鼠所在的值填入到input框. Default: false
* mustMatch (Booolean):
如果設定為true,autoComplete只會允許匹配的結果出現在輸入框,所有當使用者輸入的是非法字元時將會得不到下拉框.Default: false
* matchContains (Boolean):
決定比較時是否要在字串內部檢視匹配,如ba是否與foo bar中的ba匹配.使用快取時比較重要.不要和autofill混用.Default: false
* selectFirst (Boolean):
如果設定成true,在使用者鍵入tab或return鍵時autoComplete下拉選單的第一個值將被自動選擇,儘管它沒被手工選中(用鍵盤或滑鼠).當然如果使用者選中某個專案,那麼就用使用者選中的值. Default: true
* cacheLength (Number):
快取的長度.即對從資料庫中取到的結果集要快取多少條記錄.設成1為不快取.Default: 10
* matchSubset (Boolean):
autoComplete可不可以使用對伺服器查詢的快取,如果快取對foo的查詢結果,那麼如果使用者輸入foo就不需要再進行檢索了,直接使用快取.通常是開啟這個選項以減輕伺服器的負擔以提高效能.只會在快取長度大於1時有效.Default: true
* matchCase (Boolean):
比較是否開啟大小寫敏感開關.使用快取時比較重要.如果你理解上一個選項,這個也就不難理解,就好比foot要不要到FOO的快取中去找.Default: false
* multiple (Boolean):
是否允許輸入多個值即多次使用autoComplete以輸入多個值. Default: false
* multipleSeparator (String):
如果是多選時,用來分開各個選擇的字元. Default: ","
* scroll (Boolean):
當結果集大於預設高度時是否使用卷軸顯示 Default: true
* scrollHeight (Number):
自動完成提示的卷軸高度用畫素大小表示 Default: 180
* formatItem (Function):
為每個要顯示的專案使用高階標籤.即對結果中的每一行都會呼叫這個函式,返回值將用LI元素包含顯示在下拉選單中. Autocompleter會提供三個引數(row, i, max): 返回的結果陣列, 當前處理的行數(即第幾個專案,是從1開始的自然數), 當前結果陣列元素的個數即專案的個數. Default: none, 表示不指定自定義的處理函式,這樣下拉選單中的每一行只包含一個值.
* formatResult (Function):
和formatItem類似,但可以將將要輸入到input文字框內的值進行格式化.同樣有三個引數,和formatItem一樣.Default: none,表示要麼是隻有資料,要麼是使用formatItem提供的值.
* formatMatch (Function):
對每一行資料使用此函式格式化需要查詢的資料格式. 返回值是給內部搜尋演算法使用的. 引數值row
* extraParams (Object):
為後臺(一般是服務端的指令碼)提供更多的引數.和通常的作法一樣是使用一個鍵值對物件.如果傳過去的值是{ bar:4 },將會被autocompleter解析成my_autocomplete_backend.php?q=foo&bar=4 (假設當前使用者輸入了foo). Default: {}
* result (handler) Returns: jQuery
此事件會在使用者選中某一項後觸發,引數為:
event: 事件物件. event.type為result.
data: 選中的資料行.
formatted:formatResult函式返回的值
例如:
$("#singleBirdRemote").result(function(event, data, formatted) {
//如選擇後給其他控制元件賦值,觸發別的事件等等
});

相關文章