jQuery.Autocomplete 是jquery的流行插件,能夠很好的實現輸入框的自動完成(autocomplete)、建議提示(input suggest)功能,支持ajax數據加載。
官方網站:http://bassistance.de/jquery-plugins/jquery-plugin-autocomplete/
一、調用本地數據
最簡單的Autocomplete(自動完成)代碼
<script type="text/javascript"> var websites = [ "Google","NetEase", "Sohu", "Sina", "Sogou", "Baidu", "Tencent", "Taobao", "Tom", "Yahoo", "JavaEye", "Csdn", "Alipay" ]; $().ready(function() { $("#website").autocomplete(websites); }); </script>
<p> <label>Web Site:</label> <input type="text" id="website" /> <input type="button" id="getvalue" value="Get Value" /> </p> <div id="content"></div>
這麼幾行代碼就完成了自動完成功能,真實太強了,不過bassistance.de的jQuery Autocomplete插件還有更豐富的功能,它的文檔在http://docs.jquery.com/Plugins/Autocomplete,在API Documentation裏,我們要仔細的研究一下autocomplete( url or data, [options] )方法。
autocomplete方法有兩個參數,第一個用來填寫URL地址或是數據,jQuery Autocomplete插件是支持Ajax方式調用數據,所以可以填寫調用的地址,另外可以直接填寫數據,格式爲JavaScript數組,如我們的例子,autocomplete的另外一個參數 [options]是一個可選項,我們在例子中就沒有寫,但這個參數裏面卻有很多可配置的參數,我們還是先修改上面的例子
$().ready(function() { $("#website").autocomplete(websites,{ minChars: 0, max: 5, autoFill: true, mustMatch: true, matchContains: true, scrollHeight: 220, formatItem: function(data, i, total) { return "<I>"+data[0]+"</I>"; }, formatMatch: function(data, i, total) { return data[0]; }, formatResult: function(data) { return data[0]; } }); });
在options項我們增加了好幾個參數
minChars表示在自動完成激活之前填入的最小字符,這裏我們設置爲0,在我們雙擊文本框,不輸入字符的時候,就會把數據顯示出來,效果如下
max表示列表裏的條目數,我們設置了5,所以顯示5條,也如上圖
autoFill表示自動填充,就是在文本框中自動填充符合條件的項目,看下圖,在我們輸入“g”的時候,文本框裏填充了“google”
mustMatch表示必須匹配條目,也就是在文本框裏輸入的內容,必須是data參數裏的數據,如果不匹配,文本框就被清空
matchContains表示包含匹配,就是data參數裏的數據,是否只要包含文本框裏的數據就顯示,比如在上面的圖中,我們輸入了“g”,由於“Sogou”中也包含一個“g”,所以會顯示出來,如果將matchContains設爲fasle,則“Sogou”就不會顯示
scrollHeight不用多解釋,看文檔就知道。
後面3個參數formatItem、formatMatch、formatResult非常有用,formatItem作用在於可以格式化列表中的條目,比如我們加了“I”,讓列表裏的字顯示出了斜體,formatMatch是配合formatItem使用,作用在於,由於使用了formatItem,所以條目中的內容有所改變,而我們要匹配的是原始的數據,所以用formatMatch做一個調整,使之匹配原始數據,formatResult是定義最終返回的數據,比如我們還是要返回原始數據,而不是formatItem過的數據。
[options]裏還有很多有用的參數,大家可以看它的文檔。
二、調用服務器端json數據
php生成服務器端json數據,echo json_encode($array)。
<script language="JavaScript" type="text/javascript"> function initAutoComplete(json){ $("#tel").autocomplete(json , { minChars:1, width:260, dataType:"json", matchContains: true, formatItem: function(row, i, max) { return row.tel + " <" + row.name + "> ["+row.cg_name+"]"; }, formatMatch: function(row, i, max) { return row.tel; }, formatResult: function(row) { return row.tel; } }); } $(document).ready(function(){ $("#tel").focus(function(){ $.post(url,{},function(data){ initAutoComplete(data); },"json"); }); }); </script>
三、參數說明:
* 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) {
//如選擇後給其他控件賦值,觸發別的事件等等
});