Jquery autocomplete插件简单用法:
var websites = [
"Google","NetEase", "Sohu", "Sina", "Sogou", "Baidu", "Tencent",
"Taobao", "Tom", "Yahoo", "JavaEye", "Csdn", "Alipay"
];
$().ready(function() {
$("#website").autocomplete(websites);
});
Web Site:
更多参数说明:
第一个参数除了本地数据外,还可以是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) {
//如选择后给其他控件赋值,触发别的事件等等
});
jQuery UI Autocomplete插件简单使用:
jQuery UI 1.8版本新增了2个非常有用的控件:一个是Button,其作用是自定义页面按钮的样式;另一个就是Autocomplete,其作用是使文本框具有类似百度、谷歌输入框那种自动填充的能力。
Autocomplete的函数原型如下:
$(selector).autocomplete({
source: [], //自动填充的备选数据,注1
position: {my: "left top", at: "left bottom"}, //下拉列表相对于文本框的位置,注2
minLength: 1, //自动填充被激活前需要输入的最小字符数,默认为1
delay: 300, //停止输入到自动填充被激活的延迟时间,默认为300
autoFocus: false, //是否自动聚焦于下拉列表第一项,默认为false
appendTo: "body", //自动填充的下拉列表放到哪个元素内部,注3
disabled: false, //是否禁用自动填充,默认为false
create: function(event, ui) {}, //自动填充被创建时被触发
search: function(event, ui) {}, //在达到最小输入字符数并且延迟时间结束之后,自动填充数据请求开始之前被触发
open: function(event, ui) {}, //下拉列表打开时被触发
focus: function(event, ui) {}, //下拉列表项被聚焦时触发,ui.item对应被聚焦的列表项
select: function(event, ui) {}, //下拉列表项被选择时触发,ui.item对应被选择的列表项
close: function(event, ui) {}, //下拉列表隐藏时被触发
change: function(event, ui) {} //文本域的值发生改变时被触发,ui.item对应新的被选择的列表项
});
其中,Autocomplete作用的元素一般是或者这些带输入框的标签。
注释:
注1,source是Autocomplete核心属性,表示自动填充时所需的备选数据集合,必填,其它的属性和事件都是非必需的。
source的可选值有三种类型:
一是Array型,可以是形如["Java", "JavaScript", "CSS", "jQuery", "PHP", "HTML"]的一元字符串数组,也可以是形如 {{label: "choice1", value: "value1"}, {label: "choice2", value: "value2"},…}的二元字符串数组。
二是String型,表示能返回形如上述两种数组格式的JSON数据的URL链接。
三是function型,其函数原型是function(request, response),其中:参数request表示数据请求,它只有唯一的属性term,request.term表示当前文本框中的输入值;参数response表示数据响应,它是一个已经定义好的回调函数,需要在本function的函数体中传入参数作为调用,response的参数必须是符合前述两种数组格式的数组数据。
注2, position表示的是下拉菜单相对于文本输入框的位置,其格式符合jQuery UI Position规则。通常来说只用到my和at两个索引,即形如{my: "left top", at: "left bottom"}。其中my表示下拉菜单,my: "lefttop"表示下拉菜单的左上角;at表示在输入框的什么位置,at: "left bottom"表示在输入框的左下角。
注3,appendTo表示数据响应时出现的下拉列表是被添加到哪个元素的内部,其值是满足jQuery选择器的字符串,如"#id"、".class"等。默认为"body",即元素的jQuery对象。不过通常这个元素无需设置,使用默认值即可。
另外,Autocomplete的7个可选事件的参数都是event和ui:event表示事件对象,与其它诸如click、select等事件中的event差别不大;ui表示的是下拉列表这种控件的DOM对象,ui.item表示列表项,ui.item.value表示列表项的值,基本只在focus、select、change事件中会被用到。
下面的代码结合Autocomplete和Ajax模拟了一个异步查询某编号的自动填充输入域:
$(function() {
$("#licenses").autocomplete({
minLength:1,
autoFocus:true,
source:function(request,response){
$.ajax({
type:"POST",
url:"AutoComplete.action",
dataType:"json",
data:{ keyLicense : $("#licenses").val() },
success:function(json){
response($.map(json.autoSuggests,function(item){
return {
label:item,
value:item
};
}));
}
});
},
delay: 600
});
});
其中Ajax的url:AutoComplete.action是在struts.xml文件中配置的。
Jquery autocomplete插件简单用法源码下载:http://download.csdn.net/detail/sunny0703/7690833
对于jQuery UI Autocomplete插件简单使用由于需要通过后台数据库返回数据,所以暂不提供源码下载。