摘要：
1〔｛label:“Blog Park”，value:“cnblogs”｝，｛label：“Jiongyue”，value：“Jiong yue”｝〕其中label属性用于在自动完成弹出菜单中显示，value属性是选择后分配给文本框的值。主要参数jQueryUIAutocomplete常见参数有：Source：用于指定数据源。类型为String、Array、FunctionString：用于ajax请求的服务器地址。它返回Array/JSON格式。Array：字符串数组或JSON数组。函数：传递的请求Term获取输入值，响应呈现数据；minLength：当输入框中的字符串长度达到minLength时，自动完成自动聚焦将被激活。当自动完成选择菜单弹出时，将自动选择第一个延迟，即延迟激活自动完成的毫秒数。其他很少使用的物品将不会列出。
jQuery UI Autocomplete是jQuery UI的自动完成组件，是我用过的最强大、最灵活的Autocomplete，它支持本地的Array/JSON数组、通过ajax请求的Array/JSON数组、JSONP、以及Function(最灵活)等方式来获取数据。
支持的数据源jQuery UI Autocomplete主要支持字符串Array、JSON两种数据格式。
普通的Array格式没有什么特殊的，如下：
1 | ["cnblogs","博客园","囧月"] |
对于JSON格式的Array，则要求有：label、value属性，如下：
1 | [{label: "博客园", value: "cnblogs"}, {label: "囧月", value: "囧月"}] |
其中label属性用于显示在autocomplete弹出菜单，而value属性则是选中后给文本框赋的值。
如果没有指定其中一个属性则用另一个属性替代(即value和label值一样)，如下：
1 2 | [{label: "cnblogs"}, {label: "囧月"}][{value: "cnblogs"}, {value: "囧月"}] |
如果label和value都没有指定，则无法用于autocomplete的提示。
另外需要注意，对于从服务器端输出的JSON的key必须用双引号，如下：
1 | [{"label": "博客园", "value": "cnblogs"}, {"label": "囧月", "value": "囧月"}] |
jQuery UI Autocomplete常用的参数有：
- Source：用于指定数据来源，类型为String、Array、Function
- String：用于ajax请求的服务器端地址，返回Array/JSON格式
- Array：即字符串数组 或 JSON数组
- Function(request, response)：通过request.term获得输入的值，response([Array])来呈现数据；(JSONP是这种方式)
- minLength：当输入框内字符串长度达到minLength时，激活Autocomplete
- autoFocus：当Autocomplete选择菜单弹出时，自动选中第一个
- delay：即延迟多少毫秒激活Autocomplete
其他不常用的就不罗列了。
使用方法假如页面上有以下输入框：
<input type="text" id="autocomp" />
AJAX请求
通过指定source为服务器端的地址来实现，如下：
1 2 3 4 | $("#autocomp").autocomplete({ source: "remote.ashx", minLength: 2}); |
然后在服务器端接收，并输出相应结果，注意默认传递的参数名称为term：
public void ProcessRequest(HttpContext context) { // 查询的参数名称默认为term string query = context.Request.QueryString["term"]; context.Response.ContentType = "text/javascript"; //输出字符串数组 或者 JSON 数组 context.Response.Write("[{\"label\":\"博客园\",\"value\":\"cnblogs\"},{\"label\":\"囧月\",\"value\":\"囧月\"}]"); }
本地Array/JSON数组
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 | // 本地字符串数组varavailableTags = [ "C#", "C++", "Java", "JavaScript", "ASP", "ASP.NET", "JSP", "PHP", "Python", "Ruby"];$("#local1").autocomplete({ source: availableTags});// 本地json数组varavailableTagsJSON = [ { 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}); |
通过指定source为自定义函数来实现自定义数据的获取，函数主要有2个参数(request,response)，分别用于获取输入的值、呈现结果
本地Array方式获取数据（模仿新浪微博的登录）
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 | varhosts = ["gmail.com", "live.com", "hotmail.com", "yahoo.com", "cnblogs.com", "火星.com", "囧月.com"];$("#email1").autocomplete({ autoFocus: true, source: function(request, response) { varterm = request.term, //request.term为输入的字符串 ix = term.indexOf("@"), name = term, // 用户名 host = "", // 域名 result = []; // 结果 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) { varfindedHosts = (host ? $.grep(hosts, function(value) { returnvalue.indexOf(host) > -1; }) : hosts), findedResults = $.map(findedHosts, function(value) { returnname + "@"+ value; //返回字符串格式 // return { label: name + " @ " + value, value: name + "@" + value }; // json格式 }); result = result.concat($.makeArray(findedResults)); } response(result);//呈现结果 }}); |
JSONP方式获取数据
直接从官方DEMO拿来的，通过发送ajax请求到远程服务器，然后对返回结果进行处理，最后通过response来呈现：
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | $("#jsonp").autocomplete({ source: function(request, response) { $.ajax({ 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有一些事件，可用于在一些阶段进行额外的控制：
- create(event, ui)：Autocomplete创建时，可以在此事件中，对外观进行一些控制
- search(event, ui)： 在开始请求之前，可以在此事件中返回false来取消请求
- open(event, ui)：Autocomplete的结果列表弹出时
- focus(event, ui)：Autocomplete的结果列表任意一项获得焦点时，ui.item为获得焦点的项
- select(event, ui)：Autocomplete的结果列表任意一项选中时，ui.item为选中的项
- close(event, ui)：Autocomplete的结果列表关闭时
- change(event, ui)：当值改变时，ui.item为选中的项
这些事件的ui参数的item属性（如果有的话）默认有label和value属性，不管在source中设置的数据是Array还是JSON数组，如下3种：
1 2 3 | ["cnblogs","博客园","囧月"][{label: "博客园", value: "cnblogs"}, {label: "囧月", value: "囧月"}][{label: "博客园", value: "cnblogs", id: "1"}, {label: "囧月", value: "囧月", id: "2"}] |
假如是第三种的话，还可以得到ui.item.id的值。
这些事件可以通过2种方式来绑定，如下：
1 2 3 4 5 6 7 8 9 10 11 12 | // 在参数中$("#autocomp").autocomplete({ source: availableTags , select: function(e, ui) { alert(ui.item.value) }});// 通过bind来绑定$("#autocomp").bind("autocompleteselect", function(e, ui) { alert(ui.item.value);}); |
一般情况下，输入框的autocomplete仅需要一个值就可以(如：javascript)；假如需要多个值(如：javascript,c#,asp.net)，则需要绑定一些事件来进行额外处理：
- 在focus事件中返回false，避免输入框的值被autocomplete的单个值取代
- 在select事件中组合多个值
- 在元素的keydown事件做一些处理，理由同1
- 使用callback function方式的source，来获取最后输入的值，并呈现结果
还是直接拿官方DEMO的代码：
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | // 按逗号分隔多个值functionsplit(val) { returnval.split(/,\s*/);}// 提取输入的最后一个值functionextractLast(term) { returnsplit(term).pop();}// 按Tab键时，取消为输入框设置valuefunctionkeyDown(event) { if(event.keyCode === $.ui.keyCode.TAB && $(this).data("autocomplete").menu.active) { event.preventDefault(); }}varoptions = { // 获得焦点 focus: function() { // prevent value inserted on focus returnfalse; }, // 从autocomplete弹出菜单选择一个值时，加到输入框最后，并以逗号分隔 select: function(event, ui) { varterms = 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(", "); returnfalse; }};// 多个值，本地数组$("#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); } })); |
最后，放上代码：点击下载。
更多的资料请看jQuery UI Autocomplete官方演示：http://jqueryui.com/demos/autocomplete
作者：囧月
出处：http://lwme.cnblogs.com/
本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。