jquery-autocomplete 使用手册

756514656

贡献于2012-08-14

字数:0 关键词: jQuery插件 手册

jquery-autocomplete 使用手册 jquery-autocomplete 学习 一、用前必备 官方网站:http://bassistance.de/jquery-plugins/jquery-plugin-autocomplete/ 当前版本:1.0.2 需要 JQuery 版本:1.2.6 二、使用 autocomplete( url or data, options ) Returns: jQuery 让一个 input 或 textarea 有 autocomplete 功能 例子 Js 代码 var data = "Core Selectors Attributes Traversing Manipulation CSS Events Effects Ajax Utilities".split(" "); $("#example").autocomplete(data); 以上的例子就是为 id 为 example 添加 autocomplete var emails = [ { name: "Peter Pan", to: "peter@pan.de" }, { name: "Molly", to: "molly@yahoo.com" }, { name: "Forneria Marconi", to: "live@japan.jp" }, { name: "Master Sync", to: "205bw@samsung.com" }, { name: "Dr. Tech de Log", to: "g15@logitech.com" }, { name: "Don Corleone", to: "don@vegas.com" }, { name: "Mc Chick", to: "info@donalds.org" }, { name: "Donnie Darko", to: "dd@timeshift.info" }, { name: "Quake The Net", to: "webmaster@quakenet.org" }, { name: "Dr. Write", to: "write@writable.com" } ]; //emails 的数组格式如上,formatItem 代表的是显示的格式,formatMatch 表示匹配的内容, formatResult 表示结果的内容 $("#suggest13").autocomplete(emails, { minChars: 0, width: 310, matchContains: true, autoFill: false, formatItem: function(row, i, max) { return i + "/" + max + ": \"" + row.name + "\" [" + row.to + "]"; }, formatMatch: function(row, i, max) { return row.name + " " + row.to; }, formatResult: function(row) { return row.to; } }); 三、参数说明: * 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) Returns: jQuery 此事件会在用户选中某一项后触发,参数为: event: 事件对象. event.type 为 result. data: 选中的数据行. formatted:formatResult 函数返回的值 例如: $("#singleBirdRemote").result(function(event, data, formatted) { //如选择后给其他控件赋值,触发别的事件等等 }); 四、注意问题: 1.网上有人说对中文的检索时处理有问题,经过测试此版本没有问题^-^ 2.在使用远程地址时,它默认传入的参数是:q(输入值),limit(返回结果的最大值),可以 使用 extraParams 传入其他的参数 3.autocomplete 在使用 ajax 传递参数时,默认使用了 get 方式传递,也实在是没有找到可以通 过参数提交 post 方式的办法。 解决方式 1:在使用 ajax 的 get 方式传递中文时,使用 new String(request.getParameter("q").getBytes("iso8859-1"),"utf-8")获得参数值 解决方式 2:修改 jquery.autocomplete.js 代码,把 get 方式修改为 post 方式,然后参见之前 ajax 解决中文乱码的问题的

下载文档,方便阅读与编辑

文档的实际排版效果,会与网站的显示效果略有不同!!

需要 5 金币 [ 分享文档获得金币 ] 1 人已下载

下载文档

相关文档