autocomplete初步使用

时间:2024-10-01 13:06:02

  之前使用过autocomplete自动补全,只是简单的传入input框中要补全的数组,类似于

 $('#id').autocomplete('[数组形式的补全数据]',{minChars: 0});

  只是知道他是JQueryUI的一个插件,但是autocomplete有那些参数,都有什么作用并不知道,直到昨天客户要求一个输入框可以输入两种查询条件,都带出一种结果,无奈只能问度娘要API。

  查看文档之后决定使用formatItem,formatReult和result实现,${productMaterialNum}是JSONArray[JSONObject]格式,JSONObject中要有materialNum和standard两个属性代码如下:

  

 $("#preview_productdrawing").autocomplete(${productMaterialNum}, {
    matchContains: true,
    minChars: 0,
    formatItem : function(material) {//下拉列表里面显示的信息
      return material.materialNum;
    },
    formatResult : function(material) {
      return material.materialNum;//选择之后,input中填充的字段
    }
  }).result(function(event, material, formatted) {
    $("#preview_productdrawing").val(formatted);
  });

  但是之后在input框输入条件并不能带出结果,于是添加formatMatch参数,代码如下:

 $("#preview_productdrawing").autocomplete(${productMaterialNum}, {
  matchContains: true,
  minChars: 0,
4   formatItem : function(material) {//下拉列表里面显示的信息
5     return material.materialNum;
6   },
formatMatch : function(material) {
  return material.materialNum + material.standard;//匹配的字段
},
formatResult : function(material) {
11     return material.materialNum;//选择之后,input中填充的字段
}
13 }).result(function(event, material, formatted) {
  $("#preview_productdrawing").val(formatted);
15 });

实现效果:

autocomplete初步使用

附autocomplete参数说名(来自www.jb51.net/article/104586.htm):

* 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函数返回的值