当前位置: 代码迷 >> Web前端 >> jQuery Autocomplete 运用详细说明
  详细解决方案

jQuery Autocomplete 运用详细说明

热度:794   发布时间:2012-10-30 16:13:35.0
jQuery Autocomplete 使用详细说明

jQuery.Autocomplete?是jquery的流行插件,能够很好的实现输入框的自动完成(autocomplete)、建议提示(input suggest)功能,支持ajax数据加载。

官方网站http://bassistance.de/jquery-plugins/jquery-plugin-autocomplete/

一、调用本地数据

最简单的Autocomplete(自动完成)代码

<script type="text/javascript">
var websites = [
	"Google","NetEase", "Sohu", "Sina", "Sogou", "Baidu", "Tencent",
	"Taobao", "Tom", "Yahoo", "JavaEye", "Csdn", "Alipay"
];
$().ready(function() {
	$("#website").autocomplete(websites);
});
</script>
<p>
<label>Web Site:</label>
<input type="text" id="website" />
<input type="button" id="getvalue" value="Get Value" />
</p>
<div id="content"></div>

这么几行代码就完成了自动完成功能,真实太强了,不过bassistance.de的jQuery Autocomplete插件还有更丰富的功能,它的文档在http://docs.jquery.com/Plugins/Autocomplete,在API Documentation里,我们要仔细的研究一下autocomplete( url or data, [options] )方法。

autocomplete方法有两个参数,第一个用来填写URL地址或是数据,jQuery Autocomplete插件是支持Ajax方式调用数据,所以可以填写调用的地址,另外可以直接填写数据,格式为JavaScript数组,如我们的例子,autocomplete的另外一个参数 [options]是一个可选项,我们在例子中就没有写,但这个参数里面却有很多可配置的参数,我们还是先修改上面的例子

$().ready(function() {
	$("#website").autocomplete(websites,{
		minChars: 0,
		max: 5,
		autoFill: true,
		mustMatch: true,
		matchContains: true,
		scrollHeight: 220,
		formatItem: function(data, i, total) {
			return "<I>"+data[0]+"</I>";
		},
		formatMatch: function(data, i, total) {
			return data[0];
		},
		formatResult: function(data) {
			return data[0];
		}
	});
});

在options项我们增加了好几个参数

minChars表示在自动完成激活之前填入的最小字符,这里我们设置为0,在我们双击文本框,不输入字符的时候,就会把数据显示出来,效果如下

max表示列表里的条目数,我们设置了5,所以显示5条,也如上图

autoFill表示自动填充,就是在文本框中自动填充符合条件的项目,看下图,在我们输入“g”的时候,文本框里填充了“google”

mustMatch表示必须匹配条目,也就是在文本框里输入的内容,必须是data参数里的数据,如果不匹配,文本框就被清空

matchContains表示包含匹配,就是data参数里的数据,是否只要包含文本框里的数据就显示,比如在上面的图中,我们输入了“g”,由于“Sogou”中也包含一个“g”,所以会显示出来,如果将matchContains设为fasle,则“Sogou”就不会显示

scrollHeight不用多解释,看文档就知道。

后面3个参数formatItem、formatMatch、formatResult非常有用,formatItem作用在于可以格式化列表中的条目,比如我们加了“I”,让列表里的字显示出了斜体,formatMatch是配合formatItem使用,作用在于,由于使用了formatItem,所以条目中的内容有所改变,而我们要匹配的是原始的数据,所以用formatMatch做一个调整,使之匹配原始数据,formatResult是定义最终返回的数据,比如我们还是要返回原始数据,而不是formatItem过的数据。

[options]里还有很多有用的参数,大家可以看它的文档。

二、调用服务器端json数据

php生成服务器端json数据,echo json_encode($array)。

<script language="JavaScript" type="text/javascript">
??? function initAutoComplete(json){
??????? $("#tel").autocomplete(json , {
??????????? minChars:1,
??????????? width:260,
??????????? dataType:"json",
??????????? matchContains: true,
??????????? formatItem: function(row, i, max) {
???????????????? return row.tel + " <" + row.name + "> ["+row.cg_name+"]";
??????????? },
??????????? formatMatch: function(row, i, max) {
???????????????? return row.tel;
??????????? },
??????????? formatResult: function(row) {
???????????????? return row.tel;
??????????? }
??????? });
??? }
? $(document).ready(function(){
??????? $("#tel").focus(function(){
??????????? $.post(url,{},function(data){
??????????????? initAutoComplete(data);
??????????? },"json");
??????? });
? });
</script>

三、参数说明:

* minChars (Number):

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

* width (Number):

????指定下拉框的宽度. Default: input元素的宽度

* max (Number):

????autoComplete下拉显示项目的个数.Default: 10

* delay (Number):

????击键后激活autoComplete的延迟时间(单位毫秒).Default: 远程为400 本地10

* autoFill (Boolean):

????要不要在用户选择时自动将用户当前鼠标所在的值填入到input框. Default: false

* mustMatch (Booolean):

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

* formatResult (Function):

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

* formatMatch (Function):

????对每一行数据使用此函数格式化需要查询的数据格式. 返回值是给内部搜索算法使用的. 参数值row

* 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) {

//如选择后给其他控件赋值,触发别的事件等等

});

?

?

?

?

?

?

?

另外一小段代码:

$('#keyword').autocomplete(../servlet {?
??max: 12, //列表里的条目数?
??minChars: 0, //自动完成激活之前填入的最小字符?
??width: 400, //提示的宽度,溢出隐藏?
??scrollHeight: 300, //提示的高度,溢出显示滚动条?
??matchContains: true, //包含匹配,就是data参数里的数据,是否只要包含文本框里的数据就显示?
??autoFill: false, //自动填充?
??extraParams: {????
??????????? sname: function(){return $("#sName").val();},
? ??idcard: function(){return $("#idCard").val();}?
??????? },
?????????? parse : function(data) {???
??????????? return $.map(eval(data), function(row) {???
??????????????????????? return {???
??????????????????????????? data : row,???
??????????????????????????? value : row.name,???
??????????????????????????? result : row.name???
??????????????????????? }???
??????????????????? });???
??????? },??

??????? formatItem: function(row, i, max) {??????
??????????? return "发件人:"+row.name+", 收件人:"+row.to;???//下拉列表格式???
????????? },??????
????????? formatMatch: function(row, i, max) {??????
??????????? return row.name+row.to;??????//与这些相匹配
????????? },??????
????????? formatResult: function(row) {??????
??????????? return row.name;?????//最终得到的结果
????????? }??????
?}).result(function(event,row,formatted){
??$("#idCard").val(row.card);//通过result函数可进对数据进行其他操作
?});

?

  相关解决方案