jquery提示插件autocomplete使用方法和官方下载地址 - webxzy

时间:2024-02-01 07:48:55

jquery提示插件autocomplete使用方法和官方下载地址

下载地址 https://github.com/lorecioni/autocomplete.js


1 HTML结构: 2 <input type="text" id="text" /> 3 4 例子: 5         $("#text").autocomplete( 这里写数组或URL, { 6 minChars: 1, // 最小输入一个字节 7 width: 310, //下拉列表宽度 310像素 8 max: 10, //最大10条数据 9 matchContains: true, 10 highlightItem: false, 11 cacheLength: 0, 12 extraParams: { 13 type: id //传给后台的数据 14 }, 15 parse: function (data) { //解析请求回来的数据 16 return $.map(data.content, function (row) { 17 return { 18 data: row, 19 value: row.name, 20 result: row.name 21 }; 22 }); 23 }, 24 formatItem: function (row, i, max) { // 设置需要显示的数据 25 return row.name; // 这里我只显示请求回来的名字这项 26 } 27 } 28 }).result(function (event, data, formatted) { // 这个是当选择某项时触发的回调函数 29 advertiserId = data.id; // 这里我把data里的id信息存储起来 30 31 }); 32 下面是具体的API: 33 语法: <br> 34 autocomplete(urlor data, [options] ) <br>
35 参数: <br> 36 url or data:数组或者url <br>
37 [options]:可选项,选项解释如下: <br> 38 1) minChars (Number) <br> 39 在触发autoComplete前用户至少需要输入的字符数,Default:1,如果设为0,在输入框内双击或者删除输入框内内容时显示列表。 <br>
40 2) width (Number) <br> 41 指定下拉框的宽度,Default: input元素的宽度 <br>
42 3) max (Number) <br> 43 autoComplete下拉显示项目的个数,Default: 10 <br>
44 4) delay (Number) <br> 45 击键后激活autoComplete的延迟时间(单位毫秒),Default: 远程为400 本地10 <br>
46 5) autoFill (Boolean) <br> 47 要不要在用户选择时自动将用户当前鼠标所在的&#20540;填入到input框,Default: false <br>
48 6) mustMatch (Booolean) <br> 49 如果设置为true,autoComplete只会允许匹配的结果出现在输入框,所有当用户输入的是非法字符时将会得不到下拉框,Default:false <br>
50 7) matchContains (Boolean) <br> 51 决定比较时是否要在字符串内部查看匹配,如ba是否与foo bar中的ba匹配.使用缓存时比较重要.不要和autofill混用.Default: false <br>
52 8) selectFirst (Boolean) <br> 53 如果设置成true,在用户键入tab或return键时autoComplete下拉列表的第一个&#20540;将被自动选择,尽管它没被手工选中(用键盘或鼠标).当然如果用户选中某个项目,那么就用用户选中的&#20540;. Default: true<br>
54 9) cacheLength (Number) <br> 55 缓存的长度.即对从数据库中取到的结果集要缓存多少条记录.设成1为不缓存.Default: 10 <br>
56 10) matchSubset (Boolean) <br> 57 autoComplete可不可以使用对服务器查询的缓存,如果缓存对foo的查询结果,那么如果用户输入foo就不需要再进行检索了,直接使用缓存.通常是打开这个选项以减轻服务器的负担以提高性能.只会在缓存长度大于1时有效.Default: true<br>
58 11) matchCase (Boolean) <br> 59 比较是否开启大小写敏感开关.使用缓存时比较重要.如果你理解上一个选项,这个也就不难理解,就好比foot要不要到FOO的缓存中去找.Default: false <br>
60 12) multiple (Boolean) <br> 61 是否允许输入多个&#20540;即多次使用autoComplete以输入多个&#20540;. Default:false <br>
62 13) multipleSeparator (String) <br> 63 如果是多选时,用来分开各个选择的字符. Default:&quot;,&quot; <br>
64 14) scroll (Boolean) <br> 65 当结果集大于默认高度时是否使用卷轴显示 Default: true <br>
66 15) scrollHeight (Number) <br> 67 自动完成提示的卷轴高度用像素大小表示 Default: 180 <br>
68 16) formatItem (Function) <br> 69 为每个要显示的项目使用高级标签.即对结果中的每一行都会调用这个函数,返回&#20540;将用LI元素包含显示在下拉列表中.Autocompleter会提供三个参数(row, i, max): 返回的结果数组, 当前处理的行数(即第几个项目,是从1开始的自然数), 当前结果数组元素的个数即项目的个数.Default: none, 表示不指定自定义的处理函数,这样下拉列表中的每一行只包含一个&#20540;.<br>
70 17) formatResult (Function) <br> 71 和formatItem类&#20284;,但可以将将要输入到input文本框内的&#20540;进行&#26684;式化.同样有三个参数,和formatItem一样.Default: none,表示要么是只有数据,要么是使用formatItem提供的&#20540;.<br>
72 18) formatMatch (Function) <br> 73 对每一行数据使用此函数&#26684;式化需要查询的数据&#26684;式. 返回&#20540;是给内部搜索算法使用的. 参数&#20540;row <br>
74 19) extraParams (Object) <br> 75 为后台(一般是服务端的脚本)提供更多的参数.和通常的作法一样是使用一个键&#20540;对对象.如果传过去的&#20540;是{ bar:4 },将会被autocompleter解析成my_autocomplete_backend.php?q=foo&amp;bar=4 (假设当前用户输入了foo). Default: {}<br>
76 20) result (handler) Returns:jQuery <br> 77 此事件会在用户选中某一项后触发,参数为: <br>
78 event: 事件对象. event.type为result. <br>
79 data: 选中的数据行. <br>
80 formatted:formatResult函数返回的&#20540; <br> 81 例如: <br> 82 $(&quot;#singleBirdRemote&quot;).result(function(event, data, formatted){ <br> 83 //如选择后给其他控件赋&#20540;,触发别的事件等等 <br> 84 })