jQuery UI Autocomplete 體驗(yàn)分享
更新時間：2012年02月14日 16:34:07 作者：
jQuery UI Autocomplete是jQuery UI的自動完成組件，是我用過的最強(qiáng)大、最靈活的Autocomplete，它支持本地的Array/JSON數(shù)組、通過ajax請求的Array/JSON數(shù)組、JSONP、以及Function(最靈活)等方式來獲取數(shù)據(jù)
支持的數(shù)據(jù)源
jQuery UI Autocomplete主要支持字符串Array、JSON兩種數(shù)據(jù)格式。
普通的Array格式?jīng)]有什么特殊的，如下：
對于JSON格式的Array，則要求有：label、value屬性，如下：
其中l(wèi)abel屬性用于顯示在autocomplete彈出菜單，而value屬性則是選中后給文本框賦的值。
如果沒有指定其中一個屬性則用另一個屬性替代(即value和label值一樣)，如下：
[{label: "cnblogs"}, {label: "囧月"}]
[{value: "cnblogs"}, {value: "囧月"}]
如果label和value都沒有指定，則無法用于autocomplete的提示。
另外需要注意，對于從服務(wù)器端輸出的JSON的key必須用雙引號，如下：
否則可能會出現(xiàn)parsererror錯誤。
主要的參數(shù)
jQuery UI Autocomplete常用的參數(shù)有：
Source：用于指定數(shù)據(jù)來源，類型為String、Array、Function
String：用于ajax請求的服務(wù)器端地址，返回Array/JSON格式
Array：即字符串?dāng)?shù)組 或 JSON數(shù)組
Function(request, response)：通過request.term獲得輸入的值，response([Array])來呈現(xiàn)數(shù)據(jù)；(JSONP是這種方式)
minLength：當(dāng)輸入框內(nèi)字符串長度達(dá)到minLength時，激活A(yù)utocomplete
autoFocus：當(dāng)Autocomplete選擇菜單彈出時，自動選中第一個
delay：即延遲多少毫秒激活A(yù)utocomplete
其他不常用的就不羅列了。
使用方法
假如頁面上有以下輸入框：
<input type="text" id="autocomp" />
AJAX請求
通過指定source為服務(wù)器端的地址來實(shí)現(xiàn)，如下：
$("#autocomp").autocomplete({
source: "remote.ashx",
minLength: 2
});
然后在服務(wù)器端接收，并輸出相應(yīng)結(jié)果，注意默認(rèn)傳遞的參數(shù)名稱為term：
public void ProcessRequest(HttpContext context)
{
// 查詢的參數(shù)名稱默認(rèn)為term
string query = context.Request.QueryString["term"];
context.Response.ContentType = "text/javascript";
//輸出字符串?dāng)?shù)組 或者 JSON 數(shù)組
context.Response.Write("[{\"label\":\"博客園\",\"value\":\"cnblogs\"},{\"label\":\"囧月\",\"value\":\"囧月\"}]");
}
本地Array/JSON數(shù)組
// 本地字符串?dāng)?shù)組
var availableTags = [
"C#",
"C++",
"Java",
"JavaScript",
"ASP",
"ASP.NET",
"JSP",
"PHP",
"Python",
"Ruby"
];
$("#local1").autocomplete({
source: availableTags
});
// 本地json數(shù)組
var availableTagsJSON = [
{ label: "C# Language", value: "C#" },
{ label: "C++ Language", value: "C++" },
{ label: "Java Language", value: "Java" },
{ label: "JavaScript Language", value: "JavaScript" },
{ label: "ASP.NET", value: "ASP.NET" },
{ label: "JSP", value: "JSP" },
{ label: "PHP", value: "PHP" },
{ label: "Python", value: "Python" },
{ label: "Ruby", value: "Ruby" }
];
$("#local2").autocomplete({
source: availableTagsJSON
});
Callback Function方式
通過指定source為自定義函數(shù)來實(shí)現(xiàn)自定義數(shù)據(jù)的獲取，函數(shù)主要有2個參數(shù)(request,response)，分別用于獲取輸入的值、呈現(xiàn)結(jié)果
本地Array方式獲取數(shù)據(jù)（模仿新浪微博的登錄）
var hosts = ["gmail.com", "live.com", "hotmail.com", "yahoo.com", "cnblogs.com", "火星.com", "囧月.com"];
$("#email1").autocomplete({
autoFocus: true,
source: function(request, response) {
var term = request.term, //request.term為輸入的字符串
ix = term.indexOf("@"),
name = term, // 用戶名
host = "", // 域名
result = []; // 結(jié)果
result.push(term);
// result.push({ label: term, value: term }); // json格式
if (ix > -1) {
name = term.slice(0, ix);
host = term.slice(ix + 1);
}
if (name) {
var findedHosts = (host ? $.grep(hosts, function(value) {
return value.indexOf(host) > -1;
}) : hosts),
findedResults = $.map(findedHosts, function(value) {
return name + "@" + value; //返回字符串格式
// return { label: name + " @ " + value, value: name + "@" + value }; // json格式
});
result = result.concat($.makeArray(findedResults));
}
response(result);//呈現(xiàn)結(jié)果
}
});
JSONP方式獲取數(shù)據(jù)
直接從官方DEMO拿來的，通過發(fā)送ajax請求到遠(yuǎn)程服務(wù)器，然后對返回結(jié)果進(jìn)行處理，最后通過response來呈現(xiàn)：
$("#jsonp").autocomplete({
source: function(request, response) {
$.ajax({
url: "http://ws.geonames.org/searchJSON",
dataType: "jsonp",
data: {
featureClass: "P",
style: "full",
maxRows: 12,
name_startsWith: request.term
},
success: function(data) {
response($.map(data.geonames, function(item) {
return {
label: item.name + (item.adminName1 ? ", " + item.adminName1 : "") + ", " + item.countryName,
value: item.name
}
}));
}
});
},
minLength: 2
});
主要的事件
jQuery UI Autocomplete有一些事件，可用于在一些階段進(jìn)行額外的控制：
create(event, ui)：Autocomplete創(chuàng)建時，可以在此事件中，對外觀進(jìn)行一些控制
search(event, ui)： 在開始請求之前，可以在此事件中返回false來取消請求
open(event, ui)：Autocomplete的結(jié)果列表彈出時
focus(event, ui)：Autocomplete的結(jié)果列表任意一項(xiàng)獲得焦點(diǎn)時，ui.item為獲得焦點(diǎn)的項(xiàng)
select(event, ui)：Autocomplete的結(jié)果列表任意一項(xiàng)選中時，ui.item為選中的項(xiàng)
close(event, ui)：Autocomplete的結(jié)果列表關(guān)閉時
change(event, ui)：當(dāng)值改變時，ui.item為選中的項(xiàng)
這些事件的ui參數(shù)的item屬性（如果有的話）默認(rèn)有l(wèi)abel和value屬性，不管在source中設(shè)置的數(shù)據(jù)是Array還是JSON數(shù)組，如下3種：
["cnblogs","博客園","囧月"]
[{label: "博客園", value: "cnblogs"}, {label: "囧月", value: "囧月"}]
[{label: "博客園", value: "cnblogs", id: "1"}, {label: "囧月", value: "囧月", id: "2"}]
假如是第三種的話，還可以得到ui.item.id的值。
這些事件可以通過2種方式來綁定，如下：
// 在參數(shù)中
$("#autocomp").autocomplete({
source: availableTags
, select: function(e, ui) {
alert(ui.item.value)
}
});
// 通過bind來綁定
$("#autocomp").bind("autocompleteselect", function(e, ui) {
alert(ui.item.value);
});
通過bind來綁定的方式使用的事件名稱為"autocomplete"+事件名稱，如"select"就是"autocompleteselect"。
多個值的Autocomplete
一般情況下，輸入框的autocomplete僅需要一個值就可以(如：javascript)；假如需要多個值(如：javascript,c#,asp.net)，則需要綁定一些事件來進(jìn)行額外處理：
在focus事件中返回false，避免輸入框的值被autocomplete的單個值取代
在select事件中組合多個值
在元素的keydown事件做一些處理，理由同1
使用callback function方式的source，來獲取最后輸入的值，并呈現(xiàn)結(jié)果
還是直接拿官方DEMO的代碼：
// 按逗號分隔多個值
function split(val) {
return val.split(/,\s*/);
}
// 提取輸入的最后一個值
function extractLast(term) {
return split(term).pop();
}
// 按Tab鍵時，取消為輸入框設(shè)置value
function keyDown(event) {
if (event.keyCode === $.ui.keyCode.TAB &&
$(this).data("autocomplete").menu.active) {
event.preventDefault();
}
}
var options = {
// 獲得焦點(diǎn)
focus: function() {
// prevent value inserted on focus
return false;
},
// 從autocomplete彈出菜單選擇一個值時，加到輸入框最后，并以逗號分隔
select: function(event, ui) {
var terms = split(this.value);
// remove the current input
terms.pop();
// add the selected item
terms.push(ui.item.value);
// add placeholder to get the comma-and-space at the end
terms.push("");
this.value = terms.join(", ");
return false;
}
};
// 多個值，本地數(shù)組
$("#local3").bind("keydown", keyDown)
.autocomplete($.extend(options, {
minLength: 2,
source: function(request, response) {
// delegate back to autocomplete, but extract the last term
response($.ui.autocomplete.filter(
availableTags, extractLast(request.term)));
}
}));
// 多個值，ajax返回json
$("#ajax3").bind("keydown", keyDown)
.autocomplete($.extend(options, {
minLength: 2,
source: function(request, response) {
$.getJSON("remoteJSON.ashx", {
term: extractLast(request.term)
}, response);
}
}));
結(jié)尾
最后，放上代碼：點(diǎn)擊下載。
更多的資料請看jQuery UI Autocomplete官方演示：http://jqueryui.com/demos/autocomplete
jQuery UI Autocomplete主要支持字符串Array、JSON兩種數(shù)據(jù)格式。
普通的Array格式?jīng)]有什么特殊的，如下：
復(fù)制代碼 代碼如下:
["cnblogs","博客園","囧月"]
對于JSON格式的Array，則要求有：label、value屬性，如下：
復(fù)制代碼 代碼如下:
[{label: "博客園", value: "cnblogs"}, {label: "囧月", value: "囧月"}]
其中l(wèi)abel屬性用于顯示在autocomplete彈出菜單，而value屬性則是選中后給文本框賦的值。
如果沒有指定其中一個屬性則用另一個屬性替代(即value和label值一樣)，如下：
復(fù)制代碼 代碼如下:
[{label: "cnblogs"}, {label: "囧月"}]
[{value: "cnblogs"}, {value: "囧月"}]
如果label和value都沒有指定，則無法用于autocomplete的提示。
另外需要注意，對于從服務(wù)器端輸出的JSON的key必須用雙引號，如下：
復(fù)制代碼 代碼如下:
[{"label": "博客園", "value": "cnblogs"}, {"label": "囧月", "value": "囧月"}]
否則可能會出現(xiàn)parsererror錯誤。
主要的參數(shù)
jQuery UI Autocomplete常用的參數(shù)有：
Source：用于指定數(shù)據(jù)來源，類型為String、Array、Function
String：用于ajax請求的服務(wù)器端地址，返回Array/JSON格式
Array：即字符串?dāng)?shù)組 或 JSON數(shù)組
Function(request, response)：通過request.term獲得輸入的值，response([Array])來呈現(xiàn)數(shù)據(jù)；(JSONP是這種方式)
minLength：當(dāng)輸入框內(nèi)字符串長度達(dá)到minLength時，激活A(yù)utocomplete
autoFocus：當(dāng)Autocomplete選擇菜單彈出時，自動選中第一個
delay：即延遲多少毫秒激活A(yù)utocomplete
其他不常用的就不羅列了。
使用方法
假如頁面上有以下輸入框：
<input type="text" id="autocomp" />
AJAX請求
通過指定source為服務(wù)器端的地址來實(shí)現(xiàn)，如下：
復(fù)制代碼 代碼如下:
$("#autocomp").autocomplete({
source: "remote.ashx",
minLength: 2
});
然后在服務(wù)器端接收，并輸出相應(yīng)結(jié)果，注意默認(rèn)傳遞的參數(shù)名稱為term：
復(fù)制代碼 代碼如下:
public void ProcessRequest(HttpContext context)
{
// 查詢的參數(shù)名稱默認(rèn)為term
string query = context.Request.QueryString["term"];
context.Response.ContentType = "text/javascript";
//輸出字符串?dāng)?shù)組 或者 JSON 數(shù)組
context.Response.Write("[{\"label\":\"博客園\",\"value\":\"cnblogs\"},{\"label\":\"囧月\",\"value\":\"囧月\"}]");
}
本地Array/JSON數(shù)組
復(fù)制代碼 代碼如下:
// 本地字符串?dāng)?shù)組
var availableTags = [
"C#",
"C++",
"Java",
"JavaScript",
"ASP",
"ASP.NET",
"JSP",
"PHP",
"Python",
"Ruby"
];
$("#local1").autocomplete({
source: availableTags
});
// 本地json數(shù)組
var availableTagsJSON = [
{ label: "C# Language", value: "C#" },
{ label: "C++ Language", value: "C++" },
{ label: "Java Language", value: "Java" },
{ label: "JavaScript Language", value: "JavaScript" },
{ label: "ASP.NET", value: "ASP.NET" },
{ label: "JSP", value: "JSP" },
{ label: "PHP", value: "PHP" },
{ label: "Python", value: "Python" },
{ label: "Ruby", value: "Ruby" }
];
$("#local2").autocomplete({
source: availableTagsJSON
});
Callback Function方式
通過指定source為自定義函數(shù)來實(shí)現(xiàn)自定義數(shù)據(jù)的獲取，函數(shù)主要有2個參數(shù)(request,response)，分別用于獲取輸入的值、呈現(xiàn)結(jié)果
本地Array方式獲取數(shù)據(jù)（模仿新浪微博的登錄）
復(fù)制代碼 代碼如下:
var hosts = ["gmail.com", "live.com", "hotmail.com", "yahoo.com", "cnblogs.com", "火星.com", "囧月.com"];
$("#email1").autocomplete({
autoFocus: true,
source: function(request, response) {
var term = request.term, //request.term為輸入的字符串
ix = term.indexOf("@"),
name = term, // 用戶名
host = "", // 域名
result = []; // 結(jié)果
result.push(term);
// result.push({ label: term, value: term }); // json格式
if (ix > -1) {
name = term.slice(0, ix);
host = term.slice(ix + 1);
}
if (name) {
var findedHosts = (host ? $.grep(hosts, function(value) {
return value.indexOf(host) > -1;
}) : hosts),
findedResults = $.map(findedHosts, function(value) {
return name + "@" + value; //返回字符串格式
// return { label: name + " @ " + value, value: name + "@" + value }; // json格式
});
result = result.concat($.makeArray(findedResults));
}
response(result);//呈現(xiàn)結(jié)果
}
});
JSONP方式獲取數(shù)據(jù)
直接從官方DEMO拿來的，通過發(fā)送ajax請求到遠(yuǎn)程服務(wù)器，然后對返回結(jié)果進(jìn)行處理，最后通過response來呈現(xiàn)：
復(fù)制代碼 代碼如下:
$("#jsonp").autocomplete({
source: function(request, response) {
$.ajax({
url: "http://ws.geonames.org/searchJSON",
dataType: "jsonp",
data: {
featureClass: "P",
style: "full",
maxRows: 12,
name_startsWith: request.term
},
success: function(data) {
response($.map(data.geonames, function(item) {
return {
label: item.name + (item.adminName1 ? ", " + item.adminName1 : "") + ", " + item.countryName,
value: item.name
}
}));
}
});
},
minLength: 2
});
主要的事件
jQuery UI Autocomplete有一些事件，可用于在一些階段進(jìn)行額外的控制：
create(event, ui)：Autocomplete創(chuàng)建時，可以在此事件中，對外觀進(jìn)行一些控制
search(event, ui)： 在開始請求之前，可以在此事件中返回false來取消請求
open(event, ui)：Autocomplete的結(jié)果列表彈出時
focus(event, ui)：Autocomplete的結(jié)果列表任意一項(xiàng)獲得焦點(diǎn)時，ui.item為獲得焦點(diǎn)的項(xiàng)
select(event, ui)：Autocomplete的結(jié)果列表任意一項(xiàng)選中時，ui.item為選中的項(xiàng)
close(event, ui)：Autocomplete的結(jié)果列表關(guān)閉時
change(event, ui)：當(dāng)值改變時，ui.item為選中的項(xiàng)
這些事件的ui參數(shù)的item屬性（如果有的話）默認(rèn)有l(wèi)abel和value屬性，不管在source中設(shè)置的數(shù)據(jù)是Array還是JSON數(shù)組，如下3種：
復(fù)制代碼 代碼如下:
["cnblogs","博客園","囧月"]
[{label: "博客園", value: "cnblogs"}, {label: "囧月", value: "囧月"}]
[{label: "博客園", value: "cnblogs", id: "1"}, {label: "囧月", value: "囧月", id: "2"}]
假如是第三種的話，還可以得到ui.item.id的值。
這些事件可以通過2種方式來綁定，如下：
復(fù)制代碼 代碼如下:
// 在參數(shù)中
$("#autocomp").autocomplete({
source: availableTags
, select: function(e, ui) {
alert(ui.item.value)
}
});
// 通過bind來綁定
$("#autocomp").bind("autocompleteselect", function(e, ui) {
alert(ui.item.value);
});
通過bind來綁定的方式使用的事件名稱為"autocomplete"+事件名稱，如"select"就是"autocompleteselect"。
多個值的Autocomplete
一般情況下，輸入框的autocomplete僅需要一個值就可以(如：javascript)；假如需要多個值(如：javascript,c#,asp.net)，則需要綁定一些事件來進(jìn)行額外處理：
在focus事件中返回false，避免輸入框的值被autocomplete的單個值取代
在select事件中組合多個值
在元素的keydown事件做一些處理，理由同1
使用callback function方式的source，來獲取最后輸入的值，并呈現(xiàn)結(jié)果
還是直接拿官方DEMO的代碼：
復(fù)制代碼 代碼如下:
// 按逗號分隔多個值
function split(val) {
return val.split(/,\s*/);
}
// 提取輸入的最后一個值
function extractLast(term) {
return split(term).pop();
}
// 按Tab鍵時，取消為輸入框設(shè)置value
function keyDown(event) {
if (event.keyCode === $.ui.keyCode.TAB &&
$(this).data("autocomplete").menu.active) {
event.preventDefault();
}
}
var options = {
// 獲得焦點(diǎn)
focus: function() {
// prevent value inserted on focus
return false;
},
// 從autocomplete彈出菜單選擇一個值時，加到輸入框最后，并以逗號分隔
select: function(event, ui) {
var terms = split(this.value);
// remove the current input
terms.pop();
// add the selected item
terms.push(ui.item.value);
// add placeholder to get the comma-and-space at the end
terms.push("");
this.value = terms.join(", ");
return false;
}
};
// 多個值，本地數(shù)組
$("#local3").bind("keydown", keyDown)
.autocomplete($.extend(options, {
minLength: 2,
source: function(request, response) {
// delegate back to autocomplete, but extract the last term
response($.ui.autocomplete.filter(
availableTags, extractLast(request.term)));
}
}));
// 多個值，ajax返回json
$("#ajax3").bind("keydown", keyDown)
.autocomplete($.extend(options, {
minLength: 2,
source: function(request, response) {
$.getJSON("remoteJSON.ashx", {
term: extractLast(request.term)
}, response);
}
}));
結(jié)尾
最后，放上代碼：點(diǎn)擊下載。
更多的資料請看jQuery UI Autocomplete官方演示：http://jqueryui.com/demos/autocomplete
您可能感興趣的文章:
- jQuery UI AutoComplete 使用說明
- jQuery UI AutoComplete 自動完成使用小記
- jQuery UI Autocomplete 1.8.16 中文輸入修正代碼
- jQuery ui autocomplete選擇列表被Bootstrap模態(tài)窗遮擋的完美解決方法
- firefox下jQuery UI Autocomplete 1.8.*中文輸入修正方法
- jQuery.Autocomplete實(shí)現(xiàn)自動完成功能（詳解）
- jQuery 插件autocomplete自動完成應(yīng)用(自動補(bǔ)全)(asp.net后臺)
- jquery autocomplete自動完成插件的的使用方法
- jQuery autoComplete插件兩種使用方式及動態(tài)改變參數(shù)值的方法詳解
- jQuery Autocomplete自動完成插件
- jquery UI實(shí)現(xiàn)autocomplete在獲取焦點(diǎn)時得到顯示列表功能示例
相關(guān)文章
jQuery第一次運(yùn)行頁面默認(rèn)觸發(fā)點(diǎn)擊事件的實(shí)例
下面小編就為大家分享一篇jQuery第一次運(yùn)行頁面默認(rèn)觸發(fā)點(diǎn)擊事件的實(shí)例，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2018-01-01
jQuery刪除當(dāng)前節(jié)點(diǎn)元素
本文給大家分享一段代碼給大家介紹jquery刪除當(dāng)前節(jié)點(diǎn)元素的方法，代碼簡單易懂，非常不錯，需要的朋友參考下吧2016-12-12
這篇文章主要為大家詳細(xì)介紹了基于jquery實(shí)現(xiàn)五子棋游戲，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-05-05
jQuery實(shí)現(xiàn)導(dǎo)航欄頭部菜單項(xiàng)點(diǎn)擊后變換顏色的方法
這篇文章主要介紹了jQuery實(shí)現(xiàn)導(dǎo)航欄頭部菜單項(xiàng)點(diǎn)擊后變換顏色的方法,涉及jQuery響應(yīng)鼠標(biāo)事件針對頁面元素的遍歷及屬性變換相關(guān)操作技巧,需要的朋友可以參考下2017-07-07
這篇文章主要介紹了jquery中ajax跨域方法,結(jié)合實(shí)例分析了jQuery中使用getJSON及$.ajax實(shí)現(xiàn)ajax跨域的技巧,需要的朋友可以參考下2015-12-12
DOM操作和jQuery實(shí)現(xiàn)選項(xiàng)移動操作的簡單實(shí)例
下面小編就為大家?guī)硪黄狣OM操作和jQuery實(shí)現(xiàn)選項(xiàng)移動操作的簡單實(shí)例。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2016-06-06
這篇文章主要介紹了jQuery常用的4種加載方式,結(jié)合實(shí)例形式分析了jQuery在頁面加載之前與加載之后執(zhí)行的4種常用加載方式,需要的朋友可以參考下2016-07-07
jQuery插件ajaxFileUpload使用實(shí)例解析
這篇文章主要為大家詳細(xì)介紹了jQuery插件ajaxFileUpload使用實(shí)例,具有一定的參考價值，感興趣的小伙伴們可以參考一下2016-10-10
jQuery+css實(shí)現(xiàn)的換頁標(biāo)簽欄效果
這篇文章主要介紹了jQuery+css實(shí)現(xiàn)的換頁標(biāo)簽欄效果,涉及jQuery動態(tài)操作頁面元素構(gòu)造換頁標(biāo)簽的相關(guān)技巧,需要的朋友可以參考下2016-01-01
基于jQuery實(shí)現(xiàn)表單提交驗(yàn)證
本文給大家分享的是一段基于jQuery的實(shí)現(xiàn)簡單的表單提交驗(yàn)證的代碼，非常簡單實(shí)用，推薦給有相同需求的小伙伴們參考下。2014-11-11