这篇文章主要为大家详细介绍了jquery插件autocomplete使用方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
项目中有时会用到自动补全查询,就像google搜索框、淘宝商品搜索功能,输入汉字或字母,则以该汉字或字母开头的相关条目会显示出来供用户选择, autocomplete插件就是完成这样的功能。
autocomplete官网 : http://bassistance.de/jquery-plugins/jquery-plugin-autocomplete/ (可下载jquery autocomplete插件)。
淘宝商品搜索功能 效果:
下面来使用 autocomplete插件来实现类似效果。
1. 创建 ajaxpage.aspx 页面,在其中定义 webmethod 方法来返回 搜索页面需要的输入框所有提示条目。 后台代码如下:
using system.collections.generic;
using system.io;
using system.runtime.serialization.json;
using system.web.services;
public partial class ajaxpage : system.web.ui.page
{
[webmethod]
public static string getallhints()
{
dictionary<string, string> data = new dictionary<string, string>();
data.add("苹果4代iphone正品", "21782");
data.add("苹果4代 手机套", "238061");
data.add("苹果4", "838360");
data.add("苹果皮", "242721");
data.add("苹果笔记本", "63348");
data.add("苹果4s", "24030");
data.add("戴尔笔记本", "110105");
data.add("戴尔手机", "18870");
data.add("戴尔键盘", "30367");
datacontractjsonserializer serializer = new datacontractjsonserializer(data.gettype());
using (memorystream ms = new memorystream())
{
serializer.writeobject(ms, data);
return system.text.encoding.utf8.getstring(ms.toarray());
}
}
}
注:该方法返回的数据格式为json字符串。
2. 创建搜索页面 index.aspx, 前台代码如下:
<!doctype html public "-//w3c//dtd xhtml 1.0 transitional//en" "http://www.w3.org/tr/xhtml1/dtd/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
<title></title>
<link rel="stylesheet" href="styles/jquery.autocomplete.css" />
<script type="text/javascript" src="scripts/jquery-1.4.1.js"></script>
<script type="text/javascript" src="scripts/jquery.autocomplete.js"></script>
<script type="text/javascript">
var v = 1;
$(document).ready(function () {
$.ajax({
type: "post",
contenttype: "application/json",
url: "ajaxpage.aspx/getallhints",
data: "{}",
datatype: "json",
success: function (msg) {
var datas = eval('(' + msg.d + ')');
$("#txtiput").autocomplete(datas, {
formatitem: function (row, i, max) {
return "<table width='400px'><tr><td align='left'>" + row.key + "</td><td align='right'><font style='color: #009933; font-family: 黑体; font-style: italic'>约" + row.value + "个宝贝</font> </td></tr></table>";
},
formatmatch: function(row, i, max){
return row.key;
}
});
}
});
});
</script>
</head>
<body>
<form id="form1" runat="server">
<p>
<center>
<asp:textbox id="txtiput" runat="server" width="400px"></asp:textbox>
</center>
</p>
</form>
</body>
</html>
实现效果如下:
3. autocomplete 参数说明
* 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)
此事件会在用户选中某一项后触发,参数为:
event: 事件对象. event.type为result.
data: 选中的数据行.
formatted:formatresult函数返回的值
例如:
$("#singlebirdremote").result(function(event, data, formatted) {
//如选择后给其他控件赋值,触发别的事件等等
});
以上就是本文的全部内容,希望对大家的学习有所帮助