简单用法:
$(function(){ var data = "the People‘s Republic of China".split(" "); $("#autocomplete").autocomplete(data,{minChars:0}).result(function(event,data,formatted){ alert(data); }); }); </script> <input type="text" id="autocomplete"/>
-
更多参数说明:
-
第一个参数除了本地数据外,还可以是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;
-
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: {};
-
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: "[email protected]" }, { name: "Molly", to: "[email protected]" }, { name: "Forneria", to: "[email protected]" }, { name: "Master <em>Sync</em>", to: "[email protected]" }, { name: "Dr. <strong>Tech</strong> de Log", to: "[email protected]" }, { name: "Don Corleone", to: "[email protected]" }, { name: "Mc Chick", to: "[email protected]" }, { name: "Donnie Darko", to: "[email protected]" }, { name: "Quake The Net", to: "[email protected]" }, { name: "Dr. Write", to: "[email protected]" }, { name: "GG Bond", to: "[email protected]" }, { name: "Zhuzhu Xia", to: "[email protected]" } ]; $("#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>
一个稍微复杂点的例子: 远程数据源
效果:
<%@ 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 zdbq(id){ var url = encodeURI(‘/xx/xx.action‘); $("#"+id).autocomplete( url, { minChars: 0,//自动完成激活之前填入的最小字符 max:12,//列表条目数 width: 400,//提示的宽度 scrollHeight: 300,//提示的高度 matchContains: true,//是否只要包含文本框里的就可以 autoFill:false,//自动填充 matchContains: true, matchCase:true, parse: function(data) { var obj =eval("(" + data + ")"); //转换成js对象 return $.map(obj, function(row) { return { data: row, value: row.name, result: row.name }; });//给后台交互的数据进行处理 }, formatItem: function(data, i, max) {//格式化列表中的条目 row:条目对象,i:当前条目数,max:总条目数 return i + ‘/‘ + max + ‘:"‘ + data.name; }, formatMatch: function(data, i, max) {//配合formatItem使用,作用在于,由于使用了formatItem,所以条目中的内容有所改变,而我们要匹配的是原始的数据,所以用formatMatch做一个调整,使之匹配原始数据 return data.name; }, formatResult: function(data) {//定义最终返回的数据,比如我们还是要返回原始数据,而不是formatItem过的数据 return data.name; } }) } </script> </head> <body> <input type="text" id="autocomplete" onkeyup="zdbq(‘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/
时间: 2024-11-05 12:26:26