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 相关文章推荐
js类中的公有变量和私有变量
Jul 24 Javascript
ExtJS Store的数据访问与更新问题
Apr 28 Javascript
jQuery EasyUI API 中文文档 - ComboTree组合树
Oct 11 Javascript
五段实用的js高级技巧
Dec 20 Javascript
jQuery中setTimeout的几种使用方法小结
Apr 07 Javascript
jquery手风琴特效插件
Feb 04 Javascript
适用于javascript开发者的Processing.js入门教程
Feb 24 Javascript
jQuery操作动态生成的内容的方法
May 28 Javascript
基于javascript的Form表单验证
Dec 29 Javascript
微信小程序实现的日期午别医生排班表功能示例
Jan 09 Javascript
JS如何定义用字符串拼接的变量
Jul 11 Javascript
分享一个vue实现的记事本功能案例
Apr 11 Vue.js
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
PHP异常处理浅析
2015/05/12 PHP
php时间计算相关问题小结
2016/05/09 PHP
php多文件打包下载的实例代码
2017/07/12 PHP
使用 laravel sms 构建短信验证码发送校验功能
2017/11/06 PHP
PHP实现双链表删除与插入节点的方法示例
2017/11/11 PHP
如何实现动态删除javascript函数
2007/05/27 Javascript
Jquery中dialog属性小记
2010/09/03 Javascript
各浏览器中querySelector和querySelectorAll的实现差异分析
2012/05/23 Javascript
javascipt:filter过滤介绍及使用
2014/09/10 Javascript
javascript几个易错点记录
2014/11/26 Javascript
jQuery超酷平面式时钟效果代码分享
2020/03/30 Javascript
Angularjs 制作购物车功能实例代码
2016/09/14 Javascript
微信小程序 MD5加密登录密码详解及实例代码
2017/01/12 Javascript
react-router实现跳转传值的方法示例
2017/05/27 Javascript
详解nodejs实现本地上传图片并预览功能(express4.0+)
2017/06/28 NodeJs
浅谈React高阶组件
2018/03/28 Javascript
详解微信小程序实现仿微信聊天界面(各种细节处理)
2019/02/17 Javascript
微信小程序激励式视频广告组件使用详解
2019/12/06 Javascript
[01:28:24]NAVI vs VG Supermajor 败者组 BO3 第三场 6.5
2018/06/06 DOTA
[07:06]2018DOTA2国际邀请赛寻真——卫冕冠军Team Liquid
2018/08/10 DOTA
python编写暴力破解FTP密码小工具
2014/11/19 Python
使用apidoc管理RESTful风格Flask项目接口文档方法
2018/02/07 Python
Python pygorithm模块用法示例【常见算法测试】
2018/08/16 Python
解决Mac下首次安装pycharm无project interpreter的问题
2018/10/29 Python
python同步windows和linux文件
2019/08/29 Python
python微信公众号开发简单流程实现
2020/03/09 Python
Pandas缺失值2种处理方式代码实例
2020/06/13 Python
美国紧身牛仔裤品牌:NYDJ
2017/05/24 全球购物
大一自我鉴定范文
2013/12/27 职场文书
楼面部长岗位职责范本
2014/02/14 职场文书
让生命充满爱演讲稿
2014/05/10 职场文书
幼儿园感恩节活动方案
2014/10/06 职场文书
负责培养人意见
2015/06/05 职场文书
LayUI+Shiro实现动态菜单并记住菜单收展的示例
2021/05/06 Javascript
JavaScript如何优化逻辑判断代码详解
2021/06/08 Javascript
浅析python中特殊文件和特殊函数
2022/02/24 Python