jQuery UI Autocomplete使用技巧(jquery autocomplete demo)

jQuery UI Autocomplete是jQuery UI的自动完成组件，是我用过的最强大、最灵活的Autocomplete，它支持本地的Array/JSON数组、通过ajax请求的Array/JSON数组、JSONP、以及Function(最灵活)等方式来获取数据

支持的数据源 
jQuery UI Autocomplete主要支持字符串Array、JSON两种数据格式。 
普通的Array格式没有什么特殊的，如下： 

复制代码代码如下:

["cnblogs","博客园","囧月"]

对于JSON格式的Array，则要求有：label、value属性，如下： 

复制代码代码如下:

[{label: "博客园", value: "cnblogs"}, {label: "囧月", value: "囧月"}]

其中label属性用于显示在autocomplete弹出菜单，而value属性则是选中后给文本框赋的值。 
如果没有指定其中一个属性则用另一个属性替代(即value和label值一样)，如下： 

复制代码代码如下:

[{label: "cnblogs"}, {label: "囧月"}] 
[{value: "cnblogs"}, {value: "囧月"}] 

如果label和value都没有指定，则无法用于autocomplete的提示。 
另外需要注意，对于从服务器端输出的JSON的key必须用双引号，如下： 

复制代码代码如下:

[{"label": "博客园", "value": "cnblogs"}, {"label": "囧月", "value": "囧月"}]

否则可能会出现parsererror错误。 
主要的参数 
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为服务器端的地址来实现，如下： 

复制代码代码如下:

$("#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数组 

复制代码代码如下:

// 本地字符串数组 
var availableTags = [ 
"C#", 
"C++", 
"Java", 
"JavaScript", 
"ASP", 
"ASP.NET", 
"JSP", 
"PHP", 
"Python", 
"Ruby" 
]; 
$("#local1").autocomplete({ 
source: availableTags 
}); 
// 本地json数组 
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为自定义函数来实现自定义数据的获取，函数主要有2个参数(request,response)，分别用于获取输入的值、呈现结果 
本地Array方式获取数据（模仿新浪微博的登录） 

复制代码代码如下:

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 = []; // 结果 
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);//呈现结果 
} 
}); 

JSONP方式获取数据 
直接从官方DEMO拿来的，通过发送ajax请求到远程服务器，然后对返回结果进行处理，最后通过response来呈现： 

复制代码代码如下:

