jQuery插件autocomplete使用详解


Posted in Javascript onFebruary 04, 2017

项目中有时会用到自动补全查询,就像Google搜索框、淘宝商品搜索功能,输入汉字或字母,则以该汉字或字母开头的相关条目会显示出来供用户选择, autocomplete插件就是完成这样的功能。

autocomplete官网 : http://bassistance.de/jquery-plugins/jquery-plugin-autocomplete/ (可下载jQuery 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">
  <div>
  <center>
   <asp:TextBox ID="txtIput" runat="server" Width="400px"></asp:TextBox>
  </center>
  </div>
  </form>
 </body>
</html>

实现效果如下:

jQuery插件autocomplete使用详解

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) {
  //如选择后给其他控件赋值,触发别的事件等等
 });

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
javascript 写类方式之八
Jul 05 Javascript
javascript获得CheckBoxList选中的数量
Oct 27 Javascript
基于jquery实现后台左侧菜单点击上下滑动显示
Apr 11 Javascript
jquery操作select方法汇总
Feb 05 Javascript
jQuery实现弹出带遮罩层的居中浮动窗口效果
Sep 12 Javascript
JS获取年月日时分秒的方法分析
Nov 28 Javascript
基于bootstrap的文件上传控件bootstrap fileinput
Dec 23 Javascript
React.js绑定this的5种方法(小结)
Jun 05 Javascript
用原生JS实现爱奇艺首页导航栏代码实例
Sep 19 Javascript
vue使用swiper实现中间大两边小的轮播图效果
Nov 24 Javascript
Vue.js使用axios动态获取response里的data数据操作
Sep 08 Javascript
不依任何赖第三方,单纯用vue实现Tree 树形控件的案例
Sep 21 Javascript
d3.js中冷门却实用的内置函数总结
Feb 04 #Javascript
原生js开发的日历插件
Feb 04 #Javascript
JS Select下拉框(支持输入模糊查询)
Feb 04 #Javascript
原生js实现打字动画游戏
Feb 04 #Javascript
js实现自定义路由
Feb 04 #Javascript
jQuery窗口拖动功能的实现代码
Feb 04 #Javascript
简单易懂的天气插件(代码分享)
Feb 04 #Javascript
You might like
CentOS 6.2使用yum安装LAMP以及phpMyadmin详解
2013/06/17 PHP
PHP file_get_contents设置超时处理方法
2013/09/30 PHP
php curl 获取https请求的2种方法
2015/04/27 PHP
php实现修改新闻时删除图片的方法
2015/05/12 PHP
php生成二维码
2015/08/10 PHP
php实现带读写分离功能的MySQL类完整实例
2016/07/28 PHP
JavaScript面象对象设计
2008/04/28 Javascript
js 对小数加法精度处理示例说明
2013/12/27 Javascript
js中opener与parent的区别详细解析
2014/01/14 Javascript
JQuery设置获取下拉菜单某个选项的值(比较全)
2014/08/05 Javascript
jquery实现的缩略图预览滑块实例
2015/06/25 Javascript
javascript实现秒表计时器的制作方法
2017/02/16 Javascript
easyui-edatagrid.js实现回车键结束编辑功能的实例
2017/04/12 Javascript
详解从angular-cli:1.0.0-beta.28.3升级到@angular/cli:1.0.0
2017/05/22 Javascript
javascript数组定义的几种方法
2017/10/06 Javascript
vue用Object.defineProperty手写一个简单的双向绑定的示例
2018/07/09 Javascript
微信小程序实现笑脸评分功能
2018/11/03 Javascript
基于postman获取动态数据过程详解
2020/09/08 Javascript
[01:06:39]DOTA2上海特级锦标赛主赛事日 - 1 胜者组第一轮#1Liquid VS Alliance第三局
2016/03/02 DOTA
Python中for循环控制语句用法实例
2015/06/02 Python
python 3利用BeautifulSoup抓取div标签的方法示例
2017/05/28 Python
Django实现分页功能
2018/07/02 Python
Django中使用 Closure Table 储存无限分级数据
2019/06/06 Python
Python3离线安装Requests模块问题
2019/10/13 Python
Python类的动态绑定实现原理
2020/03/21 Python
浅谈keras使用中val_acc和acc值不同步的思考
2020/06/18 Python
python+flask编写一个简单的登录接口
2020/11/13 Python
一款纯css3实现的动画加载导航
2014/10/08 HTML / CSS
汇科协同Java笔试题
2012/03/31 面试题
化工专业应届生求职信
2013/11/08 职场文书
化学教学随笔感言
2014/02/19 职场文书
软件测试专业推荐信
2014/09/18 职场文书
判缓刑人员个人思想汇报
2014/10/10 职场文书
公司离职证明标准格式
2014/11/18 职场文书
2014年城管工作总结
2014/11/20 职场文书
四年级数学上册教学计划
2015/01/20 职场文书