jQuery UI Autocomplete 体验

jQuery UI Autocomplete 体验

官网例子：
http://jqueryui.com/autocomplete/#default
jQuery UI Autocomplete是jQuery UI的自动完成组件，是我用过的最强大、最灵活的Autocomplete，它支持本地的Array/JSON数组、通过ajax请求的Array/JSON数组、JSONP、以及Function(最灵活)等方式来获取数据。

使用此插件需要引用两个js文件和一个css文件，分别如下：

<script src="./jquery-1.3.2.js"type="text/javascript"></script> <script src="./jquery.autocomplete.js" type="text/javascript"></script><link rel="stylesheet" href="./jquery.autocomplete.css" />

Arguments:

参数	类型	说明
url or data	String, Array	一个URL指向一个远程资源或作为数组本地数据。
options	选项（可选）	设置一个键/值对，自动完成配置。 所有的选项都是可选的。

Options

参数	类型	默认值	说明
autoFill	Boolean	false	是否在用户选择时自动将用户鼠标所在的值填充到input元素中，default:false
cacheLength	Number	10	缓存记录的条数，即从数据库中取得记录要缓存多少条，1为不缓存，defalut:10
delay	Number		击键后激活autoComplete的延迟时间(单位毫秒).Default: 远程为400 本地10
extraParams	Object		为服务器端后台提供更多的参数，参数的形式如下：{name:lixiao},在向后台传递参数时会自动在url后追加该参数?name=lixiao
formatItem	Function		对服务器返回的每一行数据都调用该函数来处理，返回值将用LI元素包含显示在下拉列表中，autocomplete会提供三个参数( row , I , m a x)其 中row表示服务器端返回回来的结果数组，i为当前的行数(正在处理第几行数据)，m a x为返回的记录总数(查询到的结果总数)，default:none，不指定则直接返回服务器的结果值
formatMatch	Function		对每一行数据使用此函数格式化需要查询的数据格式. 返回值是给内部搜索算法使用的. 参数值row
formatResult	Function		功能和formatItem基本类似，同样有三个参数作用相同，暂时没发现写该与不写该函数有什么区别
highlight	Boolean, Function
matchCase	Boolean	false	是否开启大小写敏感开关，在使用缓存时比较重要
matchContains	Boolean	false	决定比较时是否要在字符串内部查看匹配，如ba是否与foo bar中的ba匹配.使用缓存时比较重要.不要和autofill混用.Default: false
matchSubset	Boolean	true	是否对从服务器的查询结果使用缓存，比如：上次的搜索关键字为Java，则下次再次输入java进行查询时不用再次连接服务器查询，而是从缓存中取得上次查询的结果，这样做可以减少访问服务器的次数，提供性能。Default:true
max	Number	10	查询时下拉列表框中显示的条目数，defaultValue为10
minChars	Number	1	该参数指定在触发autocomplete之前用户在查询框中输入的最小字符数，通常设置为1，即文本框值不为空的时候执行autocomplete,如果取值为0，则在用户双击查询文本框或删除文本框内容时查询
multiple	Boolean	false	是否允许多值查询，如果为true,则查询到第一条结果后，再次输入查询条件则会后续的 查询 结 果 显 示出来
multipleSeparator	String	", "	只有在multiple属性设置为true时此属性才能生效，该属性用来控制在多条件查询时使用的分隔符，default:”,”
mustMatch	Boolean	false	参数boolean类型，true时，如果输入的查询条件无法匹配到合适的结果，则<input>元素中输入的查询值会自动清空，否则会保留。Default:false
scroll	Boolean	true	设置当结果集大于默认高度时是否使用滚动条显示,default:true
scrollHeight	Number	180	查询结果框的显示高度，当超过该高度时会使用scroll
selectFirst	Boolean	true	参数为true时，则用户按下tab键或者return键时会自动将查询结果的第一条记录选中到input元素中
width	Number		该参数的用途是指定下拉框的宽度，通常不用设置，默认的值为和<input>元素相同
result(handler) Returns:jQuery			此事件会在用户选中某一项后触发，参数为： event: 事件对象. event.type为result. data: 选中的数据行. formatted:formatResult函数返回的值 例如： $("#singleBirdRemote").result(function(event, data, formatted){ //如选择后给其他控件赋值，触发别的事件等等 });

支持的数据源

jQuery UI Autocomplete主要支持字符串Array、JSON两种数据格式。

普通的Array格式没有什么特殊的，如下：

对于JSON格式的Array，则要求有：label、value属性，如下：

其中label属性用于显示在autocomplete弹出菜单，而value属性则是选中后给文本框赋的值。

如果没有指定其中一个属性则用另一个属性替代(即value和label值一样)，如下：

如果label和value都没有指定，则无法用于autocomplete的提示。

另外需要注意，对于从服务器端输出的JSON的key必须用双引号，如下：

否则可能会出现parsererror错误。

主要的参数

jQuery UI Autocomplete常用的参数有：

Source：用于指定数据来源，类型为String、Array、Function

String：用于ajax请求的服务器端地址，返回Array/JSON格式
Array：即字符串数组 或 JSON数组
Function(request, response)：通过request.term获得输入的值，response([Array])来呈现数据；(JSONP是这种方式)

minLength：当输入框内字符串长度达到minLength时，激活Autocomplete
autoFocus：当Autocomplete选择菜单弹出时，自动选中第一个
delay：即延迟多少毫秒激活Autocomplete

其他不常用的就不罗列了。

使用方法

假如页面上有以下输入框：

<input type="text" id="autocomp" />

AJAX请求

通过指定source为服务器端的地址来实现，如下：

然后在服务器端接收，并输出相应结果，注意默认传递的参数名称为term：

public void ProcessRequest(HttpContext context)
{
// 查询的参数名称默认为term
string query = context.Request.QueryString["term"];
context.Response.ContentType = "text/javascript";
//输出字符串数组 或者 JSON 数组
context.Response.Write("[{\"label\":\"博客园\",\"value\":\"cnblogs\"},{\"label\":\"囧月\",\"value\":\"囧月\"}]");
}

本地Array/JSON数组

Callback Function方式

通过指定source为自定义函数来实现自定义数据的获取，函数主要有2个参数(request,response)，分别用于获取输入的值、呈现结果

本地Array方式获取数据（模仿新浪微博的登录）

JSONP方式获取数据

直接从官方DEMO拿来的，通过发送ajax请求到远程服务器，然后对返回结果进行处理，最后通过response来呈现：

主要的事件

jQuery UI Autocomplete有一些事件，可用于在一些阶段进行额外的控制：

create(event, ui)：Autocomplete创建时，可以在此事件中，对外观进行一些控制
search(event, ui)： 在开始请求之前，可以在此事件中返回false来取消请求
open(event, ui)：Autocomplete的结果列表弹出时
focus(event, ui)：Autocomplete的结果列表任意一项获得焦点时，ui.item为获得焦点的项
select(event, ui)：Autocomplete的结果列表任意一项选中时，ui.item为选中的项
close(event, ui)：Autocomplete的结果列表关闭时
change(event, ui)：当值改变时，ui.item为选中的项

这些事件的ui参数的item属性（如果有的话）默认有label和value属性，不管在source中设置的数据是Array还是JSON数组，如下3种：

假如是第三种的话，还可以得到ui.item.id的值。

这些事件可以通过2种方式来绑定，如下：

通过bind来绑定的方式使用的事件名称为"autocomplete"+事件名称，如"select"就是"autocompleteselect"。

多个值的Autocomplete

一般情况下，输入框的autocomplete仅需要一个值就可以(如：javascript)；假如需要多个值(如：javascript,c#,asp.net)，则需要绑定一些事件来进行额外处理：

在focus事件中返回false，避免输入框的值被autocomplete的单个值取代
在select事件中组合多个值
在元素的keydown事件做一些处理，理由同1
使用callback function方式的source，来获取最后输入的值，并呈现结果

还是直接拿官方DEMO的代码：

结尾

最后，放上代码：点击下载。

更多的资料请看jQuery UI Autocomplete官方演示：http://jqueryui.com/demos/autocomplete