$("#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有一些事件，可用于在一些阶段进行额外的控制： 
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种： 

复制代码代码如下:

["cnblogs","博客园","囧月"] 
[{label: "博客园", value: "cnblogs"}, {label: "囧月", value: "囧月"}] 
[{label: "博客园", value: "cnblogs", id: "1"}, {label: "囧月", value: "囧月", id: "2"}] 

假如是第三种的话，还可以得到ui.item.id的值。 
这些事件可以通过2种方式来绑定，如下： 

复制代码代码如下:

// 在参数中 
$("#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)，则需要绑定一些事件来进行额外处理： 
在focus事件中返回false，避免输入框的值被autocomplete的单个值取代 
在select事件中组合多个值 
在元素的keydown事件做一些处理，理由同1 
使用callback function方式的source，来获取最后输入的值，并呈现结果 
还是直接拿官方DEMO的代码： 

复制代码代码如下:

// 按逗号分隔多个值 
function split(val) { 
return val.split(/,\s*/); 
} 
// 提取输入的最后一个值 
function extractLast(term) { 
return split(term).pop(); 
} 
// 按Tab键时，取消为输入框设置value 
function keyDown(event) { 
if (event.keyCode === $.ui.keyCode.TAB && 
$(this).data("autocomplete").menu.active) { 
event.preventDefault(); 
} 
} 
var options = { 
// 获得焦点 
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; 
} 
}; 
// 多个值，本地数组 
$("#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

简单用法：

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title></title>
    <link rel="stylesheet" type="text/css" href="../css/autocomplete/jquery.autocomplete.css"/>
    <script type="text/javascript" src="../js/jquery-1.4.2.min.js"></script>
    <script type="text/javascript" src="../js/autocomplete/jquery.autocomplete.js"></script>
    <script type="text/javascript">
    $(function(){
        var data = "the People's Republic of China".split(" ");
        $("#autocomplete").autocomplete(data,{minChars:0}).result(function(event,data,formatted){
            alert(data);
        });
    });
    </script>
  </head>
  <body>
    <input type="text" id="autocomplete"/>
  </body>
</html>

更多参数说明：

第一个参数除了本地数据外，还可以是url请求路径。

配置项参数说明：

dataType（String）：数据类型.Default:text，如果第一个参数是url地址，并且返回的是json数据，则设置此配置属性为'json'即可；

minChars（Number）：在触发autoComplete前用户至少需要输入的字符数.Default: 1，如果设为0，在输入框内双击或者删除输入框内内容时显示列表；

max（Number）：autoComplete下拉显示项目的个数.Default: 10；

width（Number）：指定下拉框的宽度. Default: input元素的宽度；

delay（Number）：击键后激活autoComplete的延迟时间(单位毫秒).Default: 远程为400 本地10；

autoFill（Boolean）：要不要在用户选择时自动将用户当前鼠标所在的值填入到input框. Default: false；

mustMatch（Boolean）：如果设置为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；(注：查询时，如果没有配置为true,则输入的字符将会转变成小写格式进行查询)

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, 表示不指定自定义的处理函数,这样下拉列表中的每一行只包含一个值；

formatMatch（Function）：对每一行数据使用此函数格式化需要查询的数据格式. 返回值是给内部搜索算法使用的. 参数值row i max；

formatResult（Function）：和formatItem类似,但可以将将要输入到input文本框内的值进行格式化.同样有三个参 数,和formatItem一样.Default: none,表示要么是只有数据,要么是使用formatItem提供的值；

extraParams（Object）：为后台(一般是服务端的脚本)提供更多的参数.和通常的作法一样是使用一个键值对对象.如果传过去的值是 { bar:4 },将会被autocompleter解析成my_autocomplete_backend.php?q=foo&bar=4 (假设当前用户输入了foo). Default: {}；(注：前台输入的查询字符赋值给q之后，传给后台。如前台输入a,请求url中则会添加q=a)

result （handler）  Returns: jQuery：此事件会在用户选中某一项后触发，参数为： 
    event: 事件对象. event.type为result. 
    data: 选中的数据行. 
    formatted:formatResult函数返回的值 
    例如： $("#singleBirdRemote").result(function(event, data, formatted) { 
                  //如选择后给其他控件赋值，触发别的事件等等 
              });

 

一个稍微复杂点的例子：

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title></title>
    <link rel="stylesheet" type="text/css" href="../css/autocomplete/jquery.autocomplete.css"/>
    <script type="text/javascript" src="../js/jquery-1.4.2.min.js"></script>
    <script type="text/javascript" src="../js/autocomplete/jquery.autocomplete.js"></script>
    <script type="text/javascript">
    $(function(){
        var emails = [
            { name: "Peter", to: "[e-mail]" },
            { name: "Molly", to: "[e-mail]" },
            { name: "Forneria", to: "[e-mail]" },
            { name: "Master <em>Sync</em>", to: "[e-mail]" },
            { name: "Dr. <strong>Tech</strong> de Log", to: "[e-mail]" },
            { name: "Don Corleone", to: "[e-mail]" },
            { name: "Mc Chick", to: "[e-mail]" },
            { name: "Donnie Darko", to: "[e-mail]" },
            { name: "Quake The Net", to: "[e-mail]" },
            { name: "Dr. Write", to: "[e-mail]" },
            { name: "GG Bond", to: "[e-mail]" },
            { name: "Zhuzhu Xia", to: "[e-mail]" }
        ];

        $("#autocomplete").autocomplete(emails,{
            minChars: 0,//自动完成激活之前填入的最小字符
              max:12,//列表条目数
              width: 400,//提示的宽度
              scrollHeight: 300,//提示的高度
              matchContains: true,//是否只要包含文本框里的就可以
              autoFill:false,//自动填充
              formatItem: function(data, i, max) {//格式化列表中的条目 row:条目对象,i:当前条目数,max:总条目数
return i + '/' + max + ':"' + data.name + '"[' + data.to + ']';
            },
            formatMatch: function(data, i, max) {//配合formatItem使用，作用在于，由于使用了formatItem，所以条目中的内容有所改变，而我们要匹配的是原始的数据，所以用formatMatch做一个调整，使之匹配原始数据
return data.name + data.to;
            },
            formatResult: function(data) {//定义最终返回的数据，比如我们还是要返回原始数据，而不是formatItem过的数据
return data.to;
            }
        }).result(function(event,data,formatted){
            alert(data.to);
        });
    });
    </script>
  </head>
  <body>
    <input type="text" id="autocomplete"/>
  </body>
</html>

中文支持：

在对中文输入法打开时，firefox3.0中是对中文拼音的自动匹配，而对输入后的中文无法及时触发匹配；而在我的IE6.0下，则无此问题。

原因分析：
Autocomplete插件对用户输入字符的触发自动匹配是通过”keydown”事件进行的（可分析 jquery.autocomplete.js第92行），在IE6中，当输入法打开时，输入的字符是不会触发”keydown”的，只有中文输入完毕才 触发之，所以中文输入和latin文没有区别的；但在firefox3.0下，无论输入法打开否，按键都会触发”keydown”事件，所以造成中文输入 完毕，自动匹配的是刚才打出的部分中文拼音字母。

解决方法：
网上查到的最多做法是修改jquery.autocomplete.js第92行，将”keydown”替换为”keyup”， 但这个不是根本办法，虽然这样改后可在firefox中及时对输入的中文进行自动匹配，但将原插件中回车、tab等重要的事件机制破坏了，比如这样改后， 如果你的input是在一个form里的话，回车从原来的将选定项输入到input中变为了直接提交form表单了，这并不是我们想要的。

我的方法原理是，补充一个原插件触发查询的事件，就是当input输入栏发生字符变化时，重新进行查询（调用其内部的onChange函数），这里 主要针对firefox而言，因为我们的系统访问最多的是IE和firefox。而恰好firefox有一个input变化的事件就是oninput，那么我们只要在原jquery.autocomplete.js第199行（即$input.bind方法的末尾），插入如下代码：

.bind("input", function() { 
    onChange(0, true); 
})

来愈：

http://kb.cnblogs.com/a/2351152/